--- loncom/interface/lonsearchcat.pm 2001/03/15 18:43:30 1.18 +++ loncom/interface/lonsearchcat.pm 2003/01/06 13:54:25 1.162 @@ -1,129 +1,600 @@ -# The LearningOnline Network +# The LearningOnline Network with CAPA # Search Catalog # -# 03/08/2001 Scott Harrison +# $Id: lonsearchcat.pm,v 1.162 2003/01/06 13:54:25 www Exp $ # +# Copyright Michigan State University Board of Trustees +# +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). +# +# LON-CAPA is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# LON-CAPA is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with LON-CAPA; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ +# +############################################################################### +############################################################################### + +=pod + +=head1 NAME + +lonsearchcat - LONCAPA Search Interface + +=head1 SYNOPSIS + +Search interface to LON-CAPAs digital library + +=head1 DESCRIPTION + +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. + +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. + +=head1 Internals + +=over 4 + +=cut + +############################################################################### +############################################################################### + +############################################################################### +## ## +## 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::File(); use CGI qw(:standard); +use Text::Query; +use DBI; +use GDBM_File; +use Apache::loncommon(); +use Apache::lonmysql(); + +# ---------------------------------------- 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 + +###################################################################### +###################################################################### + +# -- 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; + +###################################################################### +###################################################################### -my %language; -my $scrout; -my %metadatafields; -my %cprtag; -my %mimetag; +=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 + +###################################################################### +###################################################################### sub handler { my $r = shift; + # -# -------------------------------------- see if called from an interactive mode - 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'})); + 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'); $r->send_http_header; return OK if $r->header_only; - - %metadatafields=(); - - my $hidden=''; - $hidden=< + ## + ## 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', + 'cleargroupsort']); + ## + ## 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(3); + 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"; + # + # 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.launch'} eq '1')) { + $ENV{'form.persistent_db_id'} = time; + } + $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1); + 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'; + ## + 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"); + $r->print(< +LON-CAPA Search Error +$bodytag +We were unable to retrieve data describing your search. This is a serious +error and has been logged. Please alert your LON-CAPA administrator. + + END - -# ------------------------------------------------ First, check out environment - $metadatafields{'owner'}=$ENV{'user.name'}.'@'.$ENV{'user.domain'}; - -# --------------------------------- Compute various listings of metadata values - - %language=(); - $language{'any'}='Any language'; - { - my $fh=Apache::File->new($r->dir_config('lonTabDir').'/language.tab'); - map { - $_=~/(\w+)\s+([\w\s\-]+)/; - $language{$1}=$2; - } <$fh>; + return OK; + } } - - %cprtag=(); - $cprtag{'any'}='Any copyright/distribution'; - { - my $fh=Apache::File->new($r->dir_config('lonIncludes').'/copyright.tab'); - map { - $_=~/(\w+)\s+([\w\s\-]+)/; - $cprtag{$1}=$2; - } <$fh>; + ## + ## Clear out old values from groupsearch database + ## + untie %groupsearch_db if (tied(%groupsearch_db)); + if (($ENV{'form.cleargroupsort'} eq '1') || + (($ENV{'form.launch'} eq '1') && + ($ENV{'form.catalogmode'} eq 'groupsearch'))) { + if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) { + &start_fresh_session(); + untie %groupsearch_db; + delete($ENV{'form.cleargroupsort'}); + } else { + # This is a stupid error to give to the user. + # It really tells them nothing. + $r->print(''.$bodytag. + 'Unable to tie hash to db file'); + return OK; + } } - - %mimetag=(); - $mimetag{'any'}='Any type'; - { - my $fh=Apache::File->new($r->dir_config('lonTabDir').'/filetypes.tab'); - map { - $_=~/(\w+)\s+(\w+)\s+([\w\s\-]+)/; - $mimetag{$1}=".$1 $3"; - } <$fh>; + ## + ## Configure hidden fields + ## + $hidden_fields = ''."\n"; + if (exists($ENV{'form.catalogmode'})) { + $hidden_fields .= ''."\n"; } - - if ($ENV{'form.basicsubmit'} eq 'SEARCH') { - return &basicsearch($r,$ENV{'form.basicexp'}); + if (exists($ENV{'form.form'})) { + $hidden_fields .= ''."\n"; + } + if (exists($ENV{'form.element'})) { + $hidden_fields .= ''."\n"; + } + if (exists($ENV{'form.mode'})) { + $hidden_fields .= ''."\n"; + } + ## + ## Configure dynamic components of interface + ## + if ($ENV{'form.catalogmode'} eq 'interactive') { + $closebutton=" +END + } else { + $closebutton = ''; + $importbutton = ''; + } + ## + ## Sanity checks on form elements + ## + if (!defined($ENV{'form.viewselect'})) { + if (($ENV{'form.catalogmode'} eq 'groupsearch') || + ($ENV{'form.catalogmode'} eq 'interactive')) { + $ENV{'form.viewselect'} ="Compact View"; + } else { + $ENV{'form.viewselect'} ="Detailed Citation View"; + } } - elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') { - return &advancedsearch($r,\%ENV); + $ENV{'form.phase'} = 'disp_basic' if (! exists($ENV{'form.phase'})); + $ENV{'form.show'} = 20 if (! exists($ENV{'form.show'})); + ## + ## 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'} =~ /^(sort|run_search)$/) { + my ($query,$customquery,$customshow,$libraries,$pretty_string) = + &get_persistent_data($persistent_db_file, + ['query','customquery','customshow', + 'libraries','pretty_string']); + 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); + } + } 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())) { + $r->print(<Search Error +$bodytag +Unable to create table in which to store search results. +The search has been aborted. + + +END + return OK; + } + delete($ENV{'form.launch'}); + if (! &make_form_data_persistent($r,$persistent_db_file)) { + $r->print(<Search Error +$bodytag +Unable to properly store search information. The search has been aborted. + + +END + return OK; + } + # + # We are running a search + 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); + } else { # Advanced search + ($query,$customquery,$customshow,$libraries,$pretty_string) + = &parse_advanced_search($r,$closebutton); + return OK if (! defined($query)); + } + &make_persistent({ query => $query, + customquery => $customquery, + customshow => $customshow, + libraries => $libraries, + pretty_string => $pretty_string }, + $persistent_db_file); + ## + ## Print out the frames interface + ## + &print_frames_interface($r); } + return OK; +} - $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'}); +=pod - $scrout.=&searchphrasefield('Limit by subject','subject', - $ENV{'form.subject'}); +=item &print_basic_search_form() - $scrout.=&searchphrasefield('Limit by keywords','keywords', - $ENV{'form.keywords'}); +Returns a scalar which holds html for the basic search form. - $scrout.=&searchphrasefield('Limit by URL','url', - $ENV{'form.url'}); +=cut - $scrout.=&searchphrasefield('Limit by version','version', - $ENV{'form.version'}); +###################################################################### +###################################################################### - $scrout.=&searchphrasefield('Limit by notes','notes', - $ENV{'form.notes'}); +sub print_basic_search_form{ + my ($r,$closebutton) = @_; + my $bodytag=&Apache::loncommon::bodytag('Catalog Search'); + my $scrout=<<"ENDDOCUMENT"; + + +The LearningOnline Network with CAPA + + +$bodytag +
+ +$hidden_fields +

+Enter terms or phrases separated by AND, OR, or NOT +then press SEARCH below. +

+

+ + + +
+ENDDOCUMENT + $scrout.=' '.&simpletextfield('basicexp',$ENV{'form.basicexp'},40). + ' '; + my $checkbox = &simplecheckbox('related',$ENV{'form.related'}); + $scrout.=<Advanced Search
$checkbox use related words
+

+

+   +$closebutton +END + $scrout.=&selectbox(undef,'viewselect', + $ENV{'form.viewselect'}, + undef,undef,undef, + sort(keys(%Views))); + $scrout.=&selectbox(undef,'show', + $ENV{'form.show'}, + undef,undef,undef, + (10,20,50,100)); + $scrout.=< + + + +ENDDOCUMENT + $r->print($scrout); + return; +} +###################################################################### +###################################################################### - $scrout.=&searchphrasefield('Limit by abstract','abstract', - $ENV{'form.abstract'}); +=pod - $ENV{'form.mime'}='notxxx' unless length($ENV{'form.mime'}); - $scrout.=&selectbox('Limit by MIME type','mime', - $ENV{'form.mime'},%mimetag); +=item &advanced_search_form() - $ENV{'form.language'}='any' unless length($ENV{'form.language'}); +Returns a scalar which holds html for the advanced search form. - $scrout.=&selectbox('Limit by language','language', - $ENV{'form.language'},%language); - +=cut + +###################################################################### +###################################################################### +sub print_advanced_search_form{ + my ($r,$closebutton) = @_; + my $advanced_buttons = <<"END"; +

+ + +$closebutton + +

+END + if (!defined($ENV{'form.viewselect'})) { + $ENV{'form.viewselect'} ="Detailed Citation View"; + } + my $bodytag=&Apache::loncommon::bodytag('Advanced Catalog Search'); + my $scrout=<<"ENDHEADER"; + + +The LearningOnline Network with CAPA + + +$bodytag +Enter terms or phrases separated by search operators +such as AND, OR, or NOT.
+
+$advanced_buttons +$hidden_fields + + + +\n"; + $scrout.=&searchphrasefield_with_related('title', 'title' , + $ENV{'form.title'}); + $scrout.=&searchphrasefield('author', 'author' ,$ENV{'form.author'}); + $scrout.=&searchphrasefield_with_related('subject', 'subject' , + $ENV{'form.subject'}); + $scrout.=&searchphrasefield_with_related('keywords','keywords', + $ENV{'form.keywords'}); + $scrout.=&searchphrasefield('URL', 'url' ,$ENV{'form.url'}); + $scrout.=&searchphrasefield_with_related('notes', 'notes' , + $ENV{'form.notes'}); + $scrout.=&searchphrasefield_with_related('abstract','abstract', + $ENV{'form.abstract'}); + # Hack - an empty table row. + $scrout.="\n"; + $scrout.=&searchphrasefield('file
extension','extension', + $ENV{'form.extension'}); + $scrout.="\n"; + $scrout.=&searchphrasefield('publisher
owner','owner', + $ENV{'form.owner'}); + $scrout.="
VIEW: +ENDHEADER + $scrout.=&selectbox(undef,'viewselect', + $ENV{'form.viewselect'}, + undef,undef,undef, + sort(keys(%Views))); + $scrout.=' '; + $scrout.=&selectbox(undef,'show', + $ENV{'form.show'}, + undef,undef,undef, + (10,20,50,100)); + $scrout.=' '. + 'Per Page'; + $scrout.="Related
Words
   
   
\n"; + $ENV{'form.category'}='any' if (! defined($ENV{'form.category'})); + $scrout.=&selectbox('File Category','category', + $ENV{'form.category'}, + 'any','Any category', + undef, + (&Apache::loncommon::filecategories())); + $ENV{'form.language'}='any' unless length($ENV{'form.language'}); + #---------------------------------------------------------------- + # Allow restriction to multiple domains. + # I make the crazy assumption that there will never be a domain 'any'. + # + $ENV{'form.domains'} = 'any' if (! exists($ENV{'form.domains'})); + my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}} + : ($ENV{'form.domains'}) ); + my %domain_hash = (); + foreach (@allowed_domains) { + $domain_hash{$_}++; + } + my @domains =&Apache::loncommon::get_domains(); + # adjust the size of the select box + my $size = 4; + my $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size); + $scrout.="\n".''. + 'DOMAINS
'. + '\n"; + #---------------------------------------------------------------- + $scrout.=&selectbox('Limit by language','language', + $ENV{'form.language'},'any','Any Language', + \&{Apache::loncommon::languagedescription}, + (&Apache::loncommon::languageids), + ); # ------------------------------------------------ Compute date selection boxes $scrout.=< LIMIT BY CREATION DATE RANGE: -
+
between: CREATIONDATESTART $scrout.=&dateboxes('creationdatestart',1,1,1976, @@ -131,21 +602,18 @@ CREATIONDATESTART $ENV{'form.creationdatestart_day'}, $ENV{'form.creationdatestart_year'}, ); - $scrout.=< LIMIT BY LAST REVISION DATE RANGE: -
between: +
between: LASTREVISIONDATESTART $scrout.=&dateboxes('lastrevisiondatestart',1,1,1976, $ENV{'form.lastrevisiondatestart_month'}, @@ -161,408 +629,2348 @@ LASTREVISIONDATEEND $ENV{'form.lastrevisiondateend_year'}, ); $scrout.='

'; - - $scrout.=&searchphrasefield('Limit by publisher/owner','owner', - $ENV{'form.owner'}); -# $metadatafields{'owner'}); - $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'}); $scrout.=&selectbox('Limit by copyright/distribution','copyright', - $ENV{'form.copyright'},%cprtag); - + $ENV{'form.copyright'}, + 'any','Any copyright/distribution', + \&{Apache::loncommon::copyrightdescription}, + (&Apache::loncommon::copyrightids), + ); # ------------------------------------------- Compute customized metadata field - $scrout.=< -LIMIT BY OTHER METADATA FIELDS: - -For author-specific metadata, enter in an expression in the form of -key=value separated by operators such as AND or OR.
-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'; - -# ---------------------------------------------------------------- Print screen - $r->print(< - -The LearningOnline Network with CAPA - - - -

Search Catalog

- -$hidden -
-

Basic Search

-

-Enter terms or phrases separated by search operators -such as AND or OR then press SEARCH below. Terms should be specific -to the title, author, subject, notes, or abstract information associated -with a resource. -
-ENDDOCUMENT - $r->print(&simpletextfield('basicexp',$ENV{'form.basicexp'})); - $r->print(' '); - $r->print(&simplecheckbox('titleonly',$ENV{'form.titleonly'})); - $r->print('Title only '); - $r->print(&simplecheckbox('allversions',$ENV{'form.allversions'})); - $r->print(<Search historic archives -
- - - -

-
-

Advanced Search

-$scrout -

- - - -

+# $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.=< +#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.=< ENDDOCUMENT - return OK; -} + $r->print($scrout); + return; +} -# --------------------------------------------------------- Various form fields +###################################################################### +###################################################################### -sub textfield { - my ($title,$name,$value)=@_; - return "\n

$title:
". - ''; +=pod + +=item &get_persistent_form_data + +Inputs: filename of database + +Outputs: returns undef on database errors. + +This function is the reverse of &make_persistent() for form data. +Retrieve persistent data from %persistent_db. Retrieved items will have their +values unescaped. If a form value already exists in $ENV, it will not be +overwritten. Form values that are array references may have values appended +to them. + +=cut + +###################################################################### +###################################################################### +sub get_persistent_form_data { + my $filename = shift; + return 0 if (! -e $filename); + return undef if (! tie(%persistent_db,'GDBM_File',$filename, + &GDBM_READER(),0640)); + # + # These make sure we do not get array references printed out as 'values'. + my %arrays_allowed = ('form.domains'=>1); + # + # Loop through the keys, looking for 'form.' + foreach my $name (keys(%persistent_db)) { + next if ($name !~ /^form./); + next if (exists($ENV{$name})); + my @values = map { + &Apache::lonnet::unescape($_); + } split(',',$persistent_db{$name}); + next if (@values <1); + if ($arrays_allowed{$name}) { + $ENV{$name} = [@values]; + } else { + $ENV{$name} = $values[0] if ($values[0]); + } + } + untie (%persistent_db); + return 1; +} +###################################################################### +###################################################################### + +=pod + +=item &get_persistent_data + +Inputs: filename of database, ref to array of values to recover. + +Outputs: array of values. Returns undef on error. + +This function is the reverse of &make_persistent(); +Retrieve persistent data from %persistent_db. Retrieved items will have their +values unescaped. If the item contains commas (before unescaping), the +returned value will be an array pointer. + +=cut + +###################################################################### +###################################################################### +sub get_persistent_data { + my $filename = shift; + my @Vars = @{shift()}; + my @Values; # Return array + return undef if (! -e $filename); + return undef if (! tie(%persistent_db,'GDBM_File',$filename, + &GDBM_READER(),0640)); + foreach my $name (@Vars) { + if (! exists($persistent_db{$name})) { + push @Values, undef; + next; + } + my @values = map { + &Apache::lonnet::unescape($_); + } split(',',$persistent_db{$name}); + if (@values <= 1) { + push @Values,$values[0]; + } else { + push @Values,\@values; + } + } + untie (%persistent_db); + return @Values; +} + +###################################################################### +###################################################################### + +=pod + +=item &make_persistent() + +Inputs: Hash of values to save, filename of persistent database. + +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. + +=cut + +###################################################################### +###################################################################### +sub make_persistent { + my %save = %{shift()}; + my $filename = shift; + return undef if (! tie(%persistent_db,'GDBM_File', + $filename,&GDBM_WRCREAT(),0640)); + foreach my $name (keys(%save)) { + my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name})); + # We handle array references, but not recursively. + my $store = join(',', map { &Apache::lonnet::escape($_); } @values ); + $persistent_db{$name} = $store; + } + untie(%persistent_db); + return 1; } +###################################################################### +###################################################################### + +=pod + +=item &make_form_data_persistent() + +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. + +=cut + +###################################################################### +###################################################################### +sub make_form_data_persistent { + my $r = shift; + my $filename = shift; + my %save; + foreach (keys(%ENV)) { + next if (!/^form/ || /submit/); + $save{$_} = $ENV{$_}; + } + return &make_persistent(\%save,$filename); +} + +###################################################################### +# 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)=@_; - return ''; + 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)=@_; my $checked=''; - $checked="CHECKED" if $value eq 'on'; - return ''; + $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(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)=@_; - my $instruction=<$uctitle:". - " $instruction
". - ''; + 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 ''.&fieldtitle($title).''. + &simpletextfield($name,$value,50).' '. + &simplecheckbox($name.'_related',$ENV{'form.'.$name.'_related'}). + " \n"; +} + +############################################### +############################################### + +=pod + +=item &dateboxes() + +Returns html selection form elements for the specification of +the day, month, and year. + +=cut + +############################################### +############################################### + sub dateboxes { my ($name,$defaultmonth,$defaultday,$defaultyear, $currentmonth,$currentday,$currentyear)=@_; ($defaultmonth,$defaultday,$defaultyear)=('','',''); - my $month=< - - - - - - - - - - - - - - -END - $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth); + # + # Day my $day=< - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - END + for (my $i = 1; $i<=31; $i++) { + $day.="\n"; + } + $day.="\n"; $day=~s/(\"$currentday\")/$1 SELECTED/ if length($currentday); + # + # Month + my $month=< + +END + my $i = 1; + foreach (qw/January February March April May June + July August September October November December /){ + $month .="\n"; + $i++; + } + $month.="\n"; + $month=~s/(\"$currentmonth\")/$1 SELECTED/ if length($currentmonth); + # + # Year (obviously) my $year=< - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - END + my $maxyear = 2051; + for (my $i = 1976; $i<=$maxyear; $i++) { + $year.="\n"; + } + $year.="\n"; $year=~s/(\"$currentyear\")/$1 SELECTED/ if length($currentyear); return "$month$day$year"; } +############################################### +############################################### + +=pod + +=item &selectbox() + +Returns a scalar containing an html tag. + +=item $default + +The default value of the form. Can be $anyvalue, or in @idlist. + +=item $anyvalue + +The

$uctitle:". - "
".''; + unshift @idlist,$anyvalue if (defined($anyvalue)); + foreach (@idlist) { $selout.=''; + } + elsif ($_ eq $default and /^$anyvalue$/) { + $selout.=' selected >'.$anytag.''; + } + else {$selout.='>'.&{$functionref}($_).'';} + } + return $selout.''.(defined($title)?'

':' '); } -# ------------------------------------------------ Performing a advanced search -sub advancedsearch { - my ($r,$envhash)=@_; - my %ENV=%{$envhash}; +###################################################################### +# End of HTML form building functions # +###################################################################### + +=pod + +=back + +=cut + + +###################################################################### +###################################################################### +=pod + +=item &parse_advanced_search() + +Parse advanced search form and return the following: + +=over 4 + +=item $query Scalar containing an SQL query. + +=item $customquery Scalar containing a custom query. + +=item $customshow Scalar containing commands to show custom metadata. + +=item $libraries_to_query Reference to array of domains to search. + +=back + +=cut + +###################################################################### +###################################################################### +sub parse_advanced_search { + my ($r,$closebutton)=@_; + my $fillflag=0; + my $pretty_search_string = "
\n"; + # 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','extension','language','owner', + 'custommetadata','customshow','category') { + $ENV{"form.$field"}=~s/[^\w\/\s\(\)\=\-\"\']//g; + } + foreach ('mode','form','element') { + # is this required? Hmmm. + next unless (exists($ENV{"form.$_"})); + $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"}); + $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g; + } + # Preprocess the category form element. + $ENV{'form.category'} = 'any' if (! defined($ENV{'form.category'}) || + ref($ENV{'form.category'})); + # + # Check to see if enough information was filled in + for my $field ('title','author','subject','keywords','url','version', + 'notes','abstract','category','extension','language', + 'owner','custommetadata') { + if (&filled($ENV{"form.$field"})) { + $fillflag++; + } + } + unless ($fillflag) { + &output_blank_field_error($r,$closebutton,'phase=disp_adv'); + return ; + } + # Turn the form input into a SQL-based query + my $query=''; + my @queries; + my $font = ''; + # Evaluate logical expression AND/OR/NOT phrase fields. + foreach my $field ('title','author','subject','notes','abstract','url', + 'keywords','version','owner') { + if ($ENV{'form.'.$field}) { + my $searchphrase = $ENV{'form.'.$field}; + $pretty_search_string .= $font."$field contains ". + $searchphrase.""; + if ($ENV{'form.'.$field.'_related'}) { + my @New_Words; + ($searchphrase,@New_Words) = &related_version($searchphrase); + if (@New_Words) { + $pretty_search_string .= " with related words: ". + "@New_Words."; + } else { + $pretty_search_string .= " with no related words."; + } + } + $pretty_search_string .= "
\n"; + push @queries,&build_SQL_query($field,$searchphrase); + } + } + # + # Make the 'mime' from 'form.category' and 'form.extension' + # + my $searchphrase; + if (exists($ENV{'form.category'}) && + $ENV{'form.category'} !~ /^\s*$/ && + $ENV{'form.category'} ne 'any') { + my @extensions = &Apache::loncommon::filecategorytypes + ($ENV{'form.category'}); + if (scalar(@extensions) > 0) { + $searchphrase = join(' OR ',@extensions); + } + } + if (exists($ENV{'form.extension'}) && $ENV{'form.extension'} !~ /^\s*$/) { + $searchphrase .= ' OR ' if (defined($searchphrase)); + my @extensions = split(/,/,$ENV{'form.extension'}); + $searchphrase .= join(' OR ',@extensions); + } + if (defined($searchphrase)) { + push @queries,&build_SQL_query('mime',$searchphrase); + $pretty_search_string .=$font.'mime contains '. + $searchphrase.'
'; + } + ##### + # Evaluate option lists + if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') { + push @queries,"(language like \"$ENV{'form.language'}\")"; + $pretty_search_string.=$font."language= ". + &Apache::loncommon::languagedescription($ENV{'form.language'}). + "
\n"; + } + if ($ENV{'form.copyright'} and $ENV{'form.copyright'} ne 'any') { + push @queries,"(copyright like \"$ENV{'form.copyright'}\")"; + $pretty_search_string.=$font."copyright = ". + &Apache::loncommon::copyrightdescription($ENV{'form.copyright'}). + "
\n"; + } + # + # 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,$closebutton); + return ; + } elsif ($datequery) { + # Here is where you would set up pretty_search_string to output + # date query information. + push @queries,$datequery; + } + # Process form information for custom metadata querying + my $customquery=undef; +# if ($ENV{'form.custommetadata'}) { +# $pretty_search_string .=$font."Custom Metadata Search: ". +# $ENV{'form.custommetadata'}."
\n"; +# $customquery=&build_custommetadata_query('custommetadata', +# $ENV{'form.custommetadata'}); +# } + my $customshow=undef; +# if ($ENV{'form.customshow'}) { +# $pretty_search_string .=$font."Custom Metadata Display: ". +# $ENV{'form.customshow'}."
\n"; +# $customshow=$ENV{'form.customshow'}; +# $customshow=~s/[^\w\s]//g; +# my @fields=split(/\s+/,$customshow); +# $customshow=join(" ",@fields); +# } + ## --------------------------------------------------------------- + ## Deal with restrictions to given domains + ## + my $libraries_to_query = undef; + # $ENV{'form.domains'} can be either a scalar or an array reference. + # We need an array. + my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}} + : ($ENV{'form.domains'}) ); + my %domain_hash = (); + my $pretty_domains_string; + foreach (@allowed_domains) { + $domain_hash{$_}++; + } + if ($domain_hash{'any'}) { + $pretty_domains_string = "In all LON-CAPA domains."; + } else { + if (@allowed_domains > 1) { + $pretty_domains_string = "In LON-CAPA domains:"; + } else { + $pretty_domains_string = "In LON-CAPA domain "; + } + foreach (sort @allowed_domains) { + $pretty_domains_string .= "".$_." "; + } + foreach (keys(%Apache::lonnet::libserv)) { + if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) { + push @$libraries_to_query,$_; + } + } + } + $pretty_search_string .= $pretty_domains_string."
\n"; + # + if (@queries) { + $query=join(" AND ",@queries); + $query="select * from metadata where $query"; + } elsif ($customquery) { + $query = ''; + } + return ($query,$customquery,$customshow,$libraries_to_query, + $pretty_search_string); } -# --------------------------------------------------- Performing a basic search -sub basicsearch { - my ($r,$expression)=@_; +###################################################################### +###################################################################### - my $query=$expression; - $query="select * from metadata where concat(title,\" \",author) like '\%$expression\%'"; - my $reply=&Apache::lonnet::metadata_query($query); - &output_results($reply); - return OK; +=pod + +=item &parse_basic_search() + +Parse the basic search form and return a scalar containing an sql query. + +=cut + +###################################################################### +###################################################################### +sub parse_basic_search { + my ($r,$closebutton)=@_; + # Clean up fields for safety + for my $field ('basicexp') { + $ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g; + } + foreach ('mode','form','element') { + # is this required? Hmmm. + next unless (exists($ENV{"form.$_"})); + $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"}); + $ENV{"form.$_"}=~s/[^\w\/\s\(\)\=\-\"\']//g; + } + + # Check to see if enough is filled in + unless (&filled($ENV{'form.basicexp'})) { + &output_blank_field_error($r,$closebutton,'phase=disp_basic'); + return OK; + } + my $pretty_search_string = ''.$ENV{'form.basicexp'}.''; + my $search_string = $ENV{'form.basicexp'}; + if ($ENV{'form.related'}) { + my @New_Words; + ($search_string,@New_Words) = &related_version($ENV{'form.basicexp'}); + if (@New_Words) { + $pretty_search_string .= " with related words: @New_Words."; + } else { + $pretty_search_string .= " with no related words."; + } + } + # Build SQL query string based on form page + my $query=''; + my $concatarg=join('," ",', + ('title', 'author', 'subject', 'notes', 'abstract', + 'keywords')); + $concatarg='title' if $ENV{'form.titleonly'}; + $query=&build_SQL_query('concat('.$concatarg.')',$search_string); + $pretty_search_string .= "
\n"; + return 'select * from metadata where '.$query,$pretty_search_string; +} + + +###################################################################### +###################################################################### + +=pod + +=item &related_version + +Modifies an input string to include related words. Words in the string +are replaced with parenthesized lists of 'OR'd words. For example +"torque" is replaced with "(torque OR word1 OR word2 OR ...)". + +Note: Using this twice on a string is probably silly. + +=cut + +###################################################################### +###################################################################### +sub related_version { + my $search_string = shift; + my $result = $search_string; + my %New_Words = (); + while ($search_string =~ /(\w+)/cg) { + my $word = $1; + next if (lc($word) =~ /\b(or|and|not)\b/); + my @Words = &Apache::loncommon::get_related_words($word); + @Words = ($#Words>4? @Words[0..4] : @Words); + foreach (@Words) { $New_Words{$_}++;} + my $replacement = join " OR ", ($word,@Words); + $result =~ s/(\b)$word(\b)/$1($replacement)$2/g; + } + return $result,sort(keys(%New_Words)); } -# ----------------------------- format and output results based on a reply list -sub output_results { - my (@replylist)=@_; - foreach my $reply (@replylist) { - - 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; - - { - 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>; - } - - my $compiledresult=''; - - foreach my $result (@results) { - my ($title,$author,$subject,$url,$keywords,$version, - $notes,$abstract,$mime,$lang, - $creationdate,$lastrevisiondate,$owner,$copyright - )=map {&Apache::lonnet::unescape($_)} (split(/\,/,$result)); - my $shortabstract=$abstract; - $shortabstract=substr($abstract,0,200) if length($abstract)>200; - $compiledresult.=< 'Text::Query::ParseAdvanced', + -build => 'Text::Query::Build'); + $q->prepare($logic_statement); + my $matchexp=${$q}{'matchexp'}; chomp $matchexp; + my $sql_query=&recursive_SQL_query_build($field_name,$matchexp); + return $sql_query; +} + +###################################################################### +###################################################################### + +=pod + +=item &build_custommetadata_query() + +Constructs a custom metadata query using a rather heinous regular +expression. + +=cut + +###################################################################### +###################################################################### +sub build_custommetadata_query { + my ($field_name,$logic_statement)=@_; + my $q=new Text::Query('abc', + -parse => 'Text::Query::ParseAdvanced', + -build => 'Text::Query::BuildAdvancedString'); + $q->prepare($logic_statement); + my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'}; + # quick fix to change literal into xml tag-matching + # will eventually have to write a separate builder module + # wordone=wordtwo becomes\[^\<] *wordtwo[^\<]*\<\/wordone\> + $matchexp =~ s/(\w+)\\=([\w\\\+]+)?# wordone=wordtwo is changed to + /\\<$1\\>?# \ + \[\^\\<\]?# [^\<] + \*$2\[\^\\<\]?# *wordtwo[^\<] + \*\\<\\\/$1\\>?# *\<\/wordone\> + /g; + return $matchexp; +} + +###################################################################### +###################################################################### + +=pod + +=item &recursive_SQL_query_build() + +Recursively constructs an SQL query. Takes as input $dkey and $pattern. + +=cut + +###################################################################### +###################################################################### +sub recursive_SQL_query_build { + my ($dkey,$pattern)=@_; + my @matches=($pattern=~/(\[[^\]|\[]*\])/g); + return $pattern unless @matches; + foreach my $match (@matches) { + $match=~/\[ (\w+)\s(.*) \]/; + my ($key,$value)=($1,$2); + my $replacement=''; + if ($key eq 'literal') { + $replacement="($dkey like \"\%$value\%\")"; + } + elsif ($key eq 'not') { + $value=~s/like/not like/; +# $replacement="($dkey not like $value)"; + $replacement="$value"; + } + elsif ($key eq 'and') { + $value=~/(.*[\"|\)]) ([|\(|\^].*)/; + $replacement="($1 AND $2)"; + } + elsif ($key eq 'or') { + $value=~/(.*[\"|\)]) ([|\(|\^].*)/; + $replacement="($1 OR $2)"; + } + substr($pattern, + index($pattern,$match), + length($match), + $replacement + ); + } + &recursive_SQL_query_build($dkey,$pattern); +} + +###################################################################### +###################################################################### + +=pod + +=item &build_date_queries() + +Builds a SQL logic query to check time/date entries. +Also reports errors (check for /^Incorrect/). + +=cut + +###################################################################### +###################################################################### +sub build_date_queries { + my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2, + $lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_; + my @queries; + if ($cmonth1 or $cday1 or $cyear1 or $cmonth2 or $cday2 or $cyear2) { + unless ($cmonth1 and $cday1 and $cyear1 and + $cmonth2 and $cday2 and $cyear2) { + return "Incorrect entry for the creation date. You must specify ". + "a starting month, day, and year and an ending month, ". + "day, and year."; + } + my $cnumeric1=sprintf("%d%2d%2d",$cyear1,$cmonth1,$cday1); + $cnumeric1+=0; + my $cnumeric2=sprintf("%d%2d%2d",$cyear2,$cmonth2,$cday2); + $cnumeric2+=0; + if ($cnumeric1>$cnumeric2) { + return "Incorrect entry for the creation date. The starting ". + "date must occur before the ending date."; + } + my $cquery="(creationdate BETWEEN '$cyear1-$cmonth1-$cday1' AND '". + "$cyear2-$cmonth2-$cday2 23:59:59')"; + push @queries,$cquery; + } + if ($lmonth1 or $lday1 or $lyear1 or $lmonth2 or $lday2 or $lyear2) { + unless ($lmonth1 and $lday1 and $lyear1 and + $lmonth2 and $lday2 and $lyear2) { + return "Incorrect entry for the last revision date. You must ". + "specify a starting month, day, and year and an ending ". + "month, day, and year."; + } + my $lnumeric1=sprintf("%d%2d%2d",$lyear1,$lmonth1,$lday1); + $lnumeric1+=0; + my $lnumeric2=sprintf("%d%2d%2d",$lyear2,$lmonth2,$lday2); + $lnumeric2+=0; + if ($lnumeric1>$lnumeric2) { + return "Incorrect entry for the last revision date. The ". + "starting date must occur before the ending date."; + } + my $lquery="(lastrevisiondate BETWEEN '$lyear1-$lmonth1-$lday1' AND '". + "$lyear2-$lmonth2-$lday2 23:59:59')"; + push @queries,$lquery; + } + if (@queries) { + return join(" AND ",@queries); + } + return ''; +} + +###################################################################### +###################################################################### + +=pod + +=item ©right_check() + +=cut + +###################################################################### +###################################################################### +sub copyright_check { + my $Metadata = shift; + # Check copyright tags and skip results the user cannot use + my (undef,undef,$resdom,$resname) = split('/', + $Metadata->{'url'}); + # Check for priv + if (($Metadata->{'copyright'} eq 'priv') && + (($ENV{'user.name'} ne $resname) && + ($ENV{'user.domain'} ne $resdom))) { + return 0; + } + # Check for domain + if (($Metadata->{'copyright'} eq 'domain') && + ($ENV{'user.domain'} ne $resdom)) { + return 0; + } + return 1; +} + + +###################################################################### +###################################################################### + +=pod + +=item &ensure_db_and_table + +Ensure we can get lonmysql to connect to the database and the table we +need exists. + +Inputs: $r, table id + +Returns: undef on error, 1 if the table exists. + +=cut + +###################################################################### +###################################################################### +sub ensure_db_and_table { + my ($r,$table) = @_; + ## + ## Sanity check the table id. + ## + if (! defined($table) || $table eq '' || $table =~ /\D/ ) { + $r->print("Unable to retrieve search results. ". + "Unable to determine the table results were stored in. ". + ""); + return undef; + } + ## + ## Make sure we can connect and the table exists. + ## + my $connection_result = &Apache::lonmysql::connect_to_db(); + if (!defined($connection_result)) { + $r->print("Unable to connect to the MySQL database where your results". + " are stored. "); + &Apache::lonnet::logthis("lonsearchcat: unable to get lonmysql to". + " connect to database."); + &Apache::lonnet::logthis(&Apache::lonmysql::get_error()); + return undef; + } + my $table_check = &Apache::lonmysql::check_table($table); + if (! defined($table_check)) { + $r->print("A MySQL error has occurred."); + &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 + +=cut + +###################################################################### +###################################################################### +sub print_sort_form { + my ($r,$pretty_query_string) = @_; + ## + my %SortableFields = + (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::lonnet::logthis("lonmysql was unable to determine the number". + " of rows in table ".$table); + &Apache::lonnet::logthis(&Apache::lonmysql::get_error()); + return; + } + my $result; + $result.=< + + +Results + +$bodytag +
+ +END + +#

Sort Results

+#Sort by: }; + return $result; +} + +###################################################################### +###################################################################### + +=pod + +=item &run_search + +=cut + +###################################################################### +###################################################################### +sub run_search { + my ($r,$query,$customquery,$customshow,$serverlist,$pretty_string) = @_; + my $connection = $r->connection; + # + # Timing variables + # + my $starttime = time; + my $max_time = 30; # seconds for the search to complete + # + # Print run_search header + # + $r->print(< +Search Status +$bodytag + + END - $compiledresult.=< s and truncate the value. + # (there is probably a better way)... + my @Lines = split /
/,$pretty_string; + if (@Lines > 2) { + $pretty_string = join '
',(@Lines[0..2],'....
'); + } + $r->print("Search: ".$pretty_string); + $r->rflush(); + # + # Determine the servers we need to contact. + # + my @Servers_to_contact; + if (defined($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) || $table eq '' || $table =~ /\D/ ) { + $r->print("Unable to determine table id to store search results in.". + "The search has been aborted."); + return; + } + my $table_status = &Apache::lonmysql::check_table($table); + if (! defined($table_status)) { + $r->print("Unable to determine status of table."); + &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) { + $r->print("The table id,$table, we tried to use is invalid.". + "The search has been aborted."); + return; + } + ## + ## Prepare for the big loop. + ## + my $hitcountsum; + my $server; + my $status; + my $revise = &revise_button(); + $r->print(< +StatusTotal MatchesTime Remaining + + + + +$revise + + + +END + $r->rflush(); + my $time_remaining = $max_time - (time - $starttime) ; + my $last_time = $time_remaining; + &update_seconds($r,$time_remaining); + while (($time_remaining > 0) && + ((@Servers_to_contact) || keys(%Server_status))) { + # Send out a search request if it needs to be done. + if (@Servers_to_contact) { + # Contact one server + my $server = shift(@Servers_to_contact); + my $reply=&Apache::lonnet::metadata_query($query,$customquery, + $customshow,[$server]); + ($server) = keys(%$reply); + $Server_status{$server} = $reply->{$server}; + &update_status($r,'contacting '.$server); + } else { + # wait a sec. to give time for files to be written + # This sleep statement is here instead of outside the else + # block because we do not want to pause if we have servers + # left to contact. + sleep(1); + } + # + if (scalar (keys(%Server_status))) { + &update_status($r,'waiting on '.(join(' ',keys(%Server_status)))); + } + # + # Loop through the servers we have contacted but do not + # have results from yet, looking for results. + while (my ($server,$status) = each(%Server_status)) { + last if ($connection->aborted()); + if ($status eq 'con_lost') { + delete ($Server_status{$server}); + next; + } + $status=~/^([\.\w]+)$/; + my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1; + if (-e $datafile && ! -e "$datafile.end") { + &update_status($r,'Receiving results from '.$server); + next; + } + last if ($connection->aborted()); + if (-e "$datafile.end") { + &update_status($r,'Reading results from '.$server); + if (-z "$datafile") { + delete($Server_status{$server}); + next; + } + my $fh; + if (!($fh=Apache::File->new($datafile))) { + $r->print("Unable to open search results file for ". + "server $server. Omitting from search"); + delete($Server_status{$server}); + next; + } + # Read in the whole file. + while (my $result = <$fh>) { + last if ($connection->aborted()); + # handle custom fields? Someday we will! + chomp($result); + next unless $result; + # Parse the result. + my %Fields = &parse_raw_result($result,$server); + $Fields{'hostname'} = $server; + next if (! ©right_check(\%Fields)); + # Store the result in the mysql database + my $result = &Apache::lonmysql::store_row($table,\%Fields); + if (! defined($result)) { + $r->print(&Apache::lonmysql::get_error()); + } + # $r->print(&Apache::lonmysql::get_debug()); + $hitcountsum ++; + $time_remaining = $max_time - (time - $starttime) ; + if ($last_time - $time_remaining > 0) { + &update_seconds($r,$time_remaining); + $last_time = $time_remaining; + } + if ($hitcountsum % 50 == 0) { + &update_count_status($r,$hitcountsum); + } + } # End of foreach (@results) + $fh->close(); + # $server is only deleted if the results file has been + # found and (successfully) opened. This may be a bad idea. + delete($Server_status{$server}); + } + last if ($connection->aborted()); + &update_count_status($r,$hitcountsum); + } + last if ($connection->aborted()); + # Finished looping through the servers + $starttime = time if (@Servers_to_contact); + $time_remaining = $max_time - (time - $starttime) ; + if ($last_time - $time_remaining > 0) { + $last_time = $time_remaining; + &update_seconds($r,$time_remaining); + } + } + &update_status($r,'Search Complete'.$server); + &update_seconds($r,0); + &Apache::lonmysql::disconnect_from_db(); + # We have run out of time or run out of servers to talk to and + # results to get. + $r->print(""); + if ($ENV{'form.catalogmode'} ne 'groupsearch') { + $r->print(""); + } + return; +} + +###################################################################### +###################################################################### +=pod + +=item &prev_next_buttons + +=cut + +###################################################################### +###################################################################### +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 = 1 if $prev_min < 1; + 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; +} +###################################################################### +###################################################################### + +=pod + +=item &display_results + +=cut + +###################################################################### +###################################################################### +sub display_results { + my ($r,$importbutton,$closebutton) = @_; + my $connection = $r->connection; + $r->print(&search_results_header($importbutton,$closebutton)); + ## + ## Set viewing function + ## + 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=groupsearch. + my $checkbox_num = 0; + ## + ## Get the catalog controls setup + ## + my $action = "/adm/searchcat?phase=results"; + ## + ## Deal with groupsearch + ## + if ($ENV{'form.catalogmode'} eq 'groupsearch') { + if (! tie(%groupsearch_db,'GDBM_File',$diropendb, + &GDBM_WRCREAT(),0640)) { + $r->print('Unable to store import results.'); + $r->rflush(); + return; + } + } + ## + ## Prepare the table for querying + ## + 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::lonnet::logthis("lonmysql was unable to determine the number". + " of rows in table ".$table); + &Apache::lonnet::logthis(&Apache::lonmysql::get_error()); + return; + } + ## + ## Determine how many results we need to get + ## + $ENV{'form.start'} = 1 if (! exists($ENV{'form.start'})); + $ENV{'form.show'} = 'all' if (! exists($ENV{'form.show'})); + my $min = $ENV{'form.start'}; + my $max; + if ($ENV{'form.show'} eq 'all') { + $max = $total_results ; + } else { + $max = $min + $ENV{'form.show'} - 1; + $max = $total_results if ($max > $total_results); + } + ## + ## Output links (if necessary) for 'prev' and 'next' pages. + ## + $r->print + ('
'. + &prev_next_buttons($min,$ENV{'form.show'},$total_results, + "table=".$ENV{'form.table'}. + "&phase=results". + "&persistent_db_id=".$ENV{'form.persistent_db_id'}) + ."
\n" + ); + if ($total_results == 0) { + $r->print("There are currently no results.\n". + ""); + return; + } else { + $r->print + ("
Results $min to $max out of $total_results
\n"); + } + ## + ## Get results from MySQL table + ## + my @Results = &Apache::lonmysql::get_rows($table, + 'id>='.$min.' AND id<='.$max); + ## + ## Loop through the results and output them. + ## + foreach my $row (@Results) { + if ($connection->aborted()) { + &cleanup(); + return; + } + my %Fields = %{&parse_row(@$row)}; + my $output="

\n"; + my $prefix=&catalogmode_output($Fields{'title'},$Fields{'url'}, + $Fields{'id'},$checkbox_num++); + # Render the result into html + $output.= &$viewfunction($prefix,%Fields); + # Print them out as they come in. + $r->print($output); + $r->rflush(); + } + if (@Results < 1) { + $r->print("There were no results matching your query"); + } else { + $r->print + ('

'. + &prev_next_buttons($min,$ENV{'form.show'},$total_results, + "table=".$ENV{'form.table'}. + "&phase=results". + "&persistent_db_id=". + $ENV{'form.persistent_db_id'}) + ."
\n" + ); + } + $r->print(""); + $r->rflush(); + untie %groupsearch_db if (tied(%groupsearch_db)); + return; +} + +###################################################################### +###################################################################### + +=pod + +=item &catalogmode_output($title,$url,$fnum,$checkbox_num) + +Returns html needed for the various catalog modes. Gets inputs from +$ENV{'form.catalogmode'}. Stores data in %groupsearch_db. + +=cut + +###################################################################### +###################################################################### +sub catalogmode_output { + my $output = ''; + my ($title,$url,$fnum,$checkbox_num) = @_; + if ($ENV{'form.catalogmode'} eq 'interactive') { + $title=~ s/\'/\\\'/g; + if ($ENV{'form.catalogmode'} eq 'interactive') { + $output.=< -
END - $compiledresult.=<URL: $url -
-Title: $title
-Author(s): $author
-Subject: $subject
-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 -

+ } + } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') { + $groupsearch_db{"pre_${fnum}_link"}=$url; + $groupsearch_db{"pre_${fnum}_title"}=$title; + $output.=< + + END + } + return $output; +} +###################################################################### +###################################################################### + +=pod + +=item &parse_row + +Parse a row returned from the database. + +=cut + +###################################################################### +###################################################################### +sub parse_row { + my @Row = @_; + my %Fields; + for (my $i=0;$i<=$#Row;$i++) { + $Fields{$DataOrder[$i]}=&Apache::lonnet::unescape($Row[$i]); + } + $Fields{'language'} = + &Apache::loncommon::languagedescription($Fields{'lang'}); + $Fields{'copyrighttag'} = + &Apache::loncommon::copyrightdescription($Fields{'copyright'}); + $Fields{'mimetag'} = + &Apache::loncommon::filedescription($Fields{'mime'}); + return \%Fields; +} + +########################################################### +########################################################### + +=pod + +=item &parse_raw_result() + +Takes a line from the file of results and parse it. Returns a hash +with keys for the following fields: +'title', 'author', 'subject', 'url', 'keywords', 'version', 'notes', +'abstract', 'mime', 'lang', 'owner', 'copyright', 'creationdate', +'lastrevisiondate'. + +In addition, the following tags are set by calling the appropriate +lonnet function: 'language', 'cprtag', 'mimetag'. + +The 'title' field is set to "Untitled" if the title field is blank. + +'abstract' and 'keywords' are truncated to 200 characters. + +=cut + +########################################################### +########################################################### +sub parse_raw_result { + my ($result,$hostname) = @_; + # Check for a comma - if it is there then we do not need to unescape the + # string. There seems to be some kind of problem with some items in + # the database - the entire string gets sent out unescaped...? + unless ($result =~ /,/) { + $result = &Apache::lonnet::unescape($result); + } + my @fields=map { + &Apache::lonnet::unescape($_); + } (split(/\,/,$result)); + my ($title,$author,$subject,$url,$keywords,$version, + $notes,$abstract,$mime,$lang, + $creationdate,$lastrevisiondate,$owner,$copyright)=@fields; + my %Fields = + ( title => &Apache::lonnet::unescape($title), + author => &Apache::lonnet::unescape($author), + subject => &Apache::lonnet::unescape($subject), + url => &Apache::lonnet::unescape($url), + keywords => &Apache::lonnet::unescape($keywords), + version => &Apache::lonnet::unescape($version), + notes => &Apache::lonnet::unescape($notes), + abstract => &Apache::lonnet::unescape($abstract), + mime => &Apache::lonnet::unescape($mime), + lang => &Apache::lonnet::unescape($lang), + owner => &Apache::lonnet::unescape($owner), + copyright => &Apache::lonnet::unescape($copyright), + creationdate => &Apache::lonnet::unescape($creationdate), + lastrevisiondate => &Apache::lonnet::unescape($lastrevisiondate) + ); + $Fields{'language'} = + &Apache::loncommon::languagedescription($Fields{'lang'}); + $Fields{'copyrighttag'} = + &Apache::loncommon::copyrightdescription($Fields{'copyright'}); + $Fields{'mimetag'} = + &Apache::loncommon::filedescription($Fields{'mime'}); + if ($Fields{'author'}=~/^(\s*|error)$/) { + $Fields{'author'}="Unknown Author"; + } + # Put spaces in the keyword list, if needed. + $Fields{'keywords'}=~ s/,([A-z])/, $1/g; + if ($Fields{'title'}=~ /^\s*$/ ) { + $Fields{'title'}='Untitled'; + } + unless ($ENV{'user.adv'}) { + # What is this anyway? + $Fields{'keywords'} = '- not displayed -'; + $Fields{'notes'} = '- not displayed -'; + $Fields{'abstract'} = '- not displayed -'; + $Fields{'subject'} = '- not displayed -'; + } + if (length($Fields{'abstract'})>200) { + $Fields{'abstract'} = + substr($Fields{'abstract'},0,200).'...'; + } + if (length($Fields{'keywords'})>200) { + $Fields{'keywords'} = + substr($Fields{'keywords'},0,200).'...'; + } + return %Fields; +} + +########################################################### +########################################################### + +=pod + +=item &handle_custom_fields() + +=cut + +########################################################### +########################################################### +sub handle_custom_fields { + my @results = @{shift()}; + my $customshow=''; + my $extrashow=''; + my @customfields; + if ($ENV{'form.customshow'}) { + $customshow=$ENV{'form.customshow'}; + $customshow=~s/[^\w\s]//g; + my @fields=map { + "$_:"; + } split(/\s+/,$customshow); + @customfields=split(/\s+/,$customshow); + if ($customshow) { + $extrashow="
  • ".join("
  • ",@fields)."
\n"; + } + } + my $customdata=''; + my %customhash; + foreach my $result (@results) { + if ($result=~/^(custom\=.*)$/) { # grab all custom metadata + my $tmp=$result; + $tmp=~s/^custom\=//; + my ($k,$v)=map {&Apache::lonnet::unescape($_); + } split(/\,/,$tmp); + $customhash{$k}=$v; } + } + return ($extrashow,\@customfields,\%customhash); +} - unless ($compiledresult) { - $compiledresult="There were no results that matched your query"; - } - - # make query information persistent to allow for subsequent revision - my $persistent=''; - map { - if (/^form\./ && !/submit/) { - my $name=$_; - my $key=$name; - $name=~s/^form\.//; - $persistent.=< -END - } - } (keys %ENV); +###################################################################### +###################################################################### - $r->print(< - -The LearningOnline Network with CAPA -BEGINNING - $r->print(< +=pod + +=item &search_results_header + +Output the proper html headers and javascript code to deal with different +calling modes. + +Takes most inputs directly from %ENV, except $mode. + +=over 4 + +=item $mode is either (at this writing) 'Basic' or 'Advanced' + +=back + +The following environment variables are checked: + +=over 4 + +=item 'form.catalogmode' + +Checked for 'interactive' and 'groupsearch'. + +=item 'form.mode' + +Checked for existance & 'edit' mode. + +=item 'form.form' + +=item 'form.element' + +=back + +=cut + +###################################################################### +###################################################################### +sub search_results_header { + my ($importbutton,$closebutton) = @_; + my $result = ''; + # output beginning of search page + # conditional output of script functions dependent on the mode in + # which the search was invoked + if ($ENV{'form.catalogmode'} eq 'interactive'){ + if (! exists($ENV{'form.mode'}) || $ENV{'form.mode'} ne 'edit') { + $result.=< function select_data(title,url) { changeTitle(title); changeURL(url); + parent.close(); } function changeTitle(val) { - if (opener.inf.document.forms.resinfo.elements.t) { - opener.inf.document.forms.resinfo.elements.t.value=val; + if (parent.opener.inf.document.forms.resinfo.elements.t) { + parent.opener.inf.document.forms.resinfo.elements.t.value=val; } } function changeURL(val) { - if (opener.inf.document.forms.resinfo.elements.u) { - opener.inf.document.forms.resinfo.elements.u.value=val; + if (parent.opener.inf.document.forms.resinfo.elements.u) { + parent.opener.inf.document.forms.resinfo.elements.u.value=val; } } SCRIPT - $r->print(< +function select_data(title,url) { + changeURL(url); + parent.close(); +} +function changeTitle(val) { +} +function changeURL(val) { + if (parent.targetwin.document) { + parent.targetwin.document.forms["$form"].elements["$element"].value=val; + } else { + var url = 'forms[\"$form\"].elements[\"$element\"].value'; + alert("Unable to transfer data to "+url); + } +} + +SCRIPT + } + } + $result.=< +SCRIPT + $result.=< +$bodytag +
+ +$importbutton +END + return $result; +} + +###################################################################### +###################################################################### +sub search_status_header { + return <Search Status +$bodytag +

Search Status

+Sending search request to LON-CAPA servers.
+ENDSTATUS +} + +sub results_link { + my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}. + "&persistent_db_id=".$ENV{'form.persistent_db_id'}; + my $results_link = $basic_link."&phase=results". + "&pause=1"."&start=1"; + return $results_link; +} + +###################################################################### +###################################################################### +sub print_frames_interface { + my $r = shift; + my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}. + "&persistent_db_id=".$ENV{'form.persistent_db_id'}; + my $run_search_link = $basic_link."&phase=run_search"; + my $results_link = &results_link(); + my $result = <<"ENDFRAMES"; + + + +LON-CAPA Digital Library Search Results - - + + + + + +ENDFRAMES + + $r->print($result); + return; +} + +###################################################################### +###################################################################### + +=pod + +=item Metadata Viewing Functions + +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, and +extra custom metadata to show. + +=over 4 + +=item &detailed_citation_view() + +=cut + +###################################################################### +###################################################################### +sub detailed_citation_view { + my ($prefix,%values) = @_; + my $result=<$prefix$values{'title'} +

+$values{'author'}, $values{'owner'}
+ +Subject: $values{'subject'}
+Keyword(s): $values{'keywords'}
+Notes: $values{'notes'}
+MIME Type: $values{'mimetag'}
+Language: $values{'language'}
+Copyright/Distribution: $values{'cprtag'}
+

+$values{'extrashow'} +

+$values{'shortabstract'} +

+
+END + return $result; +} + +###################################################################### +###################################################################### + +=pod + +=item &summary_view() + +=cut +###################################################################### +###################################################################### +sub summary_view { + my ($prefix,%values) = @_; + my $result=<$values{'author'}
+$values{'title'}
+$values{'owner'} -- $values{'lastrevisiondate'}
+$values{'copyrighttag'}
+$values{'extrashow'} +

+
+END + return $result; +} + +###################################################################### +###################################################################### + +=pod + +=item &compact_view() + +=cut + +###################################################################### +###################################################################### +sub compact_view { + my ($prefix,%values) = @_; + my $result=< +$values{'title'} +$values{'author'}
+END + return $result; +} + + +###################################################################### +###################################################################### + +=pod + +=item &fielded_format_view() + +=cut + +###################################################################### +###################################################################### +sub fielded_format_view { + my ($prefix,%values) = @_; + my $result=<URL: $values{'url'} +
+Title: $values{'title'}
+Author(s): $values{'author'}
+Subject: $values{'subject'}
+Keyword(s): $values{'keywords'}
+Notes: $values{'notes'}
+MIME Type: $values{'mimetag'}
+Language: $values{'language'}
+Creation Date: $values{'creationdate'}
+Last Revision Date: $values{'lastrevisiondate'}
+Publisher/Owner: $values{'owner'}
+Copyright/Distribution: $values{'copyrighttag'}
+Repository Location: $values{'hostname'}
+Abstract: $values{'shortabstract'}
+$values{'extrashow'} +

+
+END + return $result; +} + +###################################################################### +###################################################################### + +=pod + +=item &xml_sgml_view() + +=back + +=cut + +###################################################################### +###################################################################### +sub xml_sgml_view { + my ($prefix,%values) = @_; + my $result=< +<LonCapaResource> +<url>$values{'url'}</url> +<title>$values{'title'}</title> +<author>$values{'author'}</author> +<subject>$values{'subject'}</subject> +<keywords>$values{'keywords'}</keywords> +<notes>$values{'notes'}</notes> +<mimeInfo> +<mime>$values{'mime'}</mime> +<mimetag>$values{'mimetag'}</mimetag> +</mimeInfo> +<languageInfo> +<language>$values{'lang'}</language> +<languagetag>$values{'language'}</languagetag> +</languageInfo> +<creationdate>$values{'creationdate'}</creationdate> +<lastrevisiondate>$values{'lastrevisiondate'}</lastrevisiondate> +<owner>$values{'owner'}</owner> +<copyrightInfo> +<copyright>$values{'copyright'}</copyright> +<copyrighttag>$values{'copyrighttag'}</copyrighttag> +</copyrightInfo> +<repositoryLocation>$values{'hostname'}</repositoryLocation> +<shortabstract>$values{'shortabstract'}</shortabstract> +</LonCapaResource> + +$values{'extrashow'} +
+END + return $result; +} + +###################################################################### +###################################################################### + +=pod + +=item &filled() see if field is filled. + +=cut + +###################################################################### +###################################################################### +sub filled { + my ($field)=@_; + if ($field=~/\S/ && $field ne 'any') { + return 1; + } + else { + return 0; + } +} + +###################################################################### +###################################################################### + +=pod + +=item &output_blank_field_error() + +Output a complete page that indicates the user has not filled in enough +information to do a search. + +Inputs: $r (Apache request handle), $closebutton, $parms. + +Returns: nothing + +$parms is extra information to include in the 'Revise search request' link. + +=cut + +###################################################################### +###################################################################### +sub output_blank_field_error { + my ($r,$closebutton,$parms)=@_; + # make query information persistent to allow for subsequent revision + $r->print(< + +The LearningOnline Network with CAPA +BEGINNING + $r->print(< +$bodytag + +

Search Catalog

+ +$hidden_fields +Revise search request  +$closebutton +
+

Unactionable search query.

+

+You did not fill in enough information for the search to be started. +You need to fill in relevant fields on the search page in order +for a query to be processed. +

+ + +RESULTS +} + +###################################################################### +###################################################################### + +=pod + +=item &output_date_error() + +Output a full html page with an error message. + +Inputs: + + $r, the request pointer. + $message, the error message for the user. + $closebutton, the specialized close button needed for groupsearch. + +=cut + +###################################################################### +###################################################################### +sub output_date_error { + my ($r,$message,$closebutton)=@_; + # make query information persistent to allow for subsequent revision + $r->print(< + +The LearningOnline Network with CAPA + +$bodytag +

Search Catalog

+$hidden_fields - -$persistent -
-

Search Query

+onClick='this.form.submit();' /> +$closebutton +
+

Error

-Basic search: $expression +$message

-

Search Results

-$compiledresult RESULTS +} + +###################################################################### +###################################################################### + +=pod + +=item &start_fresh_session() + +Cleans the global %groupsearch_db by removing all fields which begin with +'pre_' or 'store'. + +=cut + +###################################################################### +###################################################################### +sub start_fresh_session { + delete $groupsearch_db{'mode_catalog'}; + foreach (keys %groupsearch_db) { + if ($_ =~ /^pre_/) { + delete $groupsearch_db{$_}; + } + if ($_ =~ /^store/) { + delete $groupsearch_db{$_}; + } } } 1; + +sub cleanup { + untie %groupsearch_db if (tied(%groupsearch_db)); + &Apache::lonmysql::disconnect_from_db(); +} + __END__ + +=pod + +=back + +=cut