--- loncom/interface/lonsearchcat.pm 2002/06/19 20:39:11 1.123 +++ loncom/interface/lonsearchcat.pm 2002/07/26 16:37:58 1.144 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Search Catalog # -# $Id: lonsearchcat.pm,v 1.123 2002/06/19 20:39:11 matthew Exp $ +# $Id: lonsearchcat.pm,v 1.144 2002/07/26 16:37:58 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -40,7 +40,7 @@ =head1 NAME -lonsearchcat +lonsearchcat - LONCAPA Search Interface =head1 SYNOPSIS @@ -67,14 +67,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 ## ## ## ############################################################################### @@ -87,8 +87,10 @@ use Apache::lonnet(); use Apache::File(); use CGI qw(:standard); use Text::Query; +use DBI; use GDBM_File; use Apache::loncommon(); +use Apache::lonmysql(); # ---------------------------------------- variables used throughout the module @@ -101,46 +103,33 @@ 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 +button to take the select results and go to group sorting -=item $hidden - -holds 'hidden' html forms +=item %groupsearch_db -=item $scrout +Database hash used to save values for the groupsearch RAT interface. -string that holds portions of the screen output - -=item $yourself +=item $diropendb -allows for quickly limiting to oneself +The full path to the (temporary) search database file. This is set and +used in &handler() and is also used in &output_results(). -=item %hash +=item %Views -The ubiquitous database hash +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 $results_db -The full path to the (temporary) search database file. This is set and -used in &handler() and is also used in &output_results(). +The name of the database results from searches are put in. =back @@ -149,101 +138,92 @@ 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 - -#------------------------------------------------------------- global variables -my $diropendb = ""; -my $domain = ""; +my %groupsearch_db; # database hash +my $diropendb = ""; # db file -# ----------------------------------------------------------------------- BEGIN +my $results_db = ""; +# 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 ); -=pod +###################################################################### +###################################################################### -=item BEGIN block +=pod -Load %hostdomains and %hostips with data from lonnet.pm. Only library -servers are considered. +=item &handler() - main handler invoked by httpd child -=cut +=item Variables -BEGIN { - foreach (keys (%Apache::lonnet::libserv)) { - $hostdomains{$_}=$Apache::lonnet::hostdom{$_}; - $hostips{$_}=$Apache::lonnet::hostip{$_}; - } -} +=over 4 -###################################################################### -###################################################################### +=item $hidden -=pod +holds 'hidden' html forms -=item &handler() - main handler invoked by httpd child +=item $scrout + +string that holds portions of the screen output + +=back =cut ###################################################################### ###################################################################### -# ----------------------------- Handling routine called via Apache and mod_perl sub handler { my $r = shift; - untie %hash; + untie %groupsearch_db; $r->content_type('text/html'); $r->send_http_header; return OK if $r->header_only; - + ## + ## 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"; - + $results_db = "/home/httpd/perl/tmp/".&Apache::lonnet::escape($domain). + '_'.&Apache::lonnet::escape($ENV{'user.name'})."_searchresults.db"; &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, - ['catalogmode','launch','acts','mode','form','element']); - + ['catalogmode','launch','acts','mode','form','element', + 'reqinterface']); + ## + ## Clear out old values from groupsearch database + ## if ($ENV{'form.launch'} eq '1') { - if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { + if (tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { &start_fresh_session(); - untie %hash; + untie %groupsearch_db; } else { $r->print('Unable to tie hash to db '. 'file'); return OK; } } - -# --------------------------- Produce some output, so people know it is working - + ## + ## Produce some output, so people know it is working + ## $r->print("\n"); $r->rflush; - -# ----------------------------------- configure dynamic components of interface - + ## + ## Configure dynamic components of interface + ## + my $hidden; # Holds 'hidden' html forms if ($ENV{'form.catalogmode'} eq 'interactive') { $hidden="". "\n"; $closebutton=""."\n"; - } - elsif ($ENV{'form.catalogmode'} eq 'groupsearch') { + } elsif ($ENV{'form.catalogmode'} eq 'groupsearch') { $hidden=< END @@ -255,69 +235,246 @@ END onClick='javascript:select_group()'> END } - $hidden .= < - - - -END -# ------------------------------------------------------ Determine current user - $yourself=$ENV{'user.name'}.'@'.$ENV{'user.domain'}; - -# --- 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 + $hidden .= &make_persistent({ "form.mode" => $ENV{'form.mode'}, + "form.form" => $ENV{'form.form'}, + "form.element" => $ENV{'form.element'}, + "form.date" => 2 }); + ## + ## What are we doing? + ## + my $searchtype; + $searchtype = 'Basic' if ($ENV{'form.basicsubmit'} eq 'SEARCH'); + $searchtype = 'Advanced' if ($ENV{'form.advancedsubmit'} eq 'SEARCH'); + if ($searchtype) { + # We are running a search + my ($query,$customquery,$customshow,$libraries) = + (undef,undef,undef,undef); + my $pretty_string; + if ($searchtype eq 'Basic') { + ($query,$pretty_string) = &parse_basic_search($r); + } elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') { + ($query,$customquery,$customshow,$libraries,$pretty_string) + = &parse_advanced_search($r); + return OK if (! defined($query)); + } + # Output some information to the user. + $r->print(&search_results_header($searchtype,$pretty_string)); + $r->print("Sending search request to LON-CAPA servers.
\n"); + $r->rflush(); + &run_search($r,$query,$customquery,$customshow,$libraries); + &display_results($r,$searchtype,$hidden,$importbutton, + $closebutton); -# ----------------------------------- See if a search invocation should be done - if ($ENV{'form.basicsubmit'} eq 'SEARCH') { - untie %hash; return &basicsearch($r,\%ENV); - } - elsif ($ENV{'form.advancedsubmit'} eq 'SEARCH') { - untie %hash; return &advancedsearch($r,\%ENV); + $r->rflush(); + } else { + # + # We need to get information to search on + # + # Set the default view if it is not already set. + if (!defined($ENV{'form.viewselect'})) { + $ENV{'form.viewselect'} ="Detailed Citation View"; + } + # Output the advanced interface + if ($ENV{'form.reqinterface'} eq 'advanced') { + $r->print(&advanced_search_form($closebutton,$hidden)); + } else { + # Output normal search interface + $r->print(&basic_search_form($closebutton,$hidden)); + } } + return OK; +} + +###################################################################### +###################################################################### + +=pod -# ----------------------------- Else, begin building search interface to output - $scrout=''; # building a part of screen output - $scrout.=&searchphrasefield('Limit by title','title', - $ENV{'form.title'}); +=item &basic_search_form() - $scrout.=&searchphrasefield('Limit by author','author', - $ENV{'form.author'}); +Returns a scalar which holds html for the basic search form. - $scrout.=&searchphrasefield('Limit by subject','subject', - $ENV{'form.subject'}); +=cut - $scrout.=&searchphrasefield('Limit by keywords','keywords', - $ENV{'form.keywords'}); +###################################################################### +###################################################################### - $scrout.=&searchphrasefield('Limit by URL','url', - $ENV{'form.url'}); +sub basic_search_form{ + my ($closebutton,$hidden) = @_; + my $scrout=<<"ENDDOCUMENT"; + + +The LearningOnline Network with CAPA + + + + +

Search Catalog

+
+$hidden +

Basic Search

+

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

+

+ + + +
+ENDDOCUMENT + $scrout.=' '.&simpletextfield('basicexp',$ENV{'form.basicexp'},40). + ' '; +# $scrout.=&simplecheckbox('allversions',$ENV{'form.allversions'}); +# $scrout.='Search historic archives'; + 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.=< +

+
+ + +ENDDOCUMENT + return $scrout; +} +###################################################################### +###################################################################### -# $scrout.=&searchphrasefield('Limit by version','version', -# $ENV{'form.version'}); +=pod - $scrout.=&searchphrasefield('Limit by notes','notes', - $ENV{'form.notes'}); +=item &advanced_search_form() - $scrout.=&searchphrasefield('Limit by abstract','abstract', - $ENV{'form.abstract'}); +Returns a scalar which holds html for the advanced search form. - $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)); +=cut - $ENV{'form.language'}='any' unless length($ENV{'form.language'}); +###################################################################### +###################################################################### +sub advanced_search_form{ + my ($closebutton,$hidden) = @_; + my $advanced_buttons = <<"END"; +

+ + +$closebutton + +

+END + if (!defined($ENV{'form.viewselect'})) { + $ENV{'form.viewselect'} ="Detailed Citation View"; + } + my $scrout=<<"ENDHEADER"; + + +The LearningOnline Network with CAPA + + + + +

Advanced Catalog Search

+
+Enter terms or phrases separated by search operators +such as AND, OR, or NOT.
+
+$advanced_buttons +$hidden + + +\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','mime', + $ENV{'form.mime'}); + $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.="Related
Words
   
   
\n"; + $ENV{'form.category'}='any' unless length($ENV{'form.category'}); + $scrout.=&selectbox('File Category','category', + $ENV{'form.category'}, + 'any','Any category', + undef, + (&Apache::loncommon::filecategories())); + $ENV{'form.language'}='any' unless length($ENV{'form.language'}); + #---------------------------------------------------------------- + # Allow restriction to multiple domains. + # I make the crazy assumption that there will never be a domain 'any'. + # + $ENV{'form.domains'} = 'any' if (! exists($ENV{'form.domains'})); + my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}} + : ($ENV{'form.domains'}) ); + my %domain_hash = (); + foreach (@allowed_domains) { + $domain_hash{$_}++; + } + my @domains =&Apache::loncommon::get_domains(); + # adjust the size of the select box + my $size = 4; + my $size = (scalar @domains < ($size - 1) ? scalar @domains + 1 : $size); + # standalone machines do not get to choose a domain to search. + if ((scalar @domains) == 1) { + $scrout .=''."\n"; + } else { + $scrout.="\n".''. + 'DOMAINS
'. + '\n"; + } + #---------------------------------------------------------------- $scrout.=&selectbox('Limit by language','language', $ENV{'form.language'},'any','Any Language', \&{Apache::loncommon::languagedescription}, (&Apache::loncommon::languageids), ); - # ------------------------------------------------ Compute date selection boxes $scrout.=< @@ -331,16 +488,13 @@ CREATIONDATESTART $ENV{'form.creationdatestart_day'}, $ENV{'form.creationdatestart_year'}, ); - $scrout.=< LIMIT BY LAST REVISION DATE RANGE: @@ -361,10 +515,6 @@ 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'}, @@ -372,7 +522,6 @@ LASTREVISIONDATEEND \&{Apache::loncommon::copyrightdescription}, (&Apache::loncommon::copyrightids), ); - # ------------------------------------------- Compute customized metadata field $scrout.=< @@ -383,9 +532,7 @@ For resource-specific metadata, enter in 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.=&simpletextfield('custommetadata',$ENV{'form.custommetadata'}); $scrout.=< SHOW SPECIAL METADATA FIELDS: @@ -394,82 +541,15 @@ Enter in a space-separated list of speci 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 - - - - -

-
-

Advanced Search

-$scrout -

- - -$closebutton - - - - -

+ $scrout.=&simpletextfield('customshow',$ENV{'form.customshow'}); + $scrout.=< ENDDOCUMENT - return OK; -} + return $scrout; +} ###################################################################### ###################################################################### @@ -479,7 +559,8 @@ ENDDOCUMENT =item &make_persistent() Returns a scalar which holds the current ENV{'form.*'} values in -a 'hidden' html input tag. +a 'hidden' html input tag. This allows search interface information +to be somewhat persistent. =cut @@ -487,24 +568,26 @@ a 'hidden' html input tag. ###################################################################### sub make_persistent { + my %save = %{shift()}; my $persistent=''; - - foreach (keys %ENV) { - if (/^form\./ && !/submit/) { - my $name=$_; - my $key=$name; - $ENV{$key}=~s/\'//g; # do not mess with html field syntax + foreach my $name (keys %save) { + if ($name =~ /^form\./ && $name !~ /submit/) { + my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name})); $name=~s/^form\.//; - $persistent.=< + foreach (@values) { + s/\"/\'/g; # do not mess with html field syntax + next if (! $_ ); + $persistent.=< END + } } } return $persistent; } - ###################################################################### +# HTML form building functions # ###################################################################### =pod @@ -513,6 +596,13 @@ END =over 4 +=cut + +############################################### +############################################### + +=pod + =item &simpletextfield() Inputs: $name,$value,$size @@ -520,6 +610,23 @@ Inputs: $name,$value,$size Returns a text input field with the given name, value, and size. If size is not specified, a value of 20 is used. +=cut + +############################################### +############################################### + +sub simpletextfield { + my ($name,$value,$size)=@_; + $size = 20 if (! defined($size)); + return ''; +} + +############################################### +############################################### + +=pod + =item &simplecheckbox() Inputs: $name,$value @@ -527,51 +634,107 @@ Inputs: $name,$value Returns a simple check box with the given $name. If $value eq 'on' the box is checked. -=item &searchphrasefield() +=cut -Inputs: $title,$name,$value +############################################### +############################################### -Returns html for a title line and an input field for entering search terms. -the instructions "Enter terms or phrases separated by search operators such -as AND, OR, or NOT." are given following the title. The entry field (which -is where the $name and $value are used) is an 80 column simpletextfield. +sub simplecheckbox { + my ($name,$value)=@_; + my $checked=''; + $checked="checked" if $value eq 'on'; + return ''; +} -=item &dateboxes() +############################################### +############################################### -=item &selectbox() +=pod -=back +=item &fieldtitle() + +Input: $title + +Returns a scalar with html which will display $title as a search +field heading. =cut -###################################################################### -###################################################################### +############################################### +############################################### -sub simpletextfield { - my ($name,$value,$size)=@_; - $size = 20 if (! defined($size)); - return ''; +sub fieldtitle { + my $title = uc(shift()); + return ''.$title. + ': '; } -sub simplecheckbox { - my ($name,$value)=@_; - my $checked=''; - $checked="CHECKED" if $value eq 'on'; - return ''; -} +############################################### +############################################### + +=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
".&simpletextfield($name,$value,80); + 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)=@_; @@ -616,39 +779,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 = ". + &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'}, @@ -717,48 +993,69 @@ sub advancedsearch { # Test to see if date windows are legitimate if ($datequery=~/^Incorrect/) { &output_date_error($r,$datequery); - return OK; - } - elsif ($datequery) { + 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=''; + 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=''; + 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); } - # 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). + ## --------------------------------------------------------------- + ## Deal with restrictions to given domains + ## + my $libraries_to_query = undef; + # $ENV{'form.domains'} can be either a scalar or an array reference. + # We need an array. + my @allowed_domains = (ref($ENV{'form.domains'}) ? @{$ENV{'form.domains'}} + : ($ENV{'form.domains'}) ); + my %domain_hash = (); + my $pretty_domains_string; + foreach (@allowed_domains) { + $domain_hash{$_}++; + } + if ($domain_hash{'any'}) { + $pretty_domains_string = "Searching all domains."; + } else { + if (@allowed_domains > 1) { + $pretty_domains_string = "Searching domains:"; + } else { + $pretty_domains_string = "Searching 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.'; + return ($query,$customquery,$customshow,$libraries_to_query, + $pretty_search_string); } ###################################################################### @@ -766,15 +1063,16 @@ sub advancedsearch { =pod -=item &basicsearch() +=item &parse_basic_search() + +Parse the basic search form and return a scalar containing an sql query. =cut ###################################################################### ###################################################################### -sub basicsearch { - my ($r,$envhash)=@_; - my %ENV=%{$envhash}; +sub parse_basic_search { + my ($r)=@_; # Clean up fields for safety for my $field ('basicexp') { $ENV{"form.$field"}=~s/[^\w\s\(\)\-]//g; @@ -791,25 +1089,61 @@ sub basicsearch { &output_blank_field_error($r); 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)); +} ###################################################################### ###################################################################### @@ -818,6 +1152,9 @@ sub basicsearch { =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 ###################################################################### @@ -840,14 +1177,15 @@ sub build_SQL_query { =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)=@_; - &Apache::lonnet::logthis("Entered build_custommetadata_query:". - $field_name.':'.$logic_statement); my $q=new Text::Query('abc', -parse => 'Text::Query::ParseAdvanced', -build => 'Text::Query::BuildAdvancedString'); @@ -862,7 +1200,6 @@ sub build_custommetadata_query { \*$2\[\^\\<\]?# *wordtwo[^\<] \*\\<\\\/$1\\>?# *\<\/wordone\> /g; - &Apache::lonnet::logthis("match expression: ".$matchexp); return $matchexp; } @@ -873,6 +1210,8 @@ sub build_custommetadata_query { =item &recursive_SQL_query_build() +Recursively constructs an SQL query. Takes as input $dkey and $pattern. + =cut ###################################################################### @@ -917,6 +1256,9 @@ sub recursive_SQL_query_build { =item &build_date_queries() +Builds a SQL logic query to check time/date entries. +Also reports errors (check for /^Incorrect/). + =cut ###################################################################### @@ -972,6 +1314,400 @@ sub build_date_queries { ###################################################################### ###################################################################### +=pod + +=item ©right_check() + +=cut + +###################################################################### +###################################################################### + +sub copyright_check { + my $Metadata = shift; + # Check copyright tags and skip results the user cannot use + my (undef,undef,$resdom,$resname) = split('/', + $Metadata->{'url'}); + # Check for priv + if (($Metadata->{'copyright'} eq 'priv') && + (($ENV{'user.name'} ne $resname) && + ($ENV{'user.domain'} ne $resdom))) { + return 0; + } + # Check for domain + if (($Metadata->{'copyright'} eq 'domain') && + ($ENV{'user.domain'} ne $resdom)) { + return 0; + } + return 1; +} + +##################################################################### +##################################################################### + +=pod + +=item MySQL Table Description + +MySQL table creation requires a precise description of the data to be +stored. The use of the correct types to hold data is vital to efficient +storage and quick retrieval of records. The columns must be described in +the following format: + +=cut + +## +## Restrictions: +## columns of type 'text' and 'blob' cannot have defaults. +## columns of type 'enum' cannot be used for FULLTEXT. +## +my @DataOrder = qw/id title author subject url keywords version notes + abstract mime lang owner copyright creationdate lastrevisiondate hostname + idx_title idx_author idx_subject idx_abstract idx_mime idx_language + idx_owner idx_copyright/; + +my %Datatypes = + ( id =>{ type => 'INT', + restrictions => 'NOT NULL', + primary_key => 'yes', + auto_inc => 'yes' + }, + title =>{ type=>'TEXT'}, + author =>{ type=>'TEXT'}, + subject =>{ type=>'TEXT'}, + url =>{ type=>'TEXT', + restrictions => 'NOT NULL' }, + keywords =>{ type=>'TEXT'}, + version =>{ type=>'TEXT'}, + notes =>{ type=>'TEXT'}, + abstract =>{ type=>'TEXT'}, + mime =>{ type=>'TEXT'}, + lang =>{ type=>'TEXT'}, + owner =>{ type=>'TEXT'}, + copyright =>{ type=>'TEXT'}, + hostname =>{ type=>'TEXT'}, + #-------------------------------------------------- + creationdate =>{ type=>'DATETIME'}, + lastrevisiondate =>{ type=>'DATETIME'}, + #-------------------------------------------------- + idx_title =>{ type=>'FULLTEXT', target=>'title'}, + idx_author =>{ type=>'FULLTEXT', target=>'author'}, + idx_subject =>{ type=>'FULLTEXT', target=>'subject'}, + idx_abstract =>{ type=>'FULLTEXT', target=>'abstract'}, + idx_mime =>{ type=>'FULLTEXT', target=>'mime'}, + idx_language =>{ type=>'FULLTEXT', target=>'lang'}, + idx_owner =>{ type=>'FULLTEXT', target=>'owner'}, + idx_copyright =>{ type=>'FULLTEXT', target=>'copyright'}, + ); + +###################################################################### +###################################################################### + +=pod + +=item &write_status() + +=cut + +###################################################################### +###################################################################### +sub write_status { + my ($r,$string) = @_; + $r->print("
".$string."
\n"); + $r->rflush(); + return; +} + +###################################################################### +###################################################################### + +=pod + +=item &run_search + +=cut + +###################################################################### +###################################################################### +sub run_search { + my ($r,$query,$customquery,$customshow,$serverlist) = @_; + # + my @Servers_to_contact; + if (defined($serverlist)) { + @Servers_to_contact = @$serverlist; + } else { + @Servers_to_contact = sort(keys(%Apache::lonnet::libserv)); + } + my %Server_status; + # + # Timing variables + my $starttime = time; + my $max_time = 120; # seconds for the search to complete + # + # Create Table + ##################################### + my $table = &Apache::lonmysql::create_table + ( { columns => \%Datatypes, + column_order => \@DataOrder, + } ); + if (! defined($table)) { + # What do I do now? Print out an error page. + &Apache::lonnet::logthis("lonmysql attempted to create a table ". + "and this was the result:". + &Apache::lonmysql::get_error()); + $r->print("An internal error occured with the database.
". + "The error has been logged, but you should probably alert". + " your system administrator."); + return; + } + $ENV{'form.table'}=$table; + # + ##################################### + my $hitcountsum; + my $server; + my $status; + while ((time - $starttime < $max_time) && + ((@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]); + # We should let the user know we have contacted another server + ($server) = keys(%$reply); + $Server_status{$server} = $reply->{$server}; + # &write_status($r,"Contacted:$server:reply:". + # $Server_status{$server}); + # Hmmm, should we add to $max_time if we contact a server? + } else { + sleep(1); # wait a sec. to give time for files to be written + } + while (my ($server,$status) = each(%Server_status)) { + if ($status eq 'con_lost') { + delete ($Server_status{$server}); + # &write_status($r,"Removing $server"); + next; + } + $status=~/^([\.\w]+)$/; + my $datafile=$r->dir_config('lonDaemons').'/tmp/'.$1; + if (-e $datafile && ! -e "$datafile.end") { + # Let the user know we are receiving data from the server + &write_status($r,"$server:Receiving file"); + next; + } + if (-e "$datafile.end") { + if (-z "$datafile") { + delete($Server_status{$server}); + next; + } + my $fh; + if (!($fh=Apache::File->new($datafile))) { + # Error opening file... + # Tell the user and exit...? + # Should I give up on opening it? + &write_status("Unable to open $datafile"); + next; + } + # Read in the whole file. + while (my $result = <$fh>) { + # 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)) { + &write_status($r,&Apache::lonmysql::get_error()); + } + # &write_status($r,&Apache::lonmysql::get_debug()); + $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}); + } + } + # Finished looping through the servers + } + &Apache::lonmysql::disconnect_from_db(); + # We have run out of time or run out of servers to talk to and + # results to get. + if ($hitcountsum > 0) { + $r->print("

Total results = $hitcountsum

"); + } + return; +} + +###################################################################### +###################################################################### +=pod + +=item &display_buttons + +=cut + +###################################################################### +###################################################################### +sub display_buttons { + my ($low,$high,$otherparms) = @_; + my $maxshow = 20; + my $lowest = ($low - $maxshow < 0 ? 0 : $low-$maxshow); + my $highest = $high + $maxshow; + my ($previous,$current,$next); + if ($lowest < $low) { + $previous = qq{prev}; + } else { + $previous = "prev"; + } + $current = qq{reload}; + $next = qq{next}; + my $result = $previous." ".$current." ".$next; + return $result; +} +###################################################################### +###################################################################### + +=pod + +=item &display_results + +=cut + +###################################################################### +###################################################################### +sub display_results { + my ($r,$mode,$hidden,$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; + } + ## + ## make query information persistent to allow for subsequent revision + ## + my $persistent=&make_persistent(\%ENV); + ## + ## Get the catalog controls setup + ## + my $action = "/adm/searchcat"; + if ($mode eq 'Basic') { + $action .= "?reqinterface=basic"; + } elsif ($mode eq 'Advanced') { + $action .= "?reqinterface=advanced"; + } + $r->print(< +$hidden + + +$importbutton +$closebutton +$persistent +
+CATALOGCONTROLS + if (! tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { + $r->print('Unable to tie hash to db file'); + $r->rflush(); + return; + } + # + my $fnum; + # For now, just query the whole lot and spit them out. + my $table = $ENV{'form.table'}; + my $connection_result = &Apache::lonmysql::connect_to_db(); + if (!defined($connection_result)) { + &write_status($r,&Apache::lonmysql::get_error()); + } + my @Results = &Apache::lonmysql::get_rows($table,'id>=0'); + #&write_status($r,&Apache::lonmysql::get_debug()); + #&write_status($r,&Apache::lonmysql::get_error()); + foreach my $row (@Results) { + my %Fields = %{&parse_row(@$row)}; + my $output="\n

\n"; + if ($ENV{'form.catalogmode'} eq 'interactive') { + my $titleesc=$Fields{'title'}; + $titleesc=~s/\'/\\'/; # ' + if ($ENV{'form.catalogmode'} eq 'interactive') { + $output.=< + +
+END + } + } + if ($ENV{'form.catalogmode'} eq 'groupsearch') { + $fnum+=0; + $groupsearch_db{"pre_${fnum}_link"}=$Fields{'url'}; + $groupsearch_db{"pre_${fnum}_title"}=$Fields{'title'}; + $output.=< + + +
+END +# +# + $fnum++; + } + # Render the result into html + $output.= &$viewfunction(%Fields); + if ($output) { + $output.="

"; + } + $r->print($output); + $r->rflush(); + } + if (@Results < 1) { + $r->print("There were no results matching your query"); + } + $r->print(""); + $r->rflush(); + untie %groupsearch_db; + return; +} + +###################################################################### +###################################################################### + +=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 &output_results() @@ -987,31 +1723,406 @@ contacted, etc.) ###################################################################### ###################################################################### sub output_results { +# &Apache::lonnet::logthis("output_results:".time); my $fnum; # search result counter - my ($mode,$r,$envhash,$query,$replyref)=@_; - my %ENV=%{$envhash}; + my ($mode,$r,$replyref,$hidden)=@_; my %rhash=%{$replyref}; my $compiledresult=''; - my $timeremain=300; + my $timeremain=300; # (seconds) my $elapsetime=0; my $resultflag=0; my $tflag=1; - + ## + ## Set viewing function + ## + my $viewfunction = $Views{$ENV{'form.viewselect'}}; + if (!defined($viewfunction)) { + $r->print("Internal Error - Bad view selected.\n"); + $r->rflush(); + return; + } + # # make query information persistent to allow for subsequent revision - my $persistent=&make_persistent(); + my $persistent=&make_persistent(\%ENV); + # + # Begin producing output + $r->rflush(); + # + # begin showing the cataloged results + my $action = "/adm/searchcat"; + if ($mode eq 'Basic') { + $action .= "?reqinterface=basic"; + } elsif ($mode eq 'Advanced') { + $action .= "?reqinterface=advanced"; + } + $r->print(< +$hidden + + +$importbutton +$closebutton +$persistent +
+CATALOGCONTROLS + # + # make the pop-up window for status + $r->print(&make_popwin(%rhash)); + $r->rflush(); + ## + ## Prepare for the main loop below + ## + my $servercount=0; + my $hitcountsum=0; + my $servernum=(keys %rhash); + my $serversleft=$servernum; + ## + ## Run until we run out of time or we run out of servers + ## + while($serversleft && $timeremain) { + ## + ## %rhash has servers deleted from it as results come in + ## (within the foreach loop below). + ## + foreach my $rkey (sort keys %rhash) { +# &Apache::lonnet::logthis("Server $rkey:".time); + $servercount++; + $compiledresult=''; + my $reply=$rhash{$rkey}; + my @results; + if ($reply eq 'con_lost') { + &popwin_imgupdate($r,$rkey,"srvbad.gif"); + $serversleft--; + delete $rhash{$rkey}; + } else { + # must do since 'use strict' checks for tainting + $reply=~/^([\.\w]+)$/; + my $replyfile=$r->dir_config('lonDaemons').'/tmp/'.$1; + $reply=~/(.*?)\_/; + for (my $counter=0;$counter<2;$counter++) { + if (-e $replyfile && ! -e "$replyfile.end") { + &popwin_imgupdate($r,$rkey,"srvhalf.gif"); + &popwin_js($r,'popwin.hc["'.$rkey.'"]='. + '"still transferring..."'.';'); + } + # Are we finished transferring data? + if (-e "$replyfile.end") { + $serversleft--; + delete $rhash{$rkey}; + if (-s $replyfile) { + &popwin_imgupdate($r,$rkey,"srvgood.gif"); + my $fh; + unless ($fh=Apache::File->new($replyfile)){ + # Is it really appropriate to die on this error? + $r->print('ERROR: file '. + $replyfile.' cannot be opened'); + return OK; + } + @results=<$fh> if $fh; + my $hits =@results; + &popwin_js($r,'popwin.hc["'.$rkey.'"]='. + $hits.';'); + $hitcountsum+=$hits; + &popwin_js($r,'popwin.document.forms.popremain.'. + 'numhits.value='.$hitcountsum.';'); + } else { + &popwin_imgupdate($r,$rkey,"srvempty.gif"); + &popwin_js($r,'popwin.hc["'.$rkey.'"]=0;'); + } + last; + } # end of if ( -e "$replyfile.end") + last unless $timeremain; + sleep 1; # wait for daemons to write files? + $timeremain--; + $elapsetime++; + &popwin_js($r,"popwin.document.popremain.". + "elapsetime.value=$elapsetime;"); + } + &popwin_js($r,'popwin.document.whirly.'. + 'src="/adm/lonIcons/lonanimend.gif";'); + } # end of if ($reply eq 'con_lost') else statement + my %Fields = undef; # Holds the data to be sent to the various + # *_view routines. + my ($extrashow,$customfields,$customhash) = + &handle_custom_fields(\@results); + my @customfields = @$customfields; + my %customhash = %$customhash; + untie %groupsearch_db if (tied %groupsearch_db); + # + if (! tie(%groupsearch_db,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { + $r->print('Unable to tie hash to db '. + 'file'); + } else { + if ($ENV{'form.launch'} eq '1') { + &start_fresh_session(); + } + foreach my $result (@results) { + next if $result=~/^custom\=/; + chomp $result; + next unless $result; + %Fields = &parse_raw_result($result,$rkey); + # + # Check copyright tags and skip results the user cannot use + my (undef,undef,$resdom,$resname) = split('/',$Fields{'url'}); + # Check for priv + if (($Fields{'copyright'} eq 'priv') && + (($ENV{'user.name'} ne $resname) && + ($ENV{'user.domain'} ne $resdom))) { + next; + } + # Check for domain + if (($Fields{'copyright'} eq 'domain') && + ($ENV{'user.domain'} ne $resdom)) { + next; + } + # + $Fields{'extrashow'}=$extrashow; + if ($extrashow) { + foreach my $field (@customfields) { + my $value=''; + $value = $1 if ($customhash{$Fields{'url'}}=~/\<{$field}[^\>]*\>(.*?)\<\/{$field}[^\>]*\>/s); + $Fields{'extrashow'}=~s/\<\!\-\- $field \-\-\>/ $value/g; + } + } + $compiledresult.="\n

\n"; + if ($ENV{'form.catalogmode'} eq 'interactive') { + my $titleesc=$Fields{'title'}; + $titleesc=~s/\'/\\'/; # ' + $compiledresult.=< + +
+END + } + if ($ENV{'form.catalogmode'} eq 'groupsearch') { + $fnum+=0; + $groupsearch_db{"pre_${fnum}_link"}=$Fields{'url'}; + $groupsearch_db{"pre_${fnum}_title"}=$Fields{'title'}; + $compiledresult.=< + + +
+END +# +# + $fnum++; + } + # Render the result into html + $compiledresult.= &$viewfunction(%Fields, hostname => $rkey ); + if ($compiledresult or $servercount!=$servernum) { + $compiledresult.="

"; + } + } + untie %groupsearch_db; + } + if ($compiledresult) { + $resultflag=1; + $r->print($compiledresult); + } + } # End of foreach loop over servers remaining + } # End of big loop - while($serversleft && $timeremain) + unless ($resultflag) { + $r->print("\nThere were no results that matched your query\n"); + } + $r->print(''. + "\n"); + $r->print("\n\n"); + $r->rflush(); + return; +} + +########################################################### +########################################################### + +=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 ($mode,$pretty_query) = @_; + $mode = lc($mode); + my $title; + if ($mode eq 'advanced') { + $title = "Advanced Search Results"; + } elsif ($mode eq 'basic') { + $title = "Basic Search Results"; + } + my $result = ''; # output beginning of search page - $r->print(< -The LearningOnline Network with CAPA +$title BEGINNING - # 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); @@ -1033,7 +2144,7 @@ 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); @@ -1053,7 +2164,7 @@ function changeURL(val) { SCRIPT } } - $r->print(< function select_data(title,url) { // alert('DEBUG: Should be storing '+title+' and '+url); @@ -1073,7 +2184,7 @@ SCRIPT } SCRIPT - $r->print(< function displayinfo(val) { popwin.document.forms.popremain.sdetails.value=val; @@ -1088,79 +2199,65 @@ SCRIPT } SCRIPT - $r->rflush(); - - # begin showing the cataloged results - $r->print(< -

Search Catalog

-CATALOGBEGIN - $r->print(< -$hidden - - -$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 +

$title

+END + if ($pretty_query) { + $result .= "

Search query: $pretty_query

"; } - $r->print('

Search Results

'); - $r->rflush(); - my $servernum=(keys %rhash)+0; + return $result; +} + +###################################################################### +###################################################################### + +=pod - # define server grid (shows status of multiple machines) +=item &make_popwin() + +Returns html with javascript in it to open up the status window. + +=cut + +###################################################################### +###################################################################### +sub make_popwin { + my %rhash = @_; + my $servernum=(keys %rhash); my $hcinit; - my $grid="'
'+"; - $grid.="\n"; + my $grid="'
'+\n"; + # $sn is the server number, used ONLY to make sure we have + # rows of 10 each. No longer used to index images. my $sn=1; - for my $sk (sort keys %rhash) { - # ''+ $grid.="'+\"'\"+')\">'+"; $grid.="\n"; - $grid.="'\"".$sk."\"'+\n"; + $grid.="'\"".$sk.'+\n"; $grid.="'
'+\n" unless $sn%10; $sn++; } - $r->print(< popwin=open('','popwin','scrollbars=1,width=400,height=220'); popwin.focus(); @@ -1204,245 +2301,7 @@ RESULTS 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/\'/\\'/; # ' - - $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); - } - - } - - untie %hash; - } - else { - $r->print('Unable to tie hash to db '. - 'file'); - } - if ($compiledresult) { - $resultflag=1; - } - - $r->print(<print("\nThere were no results that matched your query\n"); - } -# $r->print(''."\n"); $r->rflush(); - $r->print(< - -RESULTS + return $result; } ###################################################################### @@ -1455,7 +2314,7 @@ RESULTS 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 +last revision date, owner, copyright, hostname, and extra custom metadata to show. =over 4 @@ -1467,38 +2326,23 @@ extra custom metadata to show. ###################################################################### ###################################################################### sub detailed_citation_view { - my ($title,$author,$subject,$url,$keywords,$version, - $notes,$shortabstract,$mime,$lang, - $creationdate,$lastrevisiondate,$owner,$copyright, - $hostname,$httphost,$extrashow)=@_; + my %values = @_; my $result=<$owner, last revised $lastrevisiondate -

$title

-

$author

-

+

$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; @@ -1516,17 +2360,14 @@ END ###################################################################### ###################################################################### 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 %values = @_; my $result=<$author
-$title
-$owner -- $lastrevisiondate
-$cprtag
-$extrashow +$values{'author'}
+$values{'title'}
+$values{'owner'} -- $values{'lastrevisiondate'}
+$values{'copyrighttag'}
+$values{'extrashow'}

END return $result; @@ -1544,30 +2385,25 @@ END ###################################################################### ###################################################################### 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 %values = @_; my $result=<URL: $url +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; @@ -1587,42 +2423,36 @@ END ###################################################################### ###################################################################### 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 %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; } @@ -1662,7 +2492,7 @@ sub filled { sub output_blank_field_error { my ($r)=@_; # make query information persistent to allow for subsequent revision - my $persistent=&make_persistent(); + my $persistent=&make_persistent(\%ENV); $r->print(< @@ -1708,7 +2538,7 @@ Output a full html page with an error me sub output_date_error { my ($r,$message)=@_; # make query information persistent to allow for subsequent revision - my $persistent=&make_persistent(); + my $persistent=&make_persistent(\%ENV); $r->print(< @@ -1740,7 +2570,7 @@ RESULTS =item &start_fresh_session() -Cleans the global %hash by removing all fields which begin with +Cleans the global %groupsearch_db by removing all fields which begin with 'pre_' or 'store'. =cut @@ -1748,13 +2578,13 @@ Cleans the global %hash by removing all ###################################################################### ###################################################################### 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{$_}; } } } @@ -1791,14 +2621,17 @@ END =item &popwin_imgupdate() +Send a given image (and its location) out to the browser. Takes as +input $r, loncapa server id, and an icon URL. + =cut ###################################################################### ###################################################################### sub popwin_imgupdate { - my ($r,$imgnum,$icon) = @_; - &popwin_js($r,'popwin.document.img'.$imgnum.'.'. - 'src="/adm/lonIcons/'.$icon.'";'); + my ($r,$server,$icon) = @_; + &popwin_js($r,'popwin.document.img_'.$Apache::lonnet::hostdom{$server}. + '_'.$server.'.'.'src="/adm/lonIcons/'.$icon.'";'); } 1; @@ -1809,199 +2642,4 @@ __END__ =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) : - - -=back - =cut