--- loncom/interface/lonsearchcat.pm 2002/06/18 21:36:38 1.121 +++ loncom/interface/lonsearchcat.pm 2003/03/08 03:24:58 1.168 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Search Catalog # -# $Id: lonsearchcat.pm,v 1.121 2002/06/18 21:36:38 matthew Exp $ +# $Id: lonsearchcat.pm,v 1.168 2003/03/08 03:24:58 www 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 -# ############################################################################### ############################################################################### @@ -40,7 +32,7 @@ =head1 NAME -lonsearchcat +lonsearchcat - LONCAPA Search Interface =head1 SYNOPSIS @@ -67,14 +59,14 @@ search (on a server basis) is displayed ############################################################################### ############################################################################### +############################################################################### ## ## ## ORGANIZATION OF THIS PERL MODULE ## ## ## ## 1. Modules used by this module ## -## 2. Choices for different output views (detailed, summary, xml, etc) ## -## 3. BEGIN block (to be run once after compilation) ## -## 4. Handling routine called via Apache and mod_perl ## -## 5. Other subroutines ## +## 2. Variables used throughout the module ## +## 3. handler subroutine called via Apache and mod_perl ## +## 4. Other subroutines ## ## ## ############################################################################### @@ -82,13 +74,14 @@ package Apache::lonsearchcat; # ------------------------------------------------- modules used by this module use strict; -use Apache::Constants qw(:common); +use Apache::Constants qw(:common :http); use Apache::lonnet(); use Apache::File(); use CGI qw(:standard); use Text::Query; use GDBM_File; use Apache::loncommon(); +use Apache::lonmysql(); # ---------------------------------------- variables used throughout the module @@ -101,51 +94,30 @@ use Apache::loncommon(); =over 4 -=item %hostdomains - -matches host name to host domain - -=item %hostips - -matches host name to host ip - -=item %hitcount - -stores number of hits per host - -=item $closebutton - -button that closes the search window - =item $importbutton -button to take the selecte results and go to group sorting - -=item $hidden - -holds 'hidden' html forms - -=item $scrout - -string that holds portions of the screen output +button to take the select results and go to group sorting -=item $yourself +=item %groupsearch_db -allows for quickly limiting to oneself +Database hash used to save values for the groupsearch RAT interface. -=item %hash +=item $diropendb -The ubiquitous database hash +The full path to the (temporary) search database file. This is set and +used in &handler() and is also used in &output_results(). -=item $basicviewselect and $advancedviewselect +=item %Views -View selection forms. These are not actually global and will be -moved soon. +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 $diropendb +=item $bodytag -The full path to the (temporary) search database file. This is set and -used in &handler() and is also used in &output_results(). +LON-CAPA standard body tag, gotten from &Apache::lonnet::bodytag. +No title, no table, just a tag. =back @@ -154,194 +126,603 @@ used in &handler() and is also used in & ###################################################################### ###################################################################### -# -- information holders -my %hostdomains; # matches host name to host domain -my %hostips; # matches host name to host ip -my %hitcount; # stores number of hits per host - # -- dynamically rendered interface components -my $closebutton; # button that closes the search window my $importbutton; # button to take the selected results and go to group sorting -my $hidden; # Holds 'hidden' html forms # -- miscellaneous variables -my $scrout; # string that holds portions of the screen output -my $yourself; # allows for quickly limiting to oneself -my %hash; # database hash - -# ------------------------------------------ choices for different output views -# Detailed Citation View ---> sub detailed_citation_view -# Summary View ---> sub summary_view -# Fielded Format ---> sub fielded_format_view -# XML/SGML ---> sub xml_sgml_view -my $basicviewselect=< - - - - - -END -my $advancedviewselect=< - - - - - -END - -#------------------------------------------------------------- global variables -my $diropendb = ""; -my $domain = ""; +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 %alreadyseen; +my $hashtied; +my %hash; + +###################################################################### +###################################################################### -# ----------------------------------------------------------------------- BEGIN +=pod -=pod +=item &handler() - main handler invoked by httpd child -=item BEGIN block +=item Variables -Load %hostdomains and %hostips with data from lonnet.pm. Only library -servers are considered. +=over 4 -=cut +=item $hidden -BEGIN { - foreach (keys (%Apache::lonnet::libserv)) { - $hostdomains{$_}=$Apache::lonnet::hostdom{$_}; - $hostips{$_}=$Apache::lonnet::hostip{$_}; - } -} +holds 'hidden' html forms -###################################################################### -###################################################################### +=item $scrout -=pod +string that holds portions of the screen output -=item &handler() - main handler invoked by httpd child +=back =cut ###################################################################### ###################################################################### -# ----------------------------- Handling routine called via Apache and mod_perl sub handler { my $r = shift; - untie %hash; + # + 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; - - my $domain = $r->dir_config('lonDefDomain'); - $diropendb= "/home/httpd/perl/tmp/".&Apache::lonnet::unescape($domain). - "\_".&Apache::lonnet::unescape($ENV{'user.name'})."_searchcat.db"; - + ## + ## 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']); - - if ($ENV{'form.launch'} eq '1') { - if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { + ['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 + return OK; + } + } + ## + ## 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 %hash; - } - else { - $r->print('Unable to tie hash to db '. - 'file'); + 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; } } - -# --------------------------- Produce some output, so people know it is working - - $r->print("\n"); - $r->rflush; - -# ----------------------------------- configure dynamic components of interface - + ## + ## Configure hidden fields + ## + $hidden_fields = ''."\n"; + if (exists($ENV{'form.catalogmode'})) { + $hidden_fields .= ''."\n"; + } + 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') { - $hidden="". - "\n"; - $closebutton=""."\n"; - } - elsif ($ENV{'form.catalogmode'} eq 'groupsearch') { - $hidden=< -END - $closebutton=< -END + $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"; + } } - $hidden .= < - - - + $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 'course_search') { + &course_search($r); + } elsif(($ENV{'form.phase'} eq 'basic_search') || + ($ENV{'form.phase'} eq 'adv_search')) { + $ENV{'form.searchmode'} = 'basic'; + if ($ENV{'form.phase'} eq 'adv_search') { + $ENV{'form.searchmode'} = 'advanced'; + } + # Set up table + if (! defined(&create_results_table())) { + $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 -# ------------------------------------------------------ Determine current user - $yourself=$ENV{'user.name'}.'@'.$ENV{'user.domain'}; + 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; +} -# --- Now, depending on the interface actions, do one of three things here: -# --- 1. a basic search -# --- 2. an advanced search -# --- 3. output a search interface +###################################################################### +###################################################################### -# ----------------------------------- See if a search invocation should be done - if ($ENV{'form.basicsubmit'} eq 'SEARCH') { - untie %hash; return &basicsearch($r,\%ENV); +sub course_search { + my $r=shift; + my $bodytag=&Apache::loncommon::bodytag('Course Search'); + my $pretty_search_string = ''.$ENV{'form.courseexp'}.''; + my $search_string = $ENV{'form.courseexp'}; + my @New_Words; + if ($ENV{'form.crsrelated'}) { + ($search_string,@New_Words) = &related_version($ENV{'form.courseexp'}); + if (@New_Words) { + $pretty_search_string .= " with related words: @New_Words."; + } else { + $pretty_search_string .= " with no related words."; + } } - elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') { - untie %hash; return &advancedsearch($r,\%ENV); + my $fulltext=$ENV{'form.crsfulltext'}; + my @allwords=($search_string,@New_Words); + $r->print('LON-CAPA Course Search'. + $bodytag.$pretty_search_string); + $r->rflush(); +# ======================================================= Go through the course + $hashtied=0; + undef %alreadyseen; + %alreadyseen=(); + &tiehash(); + foreach (keys %hash) { + if (($_=~/^src\_(.+)$/) && (!$alreadyseen{$hash{$_}})) { + &checkonthis($r,$hash{$_},0,$hash{'title_'.$1},$fulltext,@allwords); + } + } + &untiehash(); +# =================================================== Done going through course + $r->print(''); +} + +# ---------------------------------------------------------------- tie the hash + +sub tiehash { + $hashtied=0; + if ($ENV{'request.course.fn'}) { + if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.".db", + &GDBM_READER(),0640)) { + $hashtied=1; + } + } +} + +sub untiehash { + if ($hashtied) { untie %hash; } + $hashtied=0; +} + +# =============================== This pulls up a resource and its dependencies + +sub checkonthis { + my ($r,$url,$level,$title,$fulltext,@allwords)=@_; + $alreadyseen{$url}=1; + $r->rflush(); + my $result=&Apache::lonnet::metadata($url,'title').' '. + &Apache::lonnet::metadata($url,'subject').' '. + &Apache::lonnet::metadata($url,'abstract').' '. + &Apache::lonnet::metadata($url,'keywords'); + if (($url) && ($fulltext)) { + $result.=&Apache::lonnet::ssi_body($url); + } + $result=~s/\s+/ /gs; + my $applies=0; + foreach (@allwords) { + if ($_=~/\w/) { + if ($result=~/$_/si) { + $applies++; + } + } + } +# Does this resource apply? + if ($applies) { + $r->print('
'); + for (my $i=0;$i<=$level*5;$i++) { + $r->print(' '); + } + $r->print(''. + ($title?$title:$url).''); + $r->rflush(); + } +# Check also the dependencies of this one + my $dependencies= + &Apache::lonnet::metadata($url,'dependencies'); + foreach (split(/\,/,$dependencies)) { + if (($_=~/^\/res\//) && (!$alreadyseen{$_})) { + &checkonthis($r,$_,$level+1,'',$fulltext,@allwords); + } } +} + +###################################################################### +###################################################################### -# ----------------------------- Else, begin building search interface to output - $scrout=''; # building a part of screen output - $scrout.=&searchphrasefield('Limit by title','title', - $ENV{'form.title'}); +=pod + +=item &print_basic_search_form() - $scrout.=&searchphrasefield('Limit by author','author', - $ENV{'form.author'}); +Returns a scalar which holds html for the basic search form. + +=cut - $scrout.=&searchphrasefield('Limit by subject','subject', - $ENV{'form.subject'}); +###################################################################### +###################################################################### - $scrout.=&searchphrasefield('Limit by keywords','keywords', - $ENV{'form.keywords'}); +sub print_basic_search_form{ + my ($r,$closebutton) = @_; + my $bodytag=&Apache::loncommon::bodytag('Search'); + my $scrout=<<"ENDDOCUMENT"; + + +The LearningOnline Network with CAPA + + +$bodytag +ENDDOCUMENT +if (&Apache::lonnet::allowed('bre',$ENV{'request.role.domain'})) { + $scrout.=(<Catalog Search +
+ +$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 + if ($ENV{'request.course.id'}) { $scrout.='

'; } +} +if ($ENV{'request.course.id'}) { + $scrout.=(<Course Search +
+ +$hidden_fields +

+Enter terms or phrases, then press SEARCH below. +

+

+ + + + +
+ENDCOURSESEARCH + $scrout.=' '.&simpletextfield('courseexp',$ENV{'form.courseexp'},40); + my $crscheckbox = &simplecheckbox('crsfulltext',$ENV{'form.crsfulltext'}); + my $relcheckbox = &simplecheckbox('crsrelated',$ENV{'form.crsrelated'}); +$scrout.=(<
$relcheckbox use related words
$crscheckbox fulltext search (time consuming)

+  +

+ENDENDCOURSE +} + $scrout.=(< + +ENDDOCUMENT + $r->print($scrout); + return; +} +###################################################################### +###################################################################### - $scrout.=&searchphrasefield('Limit by URL','url', - $ENV{'form.url'}); +=pod -# $scrout.=&searchphrasefield('Limit by version','version', -# $ENV{'form.version'}); +=item &advanced_search_form() - $scrout.=&searchphrasefield('Limit by notes','notes', - $ENV{'form.notes'}); +Returns a scalar which holds html for the advanced search form. - $scrout.=&searchphrasefield('Limit by abstract','abstract', - $ENV{'form.abstract'}); +=cut - $ENV{'form.mime'}='any' unless length($ENV{'form.mime'}); - $scrout.=&selectbox('Limit by MIME type','mime', - $ENV{'form.mime'}, - 'any','Any type', - \&{Apache::loncommon::filedescriptionex}, - (&Apache::loncommon::fileextensions)); +###################################################################### +###################################################################### +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; + $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::languagedescription, (&Apache::loncommon::languageids), ); - # ------------------------------------------------ Compute date selection boxes $scrout.=< @@ -355,16 +736,13 @@ CREATIONDATESTART $ENV{'form.creationdatestart_day'}, $ENV{'form.creationdatestart_year'}, ); - $scrout.=< LIMIT BY LAST REVISION DATE RANGE: @@ -385,160 +763,344 @@ LASTREVISIONDATEEND $ENV{'form.lastrevisiondateend_year'}, ); $scrout.='

'; - - $scrout.=&searchphrasefield('Limit by publisher/owner','owner', - $ENV{'form.owner'}); - $ENV{'form.copyright'}='any' unless length($ENV{'form.copyright'}); $scrout.=&selectbox('Limit by copyright/distribution','copyright', $ENV{'form.copyright'}, 'any','Any copyright/distribution', - \&{Apache::loncommon::copyrightdescription}, + \&Apache::loncommon::copyrightdescription, (&Apache::loncommon::copyrightids), ); - # ------------------------------------------- Compute customized metadata field - $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.=' initial users of this system do not need to worry about this option'; - - $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.=' 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 NOT 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'})); -# Search historic archives - $r->print(< - - -$closebutton -$basicviewselect - -

-
-

Advanced Search

-$scrout -

- - -$closebutton -$advancedviewselect - -

+# $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; +} ###################################################################### ###################################################################### =pod -=item &make_persistent() +=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. -Returns a scalar which holds the current ENV{'form.*'} values in -a 'hidden' html input tag. =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; +} +###################################################################### +###################################################################### -# ------------------------------------------------------------- make persistent +=pod -sub make_persistent { - my $persistent=''; - - foreach (keys %ENV) { - if (/^form\./ && !/submit/) { - my $name=$_; - my $key=$name; - $ENV{$key}=~s/\'//g; # do not mess with html field syntax - $name=~s/^form\.//; - $persistent.=< -END +=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; } } - return $persistent; + 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; } -# --------------------------------------------------------- Various form fields +###################################################################### +###################################################################### + +=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)=@_; @@ -583,30 +1145,123 @@ END 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 contains '. + $searchphrase.'
'; } + ##### # Evaluate option lists if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') { push @queries,"(language like \"$ENV{'form.language'}\")"; - } - if ($ENV{'form.mime'} and $ENV{'form.mime'} ne 'any') { - push @queries,"(mime like \"$ENV{'form.mime'}\")"; + $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'}, @@ -677,56 +1376,87 @@ sub advancedsearch { ); # Test to see if date windows are legitimate if ($datequery=~/^Incorrect/) { - &output_date_error($r,$datequery); - return OK; - } - elsif ($datequery) { + &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=''; - if ($ENV{'form.custommetadata'}) { - $customquery=&build_custommetadata_query('custommetadata', - $ENV{'form.custommetadata'}); + 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{$_}++; } - my $customshow=''; - if ($ENV{'form.customshow'}) { - $customshow=$ENV{'form.customshow'}; - $customshow=~s/[^\w\s]//g; - my @fields=split(/\s+/,$customshow); - $customshow=join(" ",@fields); - } - # Send query statements over the network to be processed by either the SQL - # database or a recursive scheme of 'grep'-like actions (for custom - # metadata). + if ($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"; - my $reply; # reply hash reference - unless ($customquery or $customshow) { - $reply=&Apache::lonnet::metadata_query($query); - } - else { - $reply=&Apache::lonnet::metadata_query($query, - $customquery,$customshow); - } - &output_results('Advanced',$r,$envhash,$customquery,$reply); + } elsif ($customquery) { + $query = ''; } - elsif ($customquery) { - my $reply; # reply hash reference - $reply=&Apache::lonnet::metadata_query('', - $customquery,$customshow); - &output_results('Advanced',$r,$envhash,$customquery,$reply); - } - # should not get to this point - return 'Error. Should not have gone to this point.'; -} - -# --------------------------------------------------- Performing a basic search -sub basicsearch { - my ($r,$envhash)=@_; - my %ENV=%{$envhash}; + return ($query,$customquery,$customshow,$libraries_to_query, + $pretty_search_string); +} + +###################################################################### +###################################################################### + +=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; @@ -740,29 +1470,79 @@ sub basicsearch { # Check to see if enough is filled in unless (&filled($ENV{'form.basicexp'})) { - &output_blank_field_error($r); + &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')); + ('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; +} - $query=&build_SQL_query('concat('.$concatarg.')',$ENV{'form.'.'basicexp'}); - # Get reply (either a hash reference to filehandles or bad connection) - my $reply=&Apache::lonnet::metadata_query('select * from metadata where '.$query); +###################################################################### +###################################################################### - # Output search results +=pod - &output_results('Basic',$r,$envhash,$query,$reply); +=item &related_version - return OK; +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)); } -# ------------------------------------------------------------- build_SQL_query +###################################################################### +###################################################################### + +=pod + +=item &build_SQL_query() + +Builds a SQL query string from a logical expression with AND/OR keywords +using Text::Query and &recursive_SQL_query_builder() + +=cut + +###################################################################### +###################################################################### sub build_SQL_query { my ($field_name,$logic_statement)=@_; my $q=new Text::Query('abc', @@ -774,7 +1554,20 @@ sub build_SQL_query { return $sql_query; } -# ------------------------------------------------- build custom metadata 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', @@ -784,12 +1577,29 @@ sub build_custommetadata_query { my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'}; # quick fix to change literal into xml tag-matching # will eventually have to write a separate builder module - my $oldmatchexp=$matchexp; - $matchexp=~s/(\w+)\\=([\w\\\+]+)/\\<$1\\>\[\^\\<\]\*$2\[\^\\<\]\*\\<\\\/$1\\>/g; + # wordone=wordtwo becomes\[^\<] *wordtwo[^\<]*\<\/wordone\> + $matchexp =~ s/(\w+)\\=([\w\\\+]+)?# wordone=wordtwo is changed to + /\\<$1\\>?# \ + \[\^\\<\]?# [^\<] + \*$2\[\^\\<\]?# *wordtwo[^\<] + \*\\<\\\/$1\\>?# *\<\/wordone\> + /g; return $matchexp; } -# - Recursively parse a reverse notation expression into a SQL query expression +###################################################################### +###################################################################### + +=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); @@ -823,7 +1633,20 @@ sub recursive_SQL_query_build { &recursive_SQL_query_build($dkey,$pattern); } -# ------------------------------------------------------------ Build date query +###################################################################### +###################################################################### + +=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)=@_; @@ -872,51 +1695,983 @@ sub build_date_queries { return ''; } -# ----------------------------- format and output results based on a reply list -# There are two windows that this function writes to. The main search -# window ("srch") has a listing of the results. A secondary window ("popwin") -# gives the status of the network search (time elapsed, number of machines -# contacted, etc.) -sub output_results { - my $fnum; # search result counter - my ($mode,$r,$envhash,$query,$replyref)=@_; - my %ENV=%{$envhash}; - my %rhash=%{$replyref}; - my $compiledresult=''; - my $timeremain=300; - my $elapsetime=0; - my $resultflag=0; - my $tflag=1; +###################################################################### +###################################################################### - # make query information persistent to allow for subsequent revision - my $persistent=&make_persistent(); +=pod - # output beginning of search page - $r->print(<{'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.=< -The LearningOnline Network with CAPA -BEGINNING + +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 + # Check to see if $pretty_string has more than one carriage return. + # Assume \n s are following
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 + } + } 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); +} + +###################################################################### +###################################################################### + +=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') { - $r->print(< function select_data(title,url) { changeTitle(title); changeURL(url); - self.close(); + 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; } } @@ -924,17 +2679,17 @@ SCRIPT } elsif ($ENV{'form.mode'} eq 'edit') { my $form = $ENV{'form.form'}; my $element = $ENV{'form.element'}; - $r->print(< function select_data(title,url) { changeURL(url); - self.close(); + parent.close(); } function changeTitle(val) { } function changeURL(val) { - if (window.opener.document) { - window.opener.document.forms["$form"].elements["$element"].value=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); @@ -944,529 +2699,270 @@ function changeURL(val) { SCRIPT } } - $r->print(< - function select_data(title,url) { -// alert('DEBUG: Should be storing '+title+' and '+url); - } - function queue(val) { - if (eval("document.forms.results.returnvalues["+val+"].checked")) { - document.forms.results.acts.value+='1a'+val+'b'; - } - else { - document.forms.results.acts.value+='0a'+val+'b'; - } + function queue(checkbox_num,val) { + if (document.forms.results.returnvalues[checkbox_num].checked) { + parent.statusframe.document.forms.statusform.elements.Queue.value +='1a'+val+'b'; + } else { + parent.statusframe.document.forms.statusform.elements.Queue.value +='0a'+val+'b'; + } } function select_group() { - window.location= + parent.window.location= "/adm/groupsort?mode=$ENV{'form.mode'}&catalogmode=groupsearch&acts="+ - document.forms.results.acts.value; + parent.statusframe.document.forms.statusform.elements.Queue.value; } SCRIPT - $r->print(< - function displayinfo(val) { - popwin.document.forms.popremain.sdetails.value=val; - } - function openhelp(val) { - openhelpwin=open('/adm/help/searchcat.html','helpscreen', - 'scrollbars=1,width=400,height=300'); - openhelpwin.focus(); - } - function abortsearch(val) { - popwin.close(); - } - -SCRIPT - $r->rflush(); - - # begin showing the cataloged results - $r->print(< - - -

Search Catalog

-CATALOGBEGIN - $r->print(< -$hidden - - +$bodytag +
+ $importbutton -$closebutton -$persistent -
-

Search Query

-CATALOGCONTROLS - if ($mode eq 'Basic') { - $r->print(< -Basic search: $ENV{'form.basicexp'} -

-RESULTS - } - elsif ($mode eq 'Advanced') { - $r->print(< -Advanced search -$query -

-RESULTS - } - $r->print('

Search Results

'); - $r->rflush(); - my $servernum=(keys %rhash)+0; - - # define server grid (shows status of multiple machines) - my $hcinit; - my $grid="'
'+"; - $grid.="\n"; - my $sn=1; - for my $sk (sort keys %rhash) { - # ''+ - $grid.="'+\"'\"+')\">'+"; - $grid.="\n"; - $grid.="'\"".$sk."\"'+\n"; - $grid.="'
'+\n" unless $sn%10; - $sn++; - } - $r->print(< - popwin=open('','popwin','scrollbars=1,width=400,height=220'); - popwin.focus(); - popwin.document.writeln('<'+'html>'); - popwin.document.writeln('<'+'head>'); - popwin.document.writeln('<'+'script>'); - popwin.document.writeln('hc=new Array();$hcinit'); - popwin.document.writeln('<'+'/script>'); - popwin.document.writeln('<'+'/head>'+ - '<'+'body bgcolor="#FFFFFF">'+ - '<'+'image name="whirly" align="right" src="/adm/lonIcons/'+ - 'lonanim.gif" '+ - 'alt="animated logo" />'+ - '<'+'h3>Search Results Progress<'+'/h3>'+ - '<'+'form name="popremain">'+ - '<'+'tt>'+ - '<'+'br clear="all"/>PLEASE BE PATIENT'+ - '<'+'br />SCANNING $servernum SERVERS'+ - '<'+'br clear="all" />Number of record hits found '+ - '<'+'input type="text" size="10" name="numhits"'+ - ' value="0" />'+ - '<'+'br clear="all" />Time elapsed '+ - '<'+'input type="text" size="10" name="elapsetime"'+ - ' value="0" />'+ - '<'+'br />'+ - 'SERVER GRID (click on any cell for details)'+ - $grid - '<'+'br />'+ - 'Server details '+ - '<'+'input type="text" size="35" name="sdetails"'+ - ' value="" />'+ - '<'+'br />'+ - ' <'+'input type="button" name="button"'+ - ' value="close this window" '+ - ' onClick="javascript:opener.abortsearch()" />'+ - ' <'+'input type="button" name="button"'+ - ' value="help" onClick="javascript:opener.openhelp()" />'+ - '<'+'/tt>'+ - '<'+'/form>'+ - '<'+'/body><'+'/html>'); - popwin.document.close(); - -ENDPOP - $r->rflush(); - - my $servercount=0; - my $hitcountsum=0; - my $bloop=$servernum; - my %orkey; - BLOOP: while(1) { - my $sn=0; - last BLOOP unless $bloop; - last BLOOP unless $timeremain; - RLOOP: foreach my $rkey (sort keys %rhash) { - $sn++; - next RLOOP if $orkey{$rkey}; - $servercount++; - $tflag=1; - $compiledresult=''; - my $hostname=$rkey; - my $reply=$rhash{$rkey}; - my @results; - - my $replyfile=''; - - if ($reply eq 'con_lost') { - &popwin_imgupdate($r,$sn,"srvbad.gif"); - $bloop--; - $orkey{$rkey}=1; - } - else { - $reply=~/^([\.\w]+)$/; # must do since 'use strict' checks for tainting - $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1; - $reply=~/(.*?)\_/; - { - my $temp=0; - WLOOP: while (1) { - if (-e $replyfile && $tflag) { - &popwin_imgupdate($r,$sn,"srvhalf.gif"); - &popwin_js($r,'popwin.hc["'.$rkey.'"]='. - '"still transferring..."'.';'); - $tflag=0; - } - if (-e "$replyfile.end") { - $bloop--; - $orkey{$rkey}=1; - if (-s $replyfile) { - &popwin_imgupdate($r,$sn,"srvgood.gif"); - my $fh=Apache::File->new($replyfile) or - ($r->print('ERROR: file '. - $replyfile.' cannot be opened') and - return OK); - @results=<$fh> if $fh; - $hitcount{$rkey}=@results+0; - &popwin_js($r,'popwin.hc["'.$rkey.'"]='. - $hitcount{$rkey}.';'); - $hitcountsum+=$hitcount{$rkey}; - &popwin_js($r,'popwin.document.forms.popremain.'. - 'numhits.value='.$hitcountsum.';'); - } - else { - &popwin_imgupdate($r,$sn,"srvempty.gif"); - &popwin_js($r,'popwin.hc["'.$rkey.'"]=0;'); - } - last WLOOP; - } - if ($temp>1) { - sleep 1; - $timeremain--; - $elapsetime++; - last WLOOP; - } - last WLOOP unless $timeremain; - sleep 1; - $timeremain--; - $elapsetime++; - &popwin_js($r,"popwin.document.popremain.". - "elapsetime.value=$elapsetime;"); - $temp++; - } - } - &popwin_js($r,'popwin.document.whirly.'. - 'src="/adm/lonIcons/lonanimend.gif";'); - } - 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; - } - } - if (keys %hash) { - untie %hash; - } - if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { - if ($ENV{'form.launch'} eq '1') { - &start_fresh_session(); - } - foreach my $result (@results) { - next if $result=~/^custom\=/; - chomp $result; - next unless $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; - - unless ($title) { $title='Untitled'; } - unless ($ENV{'user.adv'}) { - $keywords='- not displayed -'; - $fields[4]=$keywords; - $notes='- not displayed -'; - $fields[6]=$notes; - $abstract='- not displayed -'; - $fields[7]=$abstract; - $subject='- not displayed -'; - $fields[2]=$subject; - } - - my $shortabstract=$abstract; - $shortabstract=substr($abstract,0,200).'...' if length($abstract)>200; - $fields[7]=$shortabstract; - my $shortkeywords=$keywords; - $shortkeywords=substr($keywords,0,200).'...' if length($keywords)>200; - $fields[4]=$shortkeywords; - - my $extrashow2=$extrashow; - if ($extrashow) { - foreach my $field (@customfields) { - my $value=''; - if ($customhash{$url}=~/\<${field}[^\>]*\>(.*?)\<\/${field}[^\>]*\>/s) { - $value=$1; - } - $extrashow2=~s/\<\!\-\- $field \-\-\>/ $value/g; - } - } - - $compiledresult.=< END - $compiledresult.=< -END - if ($ENV{'form.catalogmode'} eq 'interactive') { - my $titleesc=$title; - $titleesc=~s/\'/\\'/; # ' + return $result; +} - $compiledresult.=< - -
-END - } - if ($ENV{'form.catalogmode'} eq 'groupsearch') { - $fnum+=0; - $hash{"pre_${fnum}_link"}=$url; - $hash{"pre_${fnum}_title"}=$title; - $compiledresult.=< - - -
-END -# -# - $fnum++; - } - my $httphost=$ENV{'HTTP_HOST'}; - - my $viewselect; - if ($mode eq 'Basic') { - $viewselect=$ENV{'form.basicviewselect'}; - } - elsif ($mode eq 'Advanced') { - $viewselect=$ENV{'form.advancedviewselect'}; - } - - if ($viewselect eq 'Detailed Citation View') { - $compiledresult.=&detailed_citation_view(@fields, - $hostname,$httphost, - $extrashow2); - } - elsif ($viewselect eq 'Summary View') { - $compiledresult.=&summary_view(@fields,$hostname,$httphost, - $extrashow2); - } - elsif ($viewselect eq 'Fielded Format') { - $compiledresult.=&fielded_format_view(@fields,$hostname, - $httphost,$extrashow2); - } - elsif ($viewselect eq 'XML/SGML') { - $compiledresult.=&xml_sgml_view(@fields,$hostname,$httphost, - $extrashow2); - } - - } +###################################################################### +###################################################################### +sub search_status_header { + return <Search Status +$bodytag +

Search Status

+Sending search request to LON-CAPA servers.
+ENDSTATUS +} - untie %hash; - } - else { - $r->print('Unable to tie hash to db '. - 'file'); - } - if ($compiledresult) { - $resultflag=1; - } +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; +} - $r->print(<print("\nThere were no results that matched your query\n"); - } -# $r->print(''."\n"); $r->rflush(); - $r->print(< +###################################################################### +###################################################################### +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 + + + + + -RESULTS +ENDFRAMES + + $r->print($result); + return; } -# ------------------------------------------------------ Detailed Citation View +###################################################################### +###################################################################### + +=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 ($title,$author,$subject,$url,$keywords,$version, - $notes,$shortabstract,$mime,$lang, - $creationdate,$lastrevisiondate,$owner,$copyright, - $hostname,$httphost,$extrashow)=@_; + my ($prefix,%values) = @_; my $result=<$owner, last revised $lastrevisiondate -

$title

-

$author

-

+$prefix$values{'title'}

-Subject: $subject
-Keyword(s): $keywords
-Notes: $notes
-MIME Type: -END - $result.=&Apache::loncommon::filedescription($mime); - $result.=< -Language: -END - $result.=&Apache::loncommon::languagedescription($lang); - $result.=< -Copyright/Distribution: -END - $result.=&Apache::loncommon::copyrightdescription($copyright); - $result.=< +$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'}

-$extrashow +$values{'extrashow'}

-$shortabstract +$values{'shortabstract'}

+
END return $result; } -# ---------------------------------------------------------------- Summary View +###################################################################### +###################################################################### + +=pod + +=item &summary_view() + +=cut +###################################################################### +###################################################################### sub summary_view { - my ($title,$author,$subject,$url,$keywords,$version, - $notes,$shortabstract,$mime,$lang, - $creationdate,$lastrevisiondate,$owner,$copyright, - $hostname,$httphost,$extrashow)=@_; - my $cprtag=&Apache::loncommon::copyrightdescription($copyright); + my ($prefix,%values) = @_; my $result=<$author
-$title
-$owner -- $lastrevisiondate
-$cprtag
-$extrashow +$prefix$values{'author'}
+$values{'title'}
+$values{'owner'} -- $values{'lastrevisiondate'}
+$values{'copyrighttag'}
+$values{'extrashow'}

+
END return $result; } -# -------------------------------------------------------------- Fielded Format +###################################################################### +###################################################################### + +=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 ($title,$author,$subject,$url,$keywords,$version, - $notes,$shortabstract,$mime,$lang, - $creationdate,$lastrevisiondate,$owner,$copyright, - $hostname,$httphost,$extrashow)=@_; - my $mimetag=&Apache::loncommon::filedescription($mime); - my $language=&Apache::loncommon::languagedescription($lang); - my $cprtag=&Apache::loncommon::copyrightdescription($copyright); + my ($prefix,%values) = @_; my $result=<URL: $url +$prefix +URL: $values{'url'}
-Title: $title
-Author(s): $author
-Subject: $subject
-Keyword(s): $keywords
-Notes: $notes
-MIME Type: $mimetag
-Language: $language
-Creation Date: $creationdate
-Last Revision Date: $lastrevisiondate
-Publisher/Owner: $owner
-Copyright/Distribution: $cprtag
-Repository Location: $hostname
-Abstract: $shortabstract
-$extrashow +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; } -# -------------------------------------------------------------------- XML/SGML +###################################################################### +###################################################################### + +=pod + +=item &xml_sgml_view() + +=back + +=cut + +###################################################################### +###################################################################### sub xml_sgml_view { - my ($title,$author,$subject,$url,$keywords,$version, - $notes,$shortabstract,$mime,$lang, - $creationdate,$lastrevisiondate,$owner,$copyright, - $hostname,$httphost,$extrashow)=@_; - my $cprtag=&Apache::loncommon::copyrightdescription($copyright); - my $mimetag=&Apache::loncommon::filedescription($mime); - my $language=&Apache::loncommon::languagedescription($lang); + my ($prefix,%values) = @_; my $result=< <LonCapaResource> -<url>$url</url> -<title>$title</title> -<author>$author</author> -<subject>$subject</subject> -<keywords>$keywords</keywords> -<notes>$notes</notes> +<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>$mime</mime> -<mimetag>$mimetag</mimetag> +<mime>$values{'mime'}</mime> +<mimetag>$values{'mimetag'}</mimetag> </mimeInfo> <languageInfo> -<language>$lang</language> -<languagetag>$language</languagetag> +<language>$values{'lang'}</language> +<languagetag>$values{'language'}</languagetag> </languageInfo> -<creationdate>$creationdate</creationdate> -<lastrevisiondate>$lastrevisiondate</lastrevisiondate> -<owner>$owner</owner> +<creationdate>$values{'creationdate'}</creationdate> +<lastrevisiondate>$values{'lastrevisiondate'}</lastrevisiondate> +<owner>$values{'owner'}</owner> <copyrightInfo> -<copyright>$copyright</copyright> -<copyrighttag>$cprtag</copyrighttag> +<copyright>$values{'copyright'}</copyright> +<copyrighttag>$values{'copyrighttag'}</copyrighttag> </copyrightInfo> -<repositoryLocation>$hostname</repositoryLocation> -<shortabstract>$shortabstract</shortabstract> +<repositoryLocation>$values{'hostname'}</repositoryLocation> +<shortabstract>$values{'shortabstract'}</shortabstract> </LonCapaResource> -$extrashow +$values{'extrashow'} +
END return $result; } -# ---------------------------------------------------- see if a field is filled +###################################################################### +###################################################################### + +=pod + +=item &filled() see if field is filled. + +=cut + +###################################################################### +###################################################################### sub filled { my ($field)=@_; if ($field=~/\S/ && $field ne 'any') { @@ -1477,12 +2973,29 @@ sub filled { } } -# ---------------- Message to output when there are not enough fields filled in +###################################################################### +###################################################################### + +=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)=@_; + my ($r,$closebutton,$parms)=@_; # make query information persistent to allow for subsequent revision - my $persistent=&make_persistent(); - $r->print(< @@ -1490,50 +3003,63 @@ sub output_blank_field_error { BEGINNING $r->print(< - +$bodytag

Search Catalog

-$persistent - +$hidden_fields +Revise search request  $closebutton
-

Helpful Message

+

Unactionable search query.

-Incorrect search query due to blank entry fields. -You need to fill in the relevant -fields on the search page in order for a query to be -processed. +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 } -# ----------------------------------------------------------- Output date error +###################################################################### +###################################################################### + +=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)=@_; + my ($r,$message,$closebutton)=@_; # make query information persistent to allow for subsequent revision - my $persistent=&make_persistent(); - - $r->print(<print(< The LearningOnline Network with CAPA -BEGINNING - $r->print(< - +$bodytag

Search Catalog

-$persistent +$hidden_fields $closebutton
-

Helpful Message

+

Error

$message

@@ -1542,241 +3068,49 @@ $message RESULTS } -# --------- settings whenever the user causes the search window to be launched +###################################################################### +###################################################################### + +=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 $hash{'mode_catalog'}; - foreach (keys %hash) { + delete $groupsearch_db{'mode_catalog'}; + foreach (keys %groupsearch_db) { if ($_ =~ /^pre_/) { - delete $hash{$_}; + delete $groupsearch_db{$_}; } if ($_ =~ /^store/) { - delete $hash{$_}; + delete $groupsearch_db{$_}; } } } -# ----------------------------------------------- send javascript to popwin -sub popwin_js { - # Print javascript out to popwin, but make sure we dont generate - # any javascript errors in doing so. - my ($r,$text) = @_; - $r->print(<<"END"); - -END - $r->rflush(); + &untiehash(); + &Apache::lonmysql::disconnect_from_db(); } -sub popwin_imgupdate { - my ($r,$imgnum,$icon) = @_; - &popwin_js($r,'popwin.document.img'.$imgnum.'.'. - 'src="/adm/lonIcons/'.$icon.'";'); -} - -1; - __END__ =pod =back -=over 4 - -=head1 HANDLER SUBROUTINE - -This routine is called by Apache and mod_perl. - -=over 4 - -=item * - -configure dynamic components of interface - -=item * - -determine current user - -=item * - -see if a search invocation should be done - -=item * - -else, begin building search interface to output - -=item * - -compute date selection boxes - -=item * - -compute customized metadata field - -=item * - -print screen - -=back - -=head1 OTHER SUBROUTINES - -=over 4 - -=item * - -get_unprocessed_cgi() : reads in critical name/value pairs that may have not -been processed and passed into %ENV by the web server - -=item * - -make_persistent() : makes a set of hidden HTML fields to make -SQL search interface information to be persistent - -=back - -WEB INTERFACE COMPONENT FUNCTIONS - -=over 4 - -=item * - -simpletextfield(name,value) : returns HTML formatted string for simple text -field - -=item * - -simplecheckbox(name,value) : returns HTML formatted string for simple -checkbox - -=item * - -searchphrasefield(title,name,value) : returns HTML formatted string for -a search expression phrase field - -=item * - -dateboxes(name, defaultmonth, defaultday, defaultyear) : returns HTML -formatted string for a calendar date - -=item * - -selectbox(title,name,value,%HASH=options) : returns HTML formatted string for -a selection box field - -=back - -SEARCH FUNCTIONS - -=over 4 - -=item * - -advancedsearch(server reference, environment reference) : perform a complex -multi-field logical query - -=item * - -basicsearch(server reference, environment reference) : perform a simple -single-field logical query - -=item * - -build_SQL_query(field name, logic) : builds a SQL query string from a -logical expression with AND/OR keywords - -=item * - -build_custommetadata_query(field_name, logic_statement) : builds a perl -regular expression from a logical expression with AND/OR keywords - -=item * - -recursive_SQL_query_build(field name, reverse notation expression) : -builds a SQL query string from a reverse notation expression -logical expression with AND/OR keywords - -=item * - -build_date_queries(cmonth1, cday1, cyear1, cmonth2, cday2, cyear2, -lmonth1, lday1, lyear1, lmonth2, lday2, lyear2) : -Builds a SQL logic query to check time/date entries. - -=back - -OUTPUTTING RESULTS FUNCTION - -=over 4 - -=item * - -output_results(output mode, server reference, environment reference, -reply list reference) : outputs results from search - -=back - -DIFFERENT WAYS TO VIEW METADATA RECORDS - -=over 4 - -=item * - -detailed_citation_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) : -see metadata viewing notes below - -=item * - -summary_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) : -see metadata viewing notes below - -=item * - -fielded_format_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) : -see metadata viewing notes below - -=item * - -xml_sgml_view(ORDERED METADATA LIST FOR A RESULT OBJECT INSTANCE) : -see metadata viewing notes below - -=back - - _____________________________________________________________________ - | * Metadata viewing notes | - | Output is a HTML-ified string. | - | Input arguments are title, author, subject, url, keywords, version, | - | notes, short abstract, mime, language, creation date, | - | last revision date, owner, copyright, hostname, httphost, and | - | extra custom metadata to show. | - --------------------------------------------------------------------- - -TEST CONDITIONAL FUNCTIONS - -=over 4 - -=item * - -filled(field) : determines whether a given field has been filled - -=back - -ERROR FUNCTIONS - -=over 4 - -=item * - -output_blank_field_error(server reference) : outputs a message saying that -more fields need to be filled in - -=item * - -output_date_error(server reference, error message) : outputs -an error message specific to bad date format. - -=back - =cut