2 # Script to perform searching
3 # Mostly copied from search.pl, see POD there
4 use strict; # always use
6 ## STEP 1. Load things that are used in both search page and
7 # results page and decide which template to load, operations
15 use POSIX qw(ceil floor);
16 use C4::Branch; # GetBranches
18 # create a new CGI object
19 # FIXME: no_undef_params needs to be tested
20 use CGI qw('-no_undef_params');
23 my ($template,$borrowernumber,$cookie);
25 # decide which template to use
28 my @params = $cgi->param("limit");
30 my $build_grouped_results = C4::Context->preference('OPACGroupResults');
31 if ($build_grouped_results) {
32 $template_name = 'opac-results-grouped.tmpl';
34 elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
35 $template_name = 'opac-results.tmpl';
38 $template_name = 'opac-advsearch.tmpl';
39 $template_type = 'advsearch';
42 ($template, $borrowernumber, $cookie) = get_template_and_user({
43 template_name => $template_name,
49 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
50 $template->param('UNIMARC' => 1);
54 # Deprecated, but preserved because it's interesting :-)
55 # The same thing can be accomplished with mod_rewrite in
59 #my $uri = $cgi->url(-base => 1);
60 #my $relative_url = $cgi->url(-relative=>1);
61 #$uri.="/".$relative_url."?";
63 #my @cgi_params_list = $cgi->param();
64 #my $url_params = $cgi->Vars;
66 #for my $each_param_set (@cgi_params_list) {
67 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
70 # Only re-write a URI if there are params or if it already hasn't been re-written
71 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
72 # print $cgi->redirect( -uri=>$uri."&r=1",
73 # -cookie => $cookie);
78 my $branches = GetBranches();
81 for my $branch_hash (sort keys %$branches) {
82 push @branch_loop, {value => "$branch_hash" , branchname => $branches->{$branch_hash}->{'branchname'}, };
85 my $categories = GetBranchCategories(undef,'searchdomain');
87 $template->param(branchloop => \@branch_loop, searchdomainloop => $categories);
90 my $itemtypes = GetItemTypes;
94 my $imgdir = getitemtypeimagesrc('opac');
96 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
97 my %row =( number=>$cnt++,
98 imageurl=> $itemtypes->{$thisitemtype}->{'imageurl'}?($imgdir."/".$itemtypes->{$thisitemtype}->{'imageurl'}):"",
99 code => $thisitemtype,
100 selected => $selected,
101 description => $itemtypes->{$thisitemtype}->{'description'},
104 $selected = 0 if ($selected) ;
105 push @itemtypesloop, \%row;
107 $template->param(itemtypeloop => \@itemtypesloop);
109 # # load the itypes (Called item types in the template -- just authorized values for searching)
110 # my ($itypecount,@itype_loop) = GetCcodes();
111 # $template->param(itypeloop=>\@itype_loop,);
113 # The following should only be loaded if we're bringing up the advanced search template
114 if ( $template_type eq 'advsearch' ) {
116 # load the servers (used for searching -- to do federated searching, etc.)
117 my $primary_servers_loop;# = displayPrimaryServers();
118 $template->param(outer_servers_loop => $primary_servers_loop,);
120 my $secondary_servers_loop;# = displaySecondaryServers();
121 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
123 # determine what to display next to the search boxes (ie, boolean option
124 # shouldn't appear on the first one, scan indexes should, adding a new
125 # box should only appear on the last, etc.
126 my @search_boxes_array;
127 my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") | 3; # FIXME: should be a syspref
128 for (my $i=1;$i<=$search_boxes_count;$i++) {
129 # if it's the first one, don't display boolean option, but show scan indexes
131 push @search_boxes_array,
137 # if it's the last one, show the 'add field' box
138 elsif ($i==$search_boxes_count) {
139 push @search_boxes_array,
146 push @search_boxes_array,
153 $template->param(uc(C4::Context->preference("marcflavour")) => 1,
155 search_boxes_loop => \@search_boxes_array);
157 # use the global setting by default
158 if ( C4::Context->preference("expandedSearchOption") == 1) {
159 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
161 # but let the user override it
162 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
163 $template->param( expanded_options => $cgi->param('expanded_options'));
166 output_html_with_http_headers $cgi, $cookie, $template->output;
170 ### OK, if we're this far, we're performing an actual search
172 # Fetch the paramater list as a hash in scalar context:
173 # * returns paramater list as tied hash ref
174 # * we can edit the values by changing the key
175 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
176 my $params = $cgi->Vars;
178 # Params that can have more than one value
179 # sort by is used to sort the query
180 # in theory can have more than one but generally there's just one
182 my $default_sort_by = C4::Context->preference('OPACdefaultSortField')."_".C4::Context->preference('OPACdefaultSortOrder')
183 if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
185 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
186 $sort_by[0] = $default_sort_by unless $sort_by[0];
187 foreach my $sort (@sort_by) {
188 $template->param($sort => 1);
190 $template->param('sort_by' => $sort_by[0]);
192 # Use the servers defined, or just search our local catalog(default)
194 @servers = split("\0",$params->{'server'}) if $params->{'server'};
196 #FIXME: this should be handled using Context.pm
197 @servers = ("biblioserver");
198 # @servers = C4::Context->config("biblioserver");
201 # operators include boolean and proximity operators and are used
202 # to evaluate multiple operands
204 @operators = split("\0",$params->{'op'}) if $params->{'op'};
206 # indexes are query qualifiers, like 'title', 'author', etc. They
207 # can be single or multiple parameters separated by comma: kw,right-Truncation
208 my @indexes = split("\0",$params->{'idx'});
210 # if a simple index (only one) display the index used in the top search box
211 if ($indexes[0] && !$indexes[1]) {
212 $template->param("ms_".$indexes[0] => 1);
214 # an operand can be a single term, a phrase, or a complete ccl query
216 @operands = split("\0",$params->{'q'}) if $params->{'q'};
218 # if a simple search, display the value in the search box
219 if ($operands[0] && !$operands[1]) {
220 $template->param(ms_value => $operands[0]);
223 # limits are use to limit to results to a pre-defined category such as branch or language
225 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
227 if($params->{'multibranchlimit'}) {
228 push @limits, join(" or ", map { "branch: $_ "} @{GetBranchesInCategory($params->{'multibranchlimit'})}) ;
232 foreach my $limit(@limits) {
233 if ($limit =~/available/) {
237 $template->param(available => $available);
239 # append year limits if they exist
240 if ($params->{'limit-yr'}) {
241 if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
242 my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
243 push @limits, "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
245 elsif ($params->{'limit-yr'} =~ /\d{4}/) {
246 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
249 #FIXME: Should return a error to the user, incorect date format specified
253 # Params that can only have one value
254 my $scan = $params->{'scan'};
255 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
256 my $results_per_page = $params->{'count'} || $count;
257 my $offset = $params->{'offset'} || 0;
258 my $page = $cgi->param('page') || 1;
259 #my $offset = ($page-1)*$results_per_page;
261 my $expanded_facet = $params->{'expand'};
263 # Define some global variables
264 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
268 ## I. BUILD THE QUERY
269 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by);
271 sub _input_cgi_parse ($) {
273 for my $this_cgi ( split('&',shift) ) {
274 next unless $this_cgi;
275 $this_cgi =~ /(.*)=(.*)/;
277 my $input_value = $2;
278 push @elements, { input_name => $input_name, input_value => $input_value };
283 ## parse the query_cgi string and put it into a form suitable for <input>s
284 my @query_inputs = _input_cgi_parse($query_cgi);
285 $template->param ( QUERY_INPUTS => \@query_inputs );
287 ## parse the limit_cgi string and put it into a form suitable for <input>s
288 my @limit_inputs = _input_cgi_parse($limit_cgi);
290 # add OPAC 'hidelostitems'
291 if (C4::Context->preference('hidelostitems') == 1) {
292 # either lost ge 0 or no value in the lost register
293 $query ="($query) and ( (lost,st-numeric <= 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='') )";
296 # add OPAC suppression - requires at least one item indexed with Suppress
297 if (C4::Context->preference('OpacSuppression')) {
298 $query = "($query) not Suppress=1";
301 $template->param ( LIMIT_INPUTS => \@limit_inputs );
303 ## II. DO THE SEARCH AND GET THE RESULTS
304 my $total; # the total results for the whole set
305 my $facets; # this object stores the faceted results that display on the left-hand of the results page
309 if (C4::Context->preference('NoZebra')) {
311 ($error, $results_hashref, $facets) = NZgetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
313 } elsif ($build_grouped_results) {
315 ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
319 ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
323 $template->param(query_error => $error.$@);
324 output_html_with_http_headers $cgi, $cookie, $template->output;
328 # At this point, each server has given us a result set
329 # now we build that set for template display
330 my @sup_results_array;
331 for (my $i=0;$i<=@servers;$i++) {
332 my $server = $servers[$i];
333 if ($server =~/biblioserver/) { # this is the local bibliographic server
334 $hits = $results_hashref->{$server}->{"hits"};
335 my $page = $cgi->param('page') || 0;
337 if ($build_grouped_results) {
338 foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
339 # because pazGetRecords handles retieving only the records
340 # we want as specified by $offset and $results_per_page,
341 # we need to set the offset parameter of searchResults to 0
342 my @group_results = searchResults( $query_desc, $group->{'group_count'},$results_per_page, 0,
343 @{ $group->{"RECORDS"} });
344 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
347 @newresults = searchResults( $query_desc,$hits,$results_per_page,$offset,@{$results_hashref->{$server}->{"RECORDS"}});
349 $total = $total + $results_hashref->{$server}->{"hits"};
350 ## If there's just one result, redirect to the detail page
352 my $biblionumber=@newresults[0]->{biblionumber};
353 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
357 $template->param(total => $hits);
358 my $limit_cgi_not_availablity = $limit_cgi;
359 $limit_cgi_not_availablity =~ s/&limit=available//g;
360 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
361 $template->param(limit_cgi => $limit_cgi);
362 $template->param(query_cgi => $query_cgi);
363 $template->param(query_desc => $query_desc);
364 $template->param(limit_desc => $limit_desc);
365 if ($query_desc || $limit_desc) {
366 $template->param(searchdesc => 1);
368 $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
369 $template->param(results_per_page => $results_per_page);
370 $template->param(SEARCH_RESULTS => \@newresults,
371 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay") eq "itemdetails"?1:0),
373 ## Build the page numbers on the bottom of the page
375 # total number of pages there will be
376 my $pages = ceil($hits / $results_per_page);
377 # default page number
378 my $current_page_number = 1;
379 $current_page_number = ($offset / $results_per_page + 1) if $offset;
380 my $previous_page_offset = $offset - $results_per_page unless ($offset - $results_per_page <0);
381 my $next_page_offset = $offset + $results_per_page;
382 # If we're within the first 10 pages, keep it simple
383 #warn "current page:".$current_page_number;
384 if ($current_page_number < 10) {
385 # just show the first 10 pages
386 # Loop through the pages
387 my $pages_to_show = 10;
388 $pages_to_show = $pages if $pages<10;
389 for ($i=1; $i<=$pages_to_show;$i++) {
390 # the offset for this page
391 my $this_offset = (($i*$results_per_page)-$results_per_page);
392 # the page number for this page
393 my $this_page_number = $i;
394 # it should only be highlighted if it's the current page
395 my $highlight = 1 if ($this_page_number == $current_page_number);
396 # put it in the array
397 push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
402 # now, show twenty pages, with the current one smack in the middle
404 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
405 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
406 my $this_page_number = $i-9;
407 my $highlight = 1 if ($this_page_number == $current_page_number);
408 if ($this_page_number <= $pages) {
409 push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
414 $template->param( PAGE_NUMBERS => \@page_numbers,
415 previous_page_offset => $previous_page_offset) unless $pages < 2;
416 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
420 $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
422 } # end of the if local
423 # asynchronously search the authority server
424 elsif ($server =~/authorityserver/) { # this is the local authority server
425 my @inner_sup_results_array;
426 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
427 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
428 my $title_field = $marc_record_object->field(100);
429 warn "Authority Found: ".$marc_record_object->as_formatted();
430 push @inner_sup_results_array, {
431 'title' => $title_field->subfield('a'),
432 'link' => "&idx=an&q=".$marc_record_object->field('001')->as_string(),
435 my $servername = $server;
436 push @sup_results_array, { servername => $servername,
437 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
439 # FIXME: can add support for other targets as needed here
440 $template->param( outer_sup_results_loop => \@sup_results_array);
441 } #/end of the for loop
442 #$template->param(FEDERATED_RESULTS => \@results_array);
445 #classlist => $classlist,
448 facets_loop => $facets,
450 search_error => $error,
453 if ($query_desc || $limit_desc) {
454 $template->param(searchdesc => 1);
457 ## Now let's find out if we have any supplemental data to show the user
458 # and in the meantime, save the current query for statistical purposes, etc.
459 my $koha_spsuggest; # a flag to tell if we've got suggestions coming from Koha
460 my @koha_spsuggest; # place we store the suggestions to be returned to the template as LOOP
461 my $phrases = $query_desc;
464 if ( C4::Context->preference("kohaspsuggest") ) {
465 my ($suggest_host, $suggest_dbname, $suggest_user, $suggest_pwd) = split(':', C4::Context->preference("kohaspsuggest"));
467 my $koha_spsuggest_dbh;
468 # FIXME: this needs to be moved to Context.pm
470 $koha_spsuggest_dbh=DBI->connect("DBI:mysql:$suggest_dbname:$suggest_host","$suggest_user","$suggest_pwd");
473 warn "can't connect to spsuggest db";
476 my $koha_spsuggest_insert = "INSERT INTO phrase_log(phr_phrase,phr_resultcount,phr_ip) VALUES(?,?,?)";
477 my $koha_spsuggest_query = "SELECT display FROM distincts WHERE strcmp(soundex(suggestion), soundex(?)) = 0 order by soundex(suggestion) limit 0,5";
478 my $koha_spsuggest_sth = $koha_spsuggest_dbh->prepare($koha_spsuggest_query);
479 $koha_spsuggest_sth->execute($phrases);
480 while (my $spsuggestion = $koha_spsuggest_sth->fetchrow_array) {
481 $spsuggestion =~ s/(:|\/)//g;
483 $line{spsuggestion} = $spsuggestion;
484 push @koha_spsuggest,\%line;
488 # Now save the current query
489 $koha_spsuggest_sth=$koha_spsuggest_dbh->prepare($koha_spsuggest_insert);
490 #$koha_spsuggest_sth->execute($phrases,$results_per_page,$ipaddress);
491 $koha_spsuggest_sth->finish;
493 $template->param( koha_spsuggest => $koha_spsuggest ) unless $hits;
494 $template->param( SPELL_SUGGEST => \@koha_spsuggest,
499 warn "Kohaspsuggest failure:".$@;
503 # VI. BUILD THE TEMPLATE
504 output_html_with_http_headers $cgi, $cookie, $template->output;