# The LearningOnline Network with CAPA # Search Catalog # # $Id: lonsearchcat.pm,v 1.214 2004/04/21 18:04:55 matthew Exp $ # # Copyright Michigan State University Board of Trustees # # This file is part of the LearningOnline Network with CAPA (LON-CAPA). # # LON-CAPA is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # LON-CAPA is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with LON-CAPA; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # /home/httpd/html/adm/gpl.txt # # http://www.lon-capa.org/ # ############################################################################### ############################################################################### =pod =head1 NAME lonsearchcat - LONCAPA Search Interface =head1 SYNOPSIS Search interface to LON-CAPAs digital library =head1 DESCRIPTION This module enables searching for a distributed browseable catalog. This is part of the LearningOnline Network with CAPA project described at http://www.lon-capa.org. lonsearchcat presents the user with an interface to search the LON-CAPA digital library. lonsearchcat also initiates the execution of a search by sending the search parameters to LON-CAPA servers. The progress of search (on a server basis) is displayed to the user in a separate window. =head1 Internals =over 4 =cut ############################################################################### ############################################################################### package Apache::lonsearchcat; use strict; 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(); use Apache::lonmeta; use Apache::lonhtmlcommon; use Apache::lonlocal; use LONCAPA::lonmetadata(); use HTML::Entities(); ###################################################################### ###################################################################### ## ## Global variables ## ###################################################################### ###################################################################### my %groupsearch_db; # Database hash used to save values for the # groupsearch RAT interface. my %persistent_db; # gdbm hash which holds data which is supposed to # persist across calls to lonsearchcat.pm # The different view modes and associated functions my %Views = ("detailed" => \&detailed_citation_view, "summary" => \&summary_view, "fielded" => \&fielded_format_view, "xml" => \&xml_sgml_view, "compact" => \&compact_view); ###################################################################### ###################################################################### sub handler { my $r = shift; # &set_defaults(); # # set form defaults # my $hidden_fields;# Hold all the hidden fields used to keep track # of the search system state my $importbutton; # button to take the selected results and go to group # sorting my $diropendb; # The full path to the (temporary) search database file. # This is set and used in &handler() and is also used in # &output_results(). my $bodytag; # LON-CAPA standard body tag, gotten from # &Apache::lonnet::bodytag. # No title, no table, just a tag. my $loaderror=&Apache::lonnet::overloaderror($r); if ($loaderror) { return $loaderror; } my $closebutton; # button that closes the search window # This button is different for the RAT compared to # normal invocation. # &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; return OK if $r->header_only; ## ## Prevent caching of the search interface window. Hopefully this means ## we will get the launch=1 passed in a little more. &Apache::loncommon::no_cache($r); ## ## Pick up form fields passed in the links. ## &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['catalogmode','launch','acts','mode','form','element','pause', 'phase','persistent_db_id','table','start','show', 'cleargroupsort','titleelement']); ## ## 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(1); delete($ENV{'form.pause'}); } ## ## Initialize global variables ## my $domain = $r->dir_config('lonDefDomain'); $diropendb= "/home/httpd/perl/tmp/". "$ENV{'user.domain'}_$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'; ## &Apache::lonhtmlcommon::clear_breadcrumbs(); if (exists($ENV{'request.course.id'}) && $ENV{'request.course.id'} ne '') { &Apache::lonhtmlcommon::add_breadcrumb ({href=>'/adm/searchcat?'. 'catalogmode='.$ENV{'form.catalogmode'}. '&launch='.$ENV{'form.launch'}. '&mode='.$ENV{'form.mode'}, text=>"Course and Catalog Search", bug=>'Searching',}); } else { &Apache::lonhtmlcommon::add_breadcrumb ({href=>'/adm/searchcat?'. 'catalogmode='.$ENV{'form.catalogmode'}. '&launch='.$ENV{'form.launch'}. '&mode='.$ENV{'form.mode'}, text=>"Catalog Search", bug=>'Searching',}); } # if (! &get_persistent_form_data($persistent_db_file)) { if ($ENV{'form.phase'} =~ /(run_search|results)/) { &Apache::lonnet::logthis("lonsearchcat:Unable to recover data ". "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 %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; } } ## ## 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.titleelement'})) { $hidden_fields .= ''."\n"; } if (exists($ENV{'form.mode'})) { $hidden_fields .= ''."\n"; } ## ## Configure dynamic components of interface ## if ($ENV{'form.catalogmode'} eq 'interactive') { $closebutton=" END } else { $closebutton = ''; $importbutton = ''; } ## ## Sanity checks on form elements ## if (!defined($ENV{'form.viewselect'})) { if (($ENV{'form.catalogmode'} eq 'groupsearch') || ($ENV{'form.catalogmode'} eq 'interactive')) { $ENV{'form.viewselect'} ="Compact View"; } else { $ENV{'form.viewselect'} ="Detailed Citation View"; } } $ENV{'form.phase'} = 'disp_basic' if (! exists($ENV{'form.phase'})); $ENV{'form.show'} = 20 if (! exists($ENV{'form.show'})); # $ENV{'form.searchmode'} = 'basic'; if ($ENV{'form.phase'} eq 'adv_search' || $ENV{'form.phase'} eq 'disp_adv') { $ENV{'form.searchmode'} = 'advanced'; } elsif ($ENV{'form.phase'} eq 'course_search') { $ENV{'form.searchmode'} = 'course_search'; } # if ($ENV{'form.searchmode'} eq 'advanced') { &Apache::lonhtmlcommon::add_breadcrumb ({href=>'/adm/searchcat?phase=disp_adv&'. 'catalogmode='.$ENV{'form.catalogmode'}. '&launch='.$ENV{'form.launch'}. '&mode='.$ENV{'form.mode'}, text=>"Advanced Search", bug=>'Searching',}); } elsif ($ENV{'form.searchmode'} eq 'course search') { &Apache::lonhtmlcommon::add_breadcrumb ({href=>'/adm/searchcat?phase=disp_adv&'. 'catalogmode='.$ENV{'form.catalogmode'}. '&launch='.$ENV{'form.launch'}. '&mode='.$ENV{'form.mode'}, text=>"Course Search", bug=>'Searching',}); } ## ## Switch on the phase ## if ($ENV{'form.phase'} eq 'disp_basic') { &print_basic_search_form($r,$closebutton,$hidden_fields); } elsif ($ENV{'form.phase'} eq 'disp_adv') { &print_advanced_search_form($r,$closebutton,$hidden_fields); } elsif ($ENV{'form.phase'} eq 'results') { &display_results($r,$importbutton,$closebutton,$diropendb); } 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')) { # Set up table if (! defined(&create_results_table())) { my $errorstring=&Apache::lonmysql::get_error(); &Apache::lonnet::logthis('lonsearchcat.pm: Unable to create '. 'needed table. lonmysql error:'. $errorstring); $r->print(<Search Error $bodytag Unable to create table in which to store search results. The search has been aborted. END return OK; } delete($ENV{'form.launch'}); if (! &make_form_data_persistent($r,$persistent_db_file)) { $r->print(<Search Error $bodytag Unable to properly store search information. The search has been aborted. END return OK; } # # We are running a search my ($query,$customquery,$customshow,$libraries) = (undef,undef,undef,undef); my $pretty_string; if ($ENV{'form.phase'} eq 'basic_search') { ($query,$pretty_string,$libraries) = &parse_basic_search($r,$closebutton,$hidden_fields); } else { # Advanced search ($query,$customquery,$customshow,$libraries,$pretty_string) = &parse_advanced_search($r,$closebutton,$hidden_fields); 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; } ###################################################################### ###################################################################### ## ## Course Search ## ###################################################################### ###################################################################### { # Scope the course search to avoid global variables # # Variables For course search my %alreadyseen; my %hash; my $totalfound; sub course_search { my $r=shift; my $bodytag=&Apache::loncommon::bodytag('Course Search'). &Apache::loncommon::help_open_bug('Searching'); my $pretty_search_string = ''.$ENV{'form.courseexp'}.''; my $search_string = $ENV{'form.courseexp'}; my @New_Words; if ($ENV{'form.crsrelated'}) { ($search_string,@New_Words) = &related_version($ENV{'form.courseexp'}); if (@New_Words) { $pretty_search_string .= ' '.&mt("with related words").": @New_Words."; } else { $pretty_search_string .= ' '.&mt('with no related words')."."; } } my $fulltext=$ENV{'form.crsfulltext'}; my @allwords=($search_string,@New_Words); $totalfound=0; $r->print('LON-CAPA Course Search'. $bodytag.'

'.$pretty_search_string.'

'); $r->rflush(); # ======================================================= Go through the course undef %alreadyseen; %alreadyseen=(); my $c=$r->connection; if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.".db", &GDBM_READER(),0640)) { foreach (keys %hash) { if ($c->aborted()) { last; } if (($_=~/^src\_(.+)$/) && (!$alreadyseen{$hash{$_}})) { &checkonthis($r,$hash{$_},0,$hash{'title_'.$1},$fulltext, @allwords); } } untie(%hash); } unless ($totalfound) { $r->print('

'.&mt('No resources found').'.

'); } # =================================================== Done going through course $r->print(''); } # =============================== 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).'
'); $totalfound++; } elsif ($fulltext) { $r->print(' .'); } $r->rflush(); # Check also the dependencies of this one my $dependencies= &Apache::lonnet::metadata($url,'dependencies'); foreach (split(/\,/,$dependencies)) { if (($_=~/^\/res\//) && (!$alreadyseen{$_})) { &checkonthis($r,$_,$level+1,'',$fulltext,@allwords); } } } sub untiehash { if (tied(%hash)) { untie(%hash); } } } # End of course search scoping sub search_html_header { my $Str = < The LearningOnline Network with CAPA ENDHEADER return $Str; } ###################################################################### ###################################################################### =pod =item &print_basic_search_form() Prints the form for the basic search. Sorry the name is so cryptic. =cut ###################################################################### ###################################################################### sub print_basic_search_form { my ($r,$closebutton,$hidden_fields) = @_; my $bodytag=&Apache::loncommon::bodytag('Search'). &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching','Finding_Resources', undef,undef,! $ENV{'form.launch'}); my $scrout = &search_html_header().$bodytag; if (&Apache::lonnet::allowed('bre',$ENV{'request.role.domain'})) { # Define interface components my $userelatedwords= &mt('[_1] use related words', &Apache::lonhtmlcommon::checkbox ('related',$ENV{'form.related'})); my $onlysearchdomain= &mt('[_1] only search domain [_2]', &Apache::lonhtmlcommon::checkbox ('domains',$ENV{'form.domains'}), $r->dir_config('lonDefDomain')); my $adv_search_link = ''.&mt('Advanced Search').''; # $scrout.='

'. ''. $hidden_fields; # $scrout .= ''.$/; if ($ENV{'request.course.id'}) { $scrout .= '

'.&mt('LON-CAPA Catalog Search').'

'; } else { # No need to tell them they are searching $scrout.= ('
'x2); } $scrout.=''. ''. ''. ''.$/; # # $scrout .= ''.$/; $scrout .= ''.$/; $scrout .= '

'. &Apache::lonhtmlcommon::textbox('basicexp', $ENV{'form.basicexp'},50).' '. ''.&searchhelp().''.'	'. ''.(' 'x3).$adv_search_link.''.' '. ''.(' 'x1).$userelatedwords.''.' '. ''.(' 'x1).$onlysearchdomain.''.' '. '
'. # ''. # $userelatedwords.(' 'x3). # $onlysearchdomain.(' 'x2).$adv_search_link. # ''. # '
'. ''. ''. (' 'x2).$closebutton.(' 'x2).&viewoptions(). ''. '

'.$/.''.'

'; } if ($ENV{'request.course.id'}) { my %lt=&Apache::lonlocal::texthash('srch' => 'Search', 'header' => 'Course Search', 'note' => 'Enter terms or phrases, then press "Search" below', 'use' => 'use related words', 'full' =>'fulltext search (time consuming)' ); $scrout.=(<

$lt{'header'}

$hidden_fields

$lt{'note'}.

ENDCOURSESEARCH $scrout.=' '. &Apache::lonhtmlcommon::textbox('courseexp', $ENV{'form.courseexp'},40); my $crscheckbox = &Apache::lonhtmlcommon::checkbox('crsfulltext', $ENV{'form.crsfulltext'}); my $relcheckbox = &Apache::lonhtmlcommon::checkbox('crsrelated', $ENV{'form.crsrelated'}); $scrout.=(<

$relcheckbox $lt{'use'}

$crscheckbox $lt{'full'}

ENDENDCOURSE } $scrout.=(< ENDDOCUMENT $r->print($scrout); return; } ###################################################################### ###################################################################### =pod =item &advanced_search_form() Prints the advanced search form. =cut ###################################################################### ###################################################################### sub print_advanced_search_form{ my ($r,$closebutton,$hidden_fields) = @_; my %lt=&Apache::lonlocal::texthash('srch' => 'Search', 'reset' => 'Reset', 'help' => 'Help'); my $advanced_buttons = <<"END";

$closebutton END my $bodytag=&Apache::loncommon::bodytag('Advanced Catalog Search'). &Apache::lonhtmlcommon::breadcrumbs(undef,'Searching', 'Finding_Resources', undef,undef, ! $ENV{'form.launch'}); my $searchhelp=&searchhelp(); my $scrout=&search_html_header(); $scrout .= <<"ENDHEADER"; $bodytag

$advanced_buttons ENDHEADER $scrout.=(' 'x2).&viewoptions().'

'.$hidden_fields. ''; my %fields=&Apache::lonmeta::fieldnames(); # $scrout.= '

'.$searchhelp.'

'. "\n"; my %related_word_search = ('title'=>1, 'author'=>0, 'owner'=>0, 'authorspace'=>0, 'modifyinguser'=>0, 'keywords'=>1, 'notes'=>1, 'abstract'=>1, 'standards'=>1, 'mime'=>1, ); # foreach my $field ('title','author','owner','authorspace','modifyinguser', 'keywords','notes','abstract','standards','mime') { $scrout.=''.$/; } foreach my $field ('lowestgradelevel','highestgradelevel') { $scrout.=''. ''. ''.$/; } $scrout.=''.$/; $scrout.=''.$/; $scrout .= "

'.&titlefield($fields{$field}).'	'. &Apache::lonmeta::prettyinput($field, $ENV{'form.'.$field}, $field, 'advsearch', $related_word_search{$field}, '	', $ENV{'form.'.$field.'_related'}, 50); if ($related_word_search{$field}) { $scrout .= 'related words'; } else { $scrout .= '	'; } $scrout .= '
'.&titlefield($fields{$field}).'	'. &Apache::lonmeta::prettyinput($field, $ENV{'form.'.$field}, $field, 'advsearch', 0). '
'. &titlefield(&mt('MIME Type Category')).'	'. &Apache::loncommon::filecategoryselect('category', $ENV{'form.category'}). '
'. &titlefield(&mt('Domains')).'	'. &Apache::loncommon::domain_select('domains', $ENV{'form.domains'},1). '

\n
\n\n"; my %dates=&Apache::lonlocal::texthash ('creationdatestart' => 'Creation Date After', 'creationdateend' => 'Creation Date Before', 'lastrevisiondatestart' => 'Last Revision Date After', 'lastrevisiondateend' => 'Last Revision Date Before'); foreach my $field (sort keys %dates) { $scrout.=''. ''.$/; } $scrout.="

'.&titlefield($dates{$field}).'

'. &Apache::lonhtmlcommon::date_setter('advsearch',$field,0,'',1). '

\n"; $scrout.=< ENDDOCUMENT $r->print($scrout); return; } ###################################################################### ###################################################################### =pod =item &titlefield() Inputs: title text Outputs: titletext with font wrapper =cut ###################################################################### ###################################################################### sub titlefield { my $title=shift; return $title; } ###################################################################### ###################################################################### =pod =item viewoptiontext() Inputs: codename for view option Outputs: displayed text =cut ###################################################################### ###################################################################### sub viewoptiontext { my $code=shift; my %desc=&Apache::lonlocal::texthash ('detailed' => "Detailed Citation View", 'xml' => 'XML/SGML', 'compact' => 'Compact View', 'fielded' => 'Fielded Format', 'summary' => 'Summary View'); return $desc{$code}; } ###################################################################### ###################################################################### =pod =item viewoptions() Inputs: none Outputs: text for box with view options =cut ###################################################################### ###################################################################### sub viewoptions { my $scrout="\n".''; if (! defined($ENV{'form.viewselect'})) { $ENV{'form.viewselect'}='detailed'; } $scrout.=&Apache::lonmeta::selectbox('viewselect', $ENV{'form.viewselect'}, \&viewoptiontext, sort(keys(%Views))); $scrout.= ' '; my $countselect = &Apache::lonmeta::selectbox('show', $ENV{'form.show'}, undef, (10,20,50,100,1000,10000)); $scrout .= (' 'x2).&mt('[_1] Records per Page',$countselect). ''.$/; return $scrout; } ###################################################################### ###################################################################### =pod =item searchhelp() Inputs: none Outputs: return little blurb on how to enter searches =cut ###################################################################### ###################################################################### sub searchhelp { return &mt('Enter terms or phrases separated by AND, OR, or NOT'); } ###################################################################### ###################################################################### =pod =item &get_persistent_form_data() Inputs: filename of database Outputs: returns undef on database errors. This function is the reverse of &make_persistent() for form data. Retrieve persistent data from %persistent_db. Retrieved items will have their values unescaped. If a form value already exists in $ENV, it will not be overwritten. Form values that are array references may have values appended to them. =cut ###################################################################### ###################################################################### sub get_persistent_form_data { my $filename = shift; return 0 if (! -e $filename); return undef if (! tie(%persistent_db,'GDBM_File',$filename, &GDBM_READER(),0640)); # # These make sure we do not get array references printed out as 'values'. my %arrays_allowed = ('form.domains'=>1); # # Loop through the keys, looking for 'form.' foreach my $name (keys(%persistent_db)) { next if ($name !~ /^form./); # Kludgification begins! if ($name eq 'form.domains' && $ENV{'form.searchmode'} eq 'basic' && $ENV{'form.phase'} ne 'disp_basic') { next; } # End kludge (hopefully) next if (exists($ENV{$name})); my @values = map { &Apache::lonnet::unescape($_); } split(',',$persistent_db{$name}); next if (@values <1); if ($arrays_allowed{$name}) { $ENV{$name} = [@values]; } else { $ENV{$name} = $values[0] if ($values[0]); } } untie (%persistent_db); return 1; } ###################################################################### ###################################################################### =pod =item &get_persistent_data() Inputs: filename of database, ref to array of values to recover. Outputs: array of values. Returns undef on error. This function is the reverse of &make_persistent(); Retrieve persistent data from %persistent_db. Retrieved items will have their values unescaped. If the item contains commas (before unescaping), the returned value will be an array pointer. =cut ###################################################################### ###################################################################### sub get_persistent_data { my $filename = shift; my @Vars = @{shift()}; my @Values; # Return array return undef if (! -e $filename); return undef if (! tie(%persistent_db,'GDBM_File',$filename, &GDBM_READER(),0640)); foreach my $name (@Vars) { if (! exists($persistent_db{$name})) { push @Values, undef; next; } my @values = map { &Apache::lonnet::unescape($_); } split(',',$persistent_db{$name}); if (@values <= 1) { push @Values,$values[0]; } else { push @Values,\@values; } } untie (%persistent_db); return @Values; } ###################################################################### ###################################################################### =pod =item &make_persistent() Inputs: Hash of values to save, filename of persistent database. Store variables away to the %persistent_db. Values will be escaped. Values that are array pointers will have their elements escaped and concatenated in a comma separated string. =cut ###################################################################### ###################################################################### sub make_persistent { my %save = %{shift()}; my $filename = shift; return undef if (! tie(%persistent_db,'GDBM_File', $filename,&GDBM_WRCREAT(),0640)); foreach my $name (keys(%save)) { my @values = (ref($save{$name}) ? @{$save{$name}} : ($save{$name})); # We handle array references, but not recursively. my $store = join(',', map { &Apache::lonnet::escape($_); } @values ); $persistent_db{$name} = $store; } untie(%persistent_db); return 1; } ###################################################################### ###################################################################### =pod =item &make_form_data_persistent() Inputs: filename of persistent database. Store most form variables away to the %persistent_db. Values will be escaped. Values that are array pointers will have their elements escaped and concatenated in a comma separated 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); } ###################################################################### ###################################################################### =pod =item &parse_advanced_search() Parse advanced search form and return the following: =over 4 =item $query Scalar containing an SQL query. =item $customquery Scalar containing a custom query. =item $customshow Scalar containing commands to show custom metadata. =item $libraries_to_query Reference to array of domains to search. =back =cut ###################################################################### ###################################################################### sub parse_advanced_search { my ($r,$closebutton,$hidden_fields)=@_; my $fillflag=0; my $pretty_search_string = "
\n"; # Clean up fields for safety for my $field ('title','author','subject','keywords','url','version', 'creationdatestart_month','creationdatestart_day', 'creationdatestart_year','creationdateend_month', 'creationdateend_day','creationdateend_year', 'lastrevisiondatestart_month','lastrevisiondatestart_day', 'lastrevisiondatestart_year','lastrevisiondateend_month', 'lastrevisiondateend_day','lastrevisiondateend_year', 'notes','abstract','extension','language','owner', 'custommetadata','customshow','category') { $ENV{"form.$field"}=~s/[^\w\/\s\=\-\"\']//g; } foreach ('mode','form','element') { # is this required? Hmmm. next unless (exists($ENV{"form.$_"})); $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"}); $ENV{"form.$_"}=~s/[^\w\/\s\=\-\"\']//g; } # Preprocess the category form element. $ENV{'form.category'} = 'any' if (! defined($ENV{'form.category'}) || ref($ENV{'form.category'})); # # Check to see if enough information was filled in for my $field ('title','author','subject','keywords','url','version', 'notes','abstract','category','extension','language', 'owner','custommetadata') { if (&filled($ENV{"form.$field"})) { $fillflag++; } } if (! $fillflag) { &output_blank_field_error($r,$closebutton, 'phase=disp_adv',$hidden_fields); return ; } # Turn the form input into a SQL-based query my $query=''; my @queries; my $font = ''; # Evaluate logical expression AND/OR/NOT phrase fields. foreach my $field ('title','author','subject','notes','abstract','url', 'keywords','version','owner','standards') { if ($ENV{'form.'.$field}) { my $searchphrase = $ENV{'form.'.$field}; $pretty_search_string .= $font."$field contains ". $searchphrase.""; if ($ENV{'form.'.$field.'_related'}) { my @New_Words; ($searchphrase,@New_Words) = &related_version($searchphrase); if (@New_Words) { $pretty_search_string .= " with related words: ". "@New_Words."; } else { $pretty_search_string .= " with no related words."; } } $pretty_search_string .= "
\n"; push @queries,&build_SQL_query($field,$searchphrase); } } # # Make the 'mime' from 'form.category' and 'form.extension' # my $searchphrase; if (exists($ENV{'form.category'}) && $ENV{'form.category'} !~ /^\s*$/ && $ENV{'form.category'} ne 'any') { my @extensions = &Apache::loncommon::filecategorytypes ($ENV{'form.category'}); if (scalar(@extensions) > 0) { $searchphrase = join(' OR ',@extensions); } } if (exists($ENV{'form.extension'}) && $ENV{'form.extension'} !~ /^\s*$/) { $searchphrase .= ' OR ' if (defined($searchphrase)); my @extensions = split(/,/,$ENV{'form.extension'}); $searchphrase .= join(' OR ',@extensions); } if (defined($searchphrase)) { push @queries,&build_SQL_query('mime',$searchphrase); $pretty_search_string .=$font.'mime contains '. $searchphrase.'
'; } # # Evaluate option lists if ($ENV{'form.language'} and $ENV{'form.language'} ne 'any') { push @queries,"(language like \"$ENV{'form.language'}\")"; $pretty_search_string.=$font."language= ". &Apache::loncommon::languagedescription($ENV{'form.language'}). "
\n"; } if ($ENV{'form.copyright'} and $ENV{'form.copyright'} ne 'any') { push @queries,"(copyright like \"$ENV{'form.copyright'}\")"; $pretty_search_string.=$font."copyright = ". &Apache::loncommon::copyrightdescription($ENV{'form.copyright'}). "
\n"; } # # Evaluate date windows my $datequery=&build_date_queries( $ENV{'form.creationdatestart_month'}, $ENV{'form.creationdatestart_day'}, $ENV{'form.creationdatestart_year'}, $ENV{'form.creationdateend_month'}, $ENV{'form.creationdateend_day'}, $ENV{'form.creationdateend_year'}, $ENV{'form.lastrevisiondatestart_month'}, $ENV{'form.lastrevisiondatestart_day'}, $ENV{'form.lastrevisiondatestart_year'}, $ENV{'form.lastrevisiondateend_month'}, $ENV{'form.lastrevisiondateend_day'}, $ENV{'form.lastrevisiondateend_year'}, ); # Test to see if date windows are legitimate if ($datequery=~/^Incorrect/) { &output_date_error($r,$datequery,$closebutton,$hidden_fields); return ; } elsif ($datequery) { # Here is where you would set up pretty_search_string to output # date query information. push @queries,$datequery; } # # Process form information for custom metadata querying my $customquery=undef; ## ## The custom metadata search was removed q long time ago mostly ## because I was unable to figureout exactly how it worked and could ## not imagine people actually using it. MH ## # 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,$pretty_domains_string) = &parse_domain_restrictions(); $pretty_search_string .= $pretty_domains_string."
\n"; # if (@queries) { $query=join(" AND ",@queries); $query="select * from metadata where $query"; } elsif ($customquery) { $query = ''; } return ($query,$customquery,$customshow,$libraries_to_query, $pretty_search_string); } sub parse_domain_restrictions { my $libraries_to_query = undef; # $ENV{'form.domains'} can be either a scalar or an array reference. # We need an array. if (! exists($ENV{'form.domains'})) { return (undef,''); } my @allowed_domains; if (ref($ENV{'form.domains'})) { @allowed_domains = @{$ENV{'form.domains'}}; } else { @allowed_domains = ($ENV{'form.domains'}); } # my %domain_hash = (); my $pretty_domains_string; foreach (@allowed_domains) { $domain_hash{$_}++; } if ($domain_hash{'any'}) { $pretty_domains_string = "In all LON-CAPA domains."; } else { if (@allowed_domains > 1) { $pretty_domains_string = "In LON-CAPA domains:"; } else { $pretty_domains_string = "In LON-CAPA domain "; } foreach (sort @allowed_domains) { $pretty_domains_string .= "".$_." "; } foreach (keys(%Apache::lonnet::libserv)) { if (exists($domain_hash{$Apache::lonnet::hostdom{$_}})) { push @$libraries_to_query,$_; } } } return ($libraries_to_query,$pretty_domains_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; } foreach ('mode','form','element') { # is this required? Hmmm. next unless (exists($ENV{"form.$_"})); $ENV{"form.$_"}=&Apache::lonnet::unescape($ENV{"form.$_"}); $ENV{"form.$_"}=~s/[^\w\/\s\=\-\"\']//g; } my ($libraries_to_query,$pretty_domains_string) = &parse_domain_restrictions(); # # Check to see if enough of a query is filled in unless (&filled($ENV{'form.basicexp'})) { &output_blank_field_error($r,$closebutton,'phase=disp_basic'); return OK; } my $pretty_search_string = ''.$ENV{'form.basicexp'}.''; my $search_string = $ENV{'form.basicexp'}; if ($ENV{'form.related'}) { my @New_Words; ($search_string,@New_Words) = &related_version($ENV{'form.basicexp'}); if (@New_Words) { $pretty_search_string .= " with related words: @New_Words."; } else { $pretty_search_string .= " with no related words."; } } # # Build SQL query string based on form page my $query=''; my $concatarg=join(',', ('title', 'author', 'subject', 'notes', 'abstract', 'keywords')); $concatarg='title' if $ENV{'form.titleonly'}; $query=&build_SQL_query('concat_ws(" ",'.$concatarg.')',$search_string); if (defined($pretty_domains_string) && $pretty_domains_string ne '') { $pretty_search_string .= ' '.$pretty_domains_string; } $pretty_search_string .= "
\n"; my $final_query = 'SELECT * FROM metadata WHERE '.$query; # &Apache::lonnet::logthis($final_query); return ($final_query,$pretty_search_string, $libraries_to_query); } ###################################################################### ###################################################################### =pod =item &related_version() Modifies an input string to include related words. Words in the string are replaced with parenthesized lists of 'OR'd words. For example "torque" is replaced with "(torque OR word1 OR word2 OR ...)". Note: Using this twice on a string is probably silly. =cut ###################################################################### ###################################################################### sub related_version { my $search_string = shift; my $result = $search_string; my %New_Words = (); while ($search_string =~ /(\w+)/cg) { my $word = $1; next if (lc($word) =~ /\b(or|and|not)\b/); my @Words = &Apache::loncommon::get_related_words($word); @Words = ($#Words>4? @Words[0..4] : @Words); foreach (@Words) { $New_Words{$_}++;} my $replacement = join " OR ", ($word,@Words); $result =~ s/(\b)$word(\b)/$1($replacement)$2/g; } return $result,sort(keys(%New_Words)); } ###################################################################### ###################################################################### =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', -parse => 'Text::Query::ParseAdvanced', -build => 'Text::Query::Build'); $q->prepare($logic_statement); my $matchexp=${$q}{'matchexp'}; chomp $matchexp; my $sql_query=&recursive_SQL_query_build($field_name,$matchexp); return $sql_query; } ###################################################################### ###################################################################### =pod =item &build_custommetadata_query() Constructs a custom metadata query using a rather heinous regular expression. =cut ###################################################################### ###################################################################### sub build_custommetadata_query { my ($field_name,$logic_statement)=@_; my $q=new Text::Query('abc', -parse => 'Text::Query::ParseAdvanced', -build => 'Text::Query::BuildAdvancedString'); $q->prepare($logic_statement); my $matchexp=${$q}{'-parse'}{'-build'}{'matchstring'}; # quick fix to change literal into xml tag-matching # will eventually have to write a separate builder module # wordone=wordtwo becomes\[^\<] *wordtwo[^\<]*\<\/wordone\> $matchexp =~ s/(\w+)\\=([\w\\\+]+)?# wordone=wordtwo is changed to /\\<$1\\>?# \ \[\^\\<\]?# [^\<] \*$2\[\^\\<\]?# *wordtwo[^\<] \*\\<\\\/$1\\>?# *\<\/wordone\> /g; return $matchexp; } ###################################################################### ###################################################################### =pod =item &recursive_SQL_query_build() Recursively constructs an SQL query. Takes as input $dkey and $pattern. =cut ###################################################################### ###################################################################### sub recursive_SQL_query_build { my ($dkey,$pattern)=@_; my @matches=($pattern=~/(\[[^\]|\[]*\])/g); return $pattern unless @matches; foreach my $match (@matches) { $match=~/\[ (\w+)\s(.*) \]/; my ($key,$value)=($1,$2); my $replacement=''; if ($key eq 'literal') { $replacement="($dkey LIKE \"\%$value\%\")"; } elsif (lc($key) eq 'not') { $value=~s/LIKE/NOT LIKE/; # $replacement="($dkey not like $value)"; $replacement="$value"; } elsif ($key eq 'and') { $value=~/(.*[\"|\)]) ([|$|\^].*)/; $replacement="($1 AND $2)"; } elsif ($key eq 'or') { $value=~/(.*[\"|$]) ([|\(|\^].*)/; $replacement="($1 OR $2)"; } substr($pattern, index($pattern,$match), length($match), $replacement); } &recursive_SQL_query_build($dkey,$pattern); } ###################################################################### ###################################################################### =pod =item &build_date_queries() Builds a SQL logic query to check time/date entries. Also reports errors (check for /^Incorrect/). =cut ###################################################################### ###################################################################### sub build_date_queries { my ($cmonth1,$cday1,$cyear1,$cmonth2,$cday2,$cyear2, $lmonth1,$lday1,$lyear1,$lmonth2,$lday2,$lyear2)=@_; my @queries; if ($cmonth1 or $cday1 or $cyear1 or $cmonth2 or $cday2 or $cyear2) { unless ($cmonth1 and $cday1 and $cyear1 and $cmonth2 and $cday2 and $cyear2) { return "Incorrect entry for the creation date. You must specify ". "a starting month, day, and year and an ending month, ". "day, and year."; } my $cnumeric1=sprintf("%d%2d%2d",$cyear1,$cmonth1,$cday1); $cnumeric1+=0; my $cnumeric2=sprintf("%d%2d%2d",$cyear2,$cmonth2,$cday2); $cnumeric2+=0; if ($cnumeric1>$cnumeric2) { return "Incorrect entry for the creation date. The starting ". "date must occur before the ending date."; } my $cquery="(creationdate BETWEEN '$cyear1-$cmonth1-$cday1' AND '". "$cyear2-$cmonth2-$cday2 23:59:59')"; push @queries,$cquery; } if ($lmonth1 or $lday1 or $lyear1 or $lmonth2 or $lday2 or $lyear2) { unless ($lmonth1 and $lday1 and $lyear1 and $lmonth2 and $lday2 and $lyear2) { return "Incorrect entry for the last revision date. You must ". "specify a starting month, day, and year and an ending ". "month, day, and year."; } my $lnumeric1=sprintf("%d%2d%2d",$lyear1,$lmonth1,$lday1); $lnumeric1+=0; my $lnumeric2=sprintf("%d%2d%2d",$lyear2,$lmonth2,$lday2); $lnumeric2+=0; if ($lnumeric1>$lnumeric2) { return "Incorrect entry for the last revision date. The ". "starting date must occur before the ending date."; } my $lquery="(lastrevisiondate BETWEEN '$lyear1-$lmonth1-$lday1' AND '". "$lyear2-$lmonth2-$lday2 23:59:59')"; push @queries,$lquery; } if (@queries) { return join(" AND ",@queries); } return ''; } ###################################################################### ###################################################################### =pod =item ©right_check() Inputs: $Metadata, a hash pointer of metadata for a resource. Returns: 1 if the resource is available to the user making the query, 0 otherwise. =cut ###################################################################### ###################################################################### sub copyright_check { my $Metadata = shift; # Check copyright tags and skip results the user cannot use my (undef,undef,$resdom,$resname) = split('/', $Metadata->{'url'}); # Check for priv if (($Metadata->{'copyright'} eq 'priv') && (($ENV{'user.name'} ne $resname) && ($ENV{'user.domain'} ne $resdom))) { return 0; } # Check for domain if (($Metadata->{'copyright'} eq 'domain') && ($ENV{'user.domain'} ne $resdom)) { return 0; } return 1; } ###################################################################### ###################################################################### =pod =item &ensure_db_and_table() Ensure we can get lonmysql to connect to the database and the table we need exists. Inputs: $r, table id Returns: undef on error, 1 if the table exists. =cut ###################################################################### ###################################################################### sub ensure_db_and_table { my ($r,$table) = @_; ## ## Sanity check the table id. ## if (! defined($table) || $table eq '' || $table =~ /\D/ ) { $r->print("Unable to retrieve search results. ". "Unable to determine the table results were stored in. ". ""); return undef; } ## ## Make sure we can connect and the table exists. ## my $connection_result = &Apache::lonmysql::connect_to_db(); if (!defined($connection_result)) { $r->print("Unable to connect to the MySQL database where your results". " are stored. "); &Apache::lonnet::logthis("lonsearchcat: unable to get lonmysql to". " connect to database."); &Apache::lonnet::logthis(&Apache::lonmysql::get_error()); return undef; } my $table_check = &Apache::lonmysql::check_table($table); if (! defined($table_check)) { $r->print("A MySQL error has occurred."); &Apache::lonnet::logthis("lonmysql was unable to determine the status". " of table ".$table); return undef; } elsif (! $table_check) { $r->print("The table of results could not be found."); &Apache::lonnet::logthis("The user requested a table, ".$table. ", that could not be found."); return undef; } return 1; } ###################################################################### ###################################################################### =pod =item &print_sort_form() The sort feature is not implemented at this time. This form just prints a link to change the search query. =cut ###################################################################### ###################################################################### sub print_sort_form { my ($r,$pretty_query_string) = @_; my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1); ## my %SortableFields=&Apache::lonlocal::texthash( id => 'Default', title => 'Title', author => 'Author', subject => 'Subject', url => 'URL', version => 'Version Number', mime => 'Mime type', lang => 'Language', owner => 'Owner/Publisher', copyright => 'Copyright', hostname => 'Host', creationdate => 'Creation Date', lastrevisiondate => 'Revision Date' ); ## my $table = $ENV{'form.table'}; return if (! &ensure_db_and_table($r,$table)); ## ## Get the number of results ## my $total_results = &Apache::lonmysql::number_of_rows($table); if (! defined($total_results)) { $r->print("A MySQL error has occurred."); &Apache::lonnet::logthis("lonmysql was unable to determine the number". " of rows in table ".$table); &Apache::lonnet::logthis(&Apache::lonmysql::get_error()); return; } my $result; $result.=< Results $bodytag

END #

Sort Results

#Sort by: }; return $result; } ###################################################################### ###################################################################### =pod =item &run_search() Executes a search query by sending it the the other servers and putting the results into MySQL. =cut ###################################################################### ###################################################################### sub run_search { my ($r,$query,$customquery,$customshow,$serverlist,$pretty_string) = @_; my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1); my $connection = $r->connection; # # 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(&mt("Search: [_1]",$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; # # Check on the mysql table we will use to store results. my $table =$ENV{'form.table'}; if (! defined($table) || $table eq '' || $table =~ /\D/ ) { $r->print("Unable to determine table id to store search results in.". "The search has been aborted."); 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) { &Apache::lonnet::logthis("lonmysql error = ". &Apache::lonmysql::get_error()); &Apache::lonnet::logthis("lonmysql debug = ". &Apache::lonmysql::get_debug()); &Apache::lonnet::logthis('table status = "'.$table_status.'"'); $r->print("The table id,$table, we tried to use is invalid.". "The search has been aborted."); 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(); &reset_timing(); &update_seconds($r); &update_status($r,&mt('contacting [_1]',$Servers_to_contact[0])); while (&time_left() && ((@Servers_to_contact) || keys(%Server_status))) { &update_seconds($r); # # Send out a search request if (@Servers_to_contact) { # Contact one server my $server = shift(@Servers_to_contact); &update_status($r,&mt('contacting [_1]',$server)); my $reply=&Apache::lonnet::metadata_query($query,$customquery, $customshow,[$server]); ($server) = keys(%$reply); $Server_status{$server} = $reply->{$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. if (scalar (keys(%Server_status))) { &update_status($r, &mt('waiting on [_1]',join(' ',keys(%Server_status)))); } sleep(1); } # # 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()); &update_seconds($r); 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,&mt('Receiving results from [_1]',$server)); next; } last if ($connection->aborted()); if (-e "$datafile.end") { &update_status($r,&mt('Reading results from [_1]',$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()); # # Records are stored one per line chomp($result); next if (! $result); # # Parse the result. my %Fields = &parse_raw_result($result,$server); $Fields{'hostname'} = $server; # # Skip based on copyright 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()); } # $hitcountsum ++; &update_seconds($r); if ($hitcountsum % 50 == 0) { &update_count_status($r,$hitcountsum); } } $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()); &update_seconds($r); } &update_status($r,&mt('Search Complete [_1]',$server)); &update_seconds($r); # &Apache::lonmysql::disconnect_from_db(); # This is unneccessary # # We have run out of time or run out of servers to talk to and # results to get, so let the client know the top frame needs to be # loaded from /adm/searchcat $r->print(""); if ($ENV{'form.catalogmode'} ne 'groupsearch') { $r->print(""); } return; } ###################################################################### ###################################################################### =pod =item &prev_next_buttons() Returns html for the previous and next buttons on the search results page. =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. # # Create links my $prev_min = $current_min - $show; $prev_min = 1 if $prev_min < 1; my $prevlink = qq{}; # my $next_min = $current_min + $show; $next_min = $current_min if ($next_min > $total); my $nextlink = qq{}; my $reloadlink = qq{}; # # Determine which parameters to pass my $String = '[_1]prev[_2] [_3]reload[_4] [_5]next[_6]'; if ($prev_min == $current_min) { $String =~ s:\[_[12]\]::g; } if ($next_min == $current_min) { $String =~ s:\[_[56]\]::g; } my $links = &mt($String, $prevlink, '', $reloadlink,'', $nextlink, ''); return $links; } ###################################################################### ###################################################################### =pod =item &display_results() Prints the results out for selection and perusal. =cut ###################################################################### ###################################################################### sub display_results { my ($r,$importbutton,$closebutton,$diropendb) = @_; 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 by opening the groupsearch db file. 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(''. '

'.&mt('There are currently no results').'.

'. ""); 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"; if (! defined($Fields{'title'}) || $Fields{'title'} eq '') { $Fields{'title'} = 'Untitled'; } 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(&mt("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; if (! scalar(@Datatypes)) { &set_up_table_structure(); } for (my $i=0;$i<=$#Row;$i++) { $Fields{$Datatypes[$i]->{'name'}}=&Apache::lonnet::unescape($Row[$i]); } $Fields{'language'} = &Apache::loncommon::languagedescription($Fields{'language'}); $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 according to column labels In addition, the following tags are set by calling the appropriate lonnet function: 'language', 'copyrighttag', '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) = @_; # conclude from self to others regarding fields my %Fields=&LONCAPA::lonmetadata::metadata_col_to_hash (map { &Apache::lonnet::unescape($_); } (split(/\,/,$result)) ); 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' Contains the name of the form that has the input fields to set =item 'form.element' the name of the input field to put the URL into =item 'form.titleelement' the name of the input field to put the title into =back =cut ###################################################################### ###################################################################### sub search_results_header { my ($importbutton,$closebutton) = @_; my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1); my $result = ''; # output beginning of search page # conditional output of script functions dependent on the mode in # which the search was invoked if ($ENV{'form.catalogmode'} eq 'interactive'){ if (! exists($ENV{'form.mode'}) || $ENV{'form.mode'} ne 'edit') { $result.=< function select_data(title,url) { changeTitle(title); changeURL(url); parent.close(); } function changeTitle(val) { if (parent.opener.inf.document.forms.resinfo.elements.t) { parent.opener.inf.document.forms.resinfo.elements.t.value=val; } } function changeURL(val) { if (parent.opener.inf.document.forms.resinfo.elements.u) { parent.opener.inf.document.forms.resinfo.elements.u.value=val; } } SCRIPT } elsif ($ENV{'form.mode'} eq 'edit') { my $form = $ENV{'form.form'}; my $element = $ENV{'form.element'}; my $titleelement = $ENV{'form.titleelement'}; my $changetitle; if (!$titleelement) { $changetitle='function changeTitle(val) {}'; } else { $changetitle=< function select_data(title,url) { changeURL(url); changeTitle(title); parent.close(); } $changetitle function changeURL(val) { if (parent.targetwin.document) { parent.targetwin.document.forms["$form"].elements["$element"].value=val; } else { var url = 'forms[\"$form\"].elements[\"$element\"].value'; alert("Unable to transfer data to "+url); } } SCRIPT } } $result.=< SCRIPT $result.=< $bodytag

$importbutton END return $result; } ###################################################################### ###################################################################### sub search_status_header { my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1); return <Search Status $bodytag

Search Status

Sending search request to LON-CAPA servers.
ENDSTATUS } sub results_link { my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}. "&persistent_db_id=".$ENV{'form.persistent_db_id'}; my $results_link = $basic_link."&phase=results". "&pause=1"."&start=1"; return $results_link; } ###################################################################### ###################################################################### sub print_frames_interface { my $r = shift; my $basic_link = "/adm/searchcat?"."&table=".$ENV{'form.table'}. "&persistent_db_id=".$ENV{'form.persistent_db_id'}; my $run_search_link = $basic_link."&phase=run_search"; my $results_link = &results_link(); my $result = <<"ENDFRAMES"; LON-CAPA Digital Library Search Results ENDFRAMES $r->print($result); return; } ###################################################################### ###################################################################### =pod =item Metadata Viewing Functions Output is a HTML-ified string. Input arguments are title, author, subject, url, keywords, version, notes, short abstract, mime, language, creation date, last revision date, owner, copyright, hostname, and extra custom metadata to show. =over 4 =item &detailed_citation_view() =cut ###################################################################### ###################################################################### sub detailed_citation_view { my ($prefix,%values) = @_; my $icon=&Apache::loncommon::icon($values{'url'}); my $result=<$prefix

$values{'title'}

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

$values{'extrashow'}

$values{'shortabstract'}

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

END return $result; } ###################################################################### ###################################################################### =pod =item &filled() see if field is filled. =cut ###################################################################### ###################################################################### sub filled { my ($field)=@_; if ($field=~/\S/ && $field ne 'any') { return 1; } else { return 0; } } ###################################################################### ###################################################################### =pod =item &output_blank_field_error() Output a complete page that indicates the user has not filled in enough information to do a search. Inputs: $r (Apache request handle), $closebutton, $parms. Returns: nothing $parms is extra information to include in the 'Revise search request' link. =cut ###################################################################### ###################################################################### sub output_blank_field_error { my ($r,$closebutton,$parms,$hidden_fields)=@_; my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1); # make query information persistent to allow for subsequent revision $r->print(< The LearningOnline Network with CAPA BEGINNING $r->print(< $bodytag

Search Catalog

$hidden_fields Revise search request $closebutton

Unactionable search query.

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

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

Search Catalog

$hidden_fields $closebutton

Error

$message

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

ENDCOURSESEARCH $scrout.=' '. &Apache::lonhtmlcommon::textbox('courseexp', $ENV{'form.courseexp'},40); my $crscheckbox = &Apache::lonhtmlcommon::checkbox('crsfulltext', $ENV{'form.crsfulltext'}); my $relcheckbox = &Apache::lonhtmlcommon::checkbox('crsrelated', $ENV{'form.crsrelated'}); $scrout.=(<
$relcheckbox $lt{'use'}
$crscheckbox $lt{'full'}