3 # Copyright 2008 Garry Collum and the Koha Development team
4 # Copyright 2010 BibLibre
5 # Copyright 2011 KohaAloha, NZ
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it
10 # under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
14 # Koha is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
22 # Script to perform searching
23 # Mostly copied from search.pl, see POD there
26 ## STEP 1. Load things that are used in both search page and
27 # results page and decide which template to load, operations
31 use List::MoreUtils q/any/;
35 use Data::Dumper; # TODO remove
37 use Koha::SearchEngine::Search;
38 use Koha::SearchEngine::QueryBuilder;
40 my $searchengine = C4::Context->preference("SearchEngine");
41 my ($builder, $searcher);
42 #$searchengine = 'Zebra'; # XXX
43 $builder = Koha::SearchEngine::QueryBuilder->new({index => 'biblios'});
44 $searcher = Koha::SearchEngine::Search->new({index => 'biblios'});
46 use C4::Output qw( output_html_with_http_headers pagination_bar output_with_http_headers );
47 use C4::Auth qw( get_template_and_user get_session );
48 use C4::Languages qw( getlanguage getLanguages );
49 use C4::Search qw( searchResults );
50 use C4::Search::History;
51 use C4::Biblio qw( GetXmlBiblio CountItemsIssued );
52 use C4::Koha qw( GetItemTypesCategorized getitemtypeimagelocation GetAuthorisedValues );
53 use C4::Tags qw( get_tags get_tag );
55 use C4::External::OverDrive;
56 use C4::External::BakerTaylor qw( image_url link_url );
58 use Koha::CirculationRules;
62 use Koha::Virtualshelves;
63 use Koha::Library::Groups;
66 use Koha::SearchFields;
68 use POSIX qw(ceil floor strftime);
70 use JSON qw/decode_json encode_json/;
73 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
74 # create a new CGI object
75 # FIXME: no_undef_params needs to be tested
76 use CGI qw('-no_undef_params' -utf8);
79 my $branch_group_limit = $cgi->param("branch_group_limit");
80 if ( $branch_group_limit ) {
81 if ( $branch_group_limit =~ /^multibranchlimit-/ ) {
82 # For search groups we are going to convert this branch_group_limit CGI
83 # parameter into a multibranchlimit CGI parameter for the purposes of
84 # actually performing the query
86 -name => 'multibranchlimit',
87 -values => substr($branch_group_limit, 17)
92 -values => [ $branch_group_limit ]
97 my ($template,$borrowernumber,$cookie);
98 # decide which template to use
100 my $template_type = 'basic';
101 my @params = $cgi->multi_param("limit");
102 my @searchCategories = $cgi->multi_param('searchcat');
104 my $format = $cgi->param("format") || '';
105 if ($format =~ /(rss|atom|opensearchdescription)/) {
106 $template_name = 'opac-opensearch.tt';
108 elsif ((@params>=1) || (defined $cgi->param("q") && $cgi->param("q") ne "") || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) || @searchCategories ) {
109 $template_name = 'opac-results.tt';
112 $template_name = 'opac-advsearch.tt';
113 $template_type = 'advsearch';
116 $format = 'rss' if $format =~ /^rss2?$/;
119 ($template, $borrowernumber, $cookie) = get_template_and_user({
120 template_name => $template_name,
123 authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
126 my $patron = Koha::Patrons->find( $borrowernumber );
128 my $lang = C4::Languages::getlanguage($cgi);
130 if ($template_name eq 'opac-results.tt') {
131 $template->param('COinSinOPACResults' => C4::Context->preference('COinSinOPACResults'));
134 # get biblionumbers stored in the cart
137 if($cgi->cookie("bib_list")){
138 my $cart_list = $cgi->cookie("bib_list");
139 @cart_list = split(/\//, $cart_list);
142 if ($format eq 'rss' or $format eq 'opensearchdescription' or $format eq 'atom') {
143 $template->param($format => 1);
144 $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime)) if ($format eq 'atom');
145 # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
146 # entry, but not sure if that's worth an extra database query for each bib
148 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
149 $template->param('UNIMARC' => 1);
151 elsif (C4::Context->preference("marcflavour") eq "MARC21" ) {
152 $template->param('usmarc' => 1);
155 $template->param( 'OPACNoResultsFound' => C4::Context->preference('OPACNoResultsFound') );
158 OpacStarRatings => C4::Context->preference("OpacStarRatings") );
160 if (C4::Context->preference('BakerTaylorEnabled')) {
162 BakerTaylorEnabled => 1,
163 BakerTaylorImageURL => &image_url(),
164 BakerTaylorLinkURL => &link_url(),
165 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
169 if (C4::Context->preference('TagsEnabled')) {
170 $template->param(TagsEnabled => 1);
171 foreach (qw(TagsShowOnList TagsInputOnList)) {
172 C4::Context->preference($_) and $template->param($_ => 1);
177 # Deprecated, but preserved because it's interesting :-)
178 # The same thing can be accomplished with mod_rewrite in
182 #my $uri = $cgi->url(-base => 1);
183 #my $relative_url = $cgi->url(-relative=>1);
184 #$uri.="/".$relative_url."?";
186 #my @cgi_params_list = $cgi->param();
187 #my $url_params = $cgi->Vars;
189 #for my $each_param_set (@cgi_params_list) {
190 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
192 #warn "New URI:$uri";
193 # Only re-write a URI if there are params or if it already hasn't been re-written
194 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
195 # print $cgi->redirect( -uri=>$uri."&r=1",
196 # -cookie => $cookie);
202 if ($cgi->param("returntosearch")) {
203 $template->param('ReturnToSearch' => 1);
205 if ($cgi->cookie("search_path_code")) {
206 my $pathcode = $cgi->cookie("search_path_code");
207 if ($pathcode eq '"ads"') {
208 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?returntosearch=1');
210 elsif ($pathcode eq '"exs"') {
211 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?expanded_options=1&returntosearch=1');
214 warn "ReturnPath switch error";
218 my @search_groups = Koha::Library::Groups->get_search_groups();
219 $template->param( search_groups => \@search_groups );
221 # load the language limits (for search)
222 my $languages_limit_loop = getLanguages($lang, 1);
223 $template->param(search_languages_loop => $languages_limit_loop,);
225 # load the Type stuff
226 my $itemtypes = GetItemTypesCategorized;
227 # add translated_description to itemtypes
228 foreach my $itemtype ( keys %{$itemtypes} ) {
229 # Itemtypes search categories don't have (yet) translated descriptions, they are auth values (and could still have no descriptions too BZ 18400)
230 # If 'iscat' (see ITEMTYPECAT) then there is no itemtype and the description is not translated
231 my $translated_description = $itemtypes->{$itemtype}->{iscat}
232 ? $itemtypes->{$itemtype}->{description}
233 : Koha::ItemTypes->find($itemtype)->translated_description;
234 $itemtypes->{$itemtype}->{translated_description} = $translated_description || $itemtypes->{$itemtype}->{description} || q{};
237 # the index parameter is different for item-level itemtypes
238 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
239 my @advancedsearchesloop;
241 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
242 my @advanced_search_types = split(/\|/, $advanced_search_types);
244 my $hidingrules = C4::Context->yaml_preference('OpacHiddenItems') // {};
246 my @sorted_itemtypes = sort { $itemtypes->{$a}->{translated_description} cmp $itemtypes->{$b}->{translated_description} } keys %$itemtypes;
247 foreach my $advanced_srch_type (@advanced_search_types) {
248 $advanced_srch_type =~ s/^\s*//;
249 $advanced_srch_type =~ s/\s*$//;
250 if ($advanced_srch_type eq 'itemtypes') {
251 # itemtype is a special case, since it's not defined in authorized values
253 foreach my $thisitemtype ( @sorted_itemtypes ) {
254 next if $hidingrules->{itype} && any { $_ eq $thisitemtype } @{$hidingrules->{itype}};
255 next if $hidingrules->{itemtype} && any { $_ eq $thisitemtype } @{$hidingrules->{itemtype}};
256 my %row =( number=>$cnt++,
257 ccl => "$itype_or_itemtype,phr",
258 code => $thisitemtype,
259 description => $itemtypes->{$thisitemtype}->{translated_description},
260 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
261 cat => $itemtypes->{$thisitemtype}->{'iscat'},
262 hideinopac => $itemtypes->{$thisitemtype}->{'hideinopac'},
263 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
265 if ( !$itemtypes->{$thisitemtype}->{'hideinopac'} ) {
266 push @itypesloop, \%row;
269 my %search_code = ( advanced_search_type => $advanced_srch_type,
270 code_loop => \@itypesloop );
271 push @advancedsearchesloop, \%search_code;
273 # covers all the other cases: non-itemtype authorized values
274 my $advsearchtypes = GetAuthorisedValues($advanced_srch_type, 'opac');
276 for my $thisitemtype (@$advsearchtypes) {
277 my $hiding_key = lc $thisitemtype->{category};
278 $hiding_key = "location" if $hiding_key eq 'loc';
279 next if $hidingrules->{$hiding_key} && any { $_ eq $thisitemtype->{authorised_value} } @{$hidingrules->{$hiding_key}};
282 ccl => $advanced_srch_type,
283 code => $thisitemtype->{authorised_value},
284 description => $thisitemtype->{'lib_opac'} || $thisitemtype->{'lib'},
285 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
286 imageurl => getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
288 push @authvalueloop, \%row;
290 my %search_code = ( advanced_search_type => $advanced_srch_type,
291 code_loop => \@authvalueloop );
292 push @advancedsearchesloop, \%search_code;
295 $template->param(advancedsearchesloop => \@advancedsearchesloop);
297 # The following should only be loaded if we're bringing up the advanced search template
298 if ( $template_type && $template_type eq 'advsearch' ) {
299 # load the servers (used for searching -- to do federated searching, etc.)
300 my $primary_servers_loop;# = displayPrimaryServers();
301 $template->param(outer_servers_loop => $primary_servers_loop,);
303 my $secondary_servers_loop;
304 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
306 # set the default sorting
307 if ( C4::Context->preference('OPACdefaultSortField')
308 && C4::Context->preference('OPACdefaultSortOrder') ) {
309 my $default_sort_by =
310 C4::Context->preference('OPACdefaultSortField') . '_'
311 . C4::Context->preference('OPACdefaultSortOrder');
312 $template->param( sort_by => $default_sort_by );
315 # determine what to display next to the search boxes (ie, boolean option
316 # shouldn't appear on the first one, scan indexes should, adding a new
317 # box should only appear on the last, etc.
318 my @search_boxes_array;
319 my $search_boxes_count = 3; # begin with 3 boxes
320 $template->param( search_boxes_count => $search_boxes_count );
322 if ($cgi->cookie("num_paragraph")){
323 $search_boxes_count = $cgi->cookie("num_paragraph");
326 for (my $i=1;$i<=$search_boxes_count;$i++) {
327 # if it's the first one, don't display boolean option, but show scan indexes
329 push @search_boxes_array,
335 # if it's the last one, show the 'add field' box
336 elsif ($i==$search_boxes_count) {
337 push @search_boxes_array,
344 push @search_boxes_array,
352 my @advsearch_limits = split /,/, C4::Context->preference('OpacAdvSearchOptions');
353 my @advsearch_more_limits = split /,/,
354 C4::Context->preference('OpacAdvSearchMoreOptions');
356 uc( C4::Context->preference("marcflavour") ) => 1, # we already did this for UNIMARC
358 search_boxes_loop => \@search_boxes_array,
359 OpacAdvSearchOptions => \@advsearch_limits,
360 OpacAdvSearchMoreOptions => \@advsearch_more_limits,
363 # use the global setting by default
364 if ( C4::Context->preference("expandedSearchOption") == 1 ) {
365 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
367 # but let the user override it
368 if (defined $cgi->param('expanded_options')) {
369 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
370 $template->param( expanded_options => scalar $cgi->param('expanded_options'));
375 output_html_with_http_headers $cgi, $cookie, $template->output;
379 ### OK, if we're this far, we're performing an actual search
381 # Fetch the paramater list as a hash in scalar context:
382 # * returns paramater list as tied hash ref
383 # * we can edit the values by changing the key
384 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
385 my $params = $cgi->Vars;
387 if ( $params->{tag} ) {
388 $tag = $params->{tag};
389 $template->param( tag => $tag );
392 # String with params with the search criteria for the paging in opac-detail
393 # param value is URI encoded and params separator is HTML encode (&)
394 my $pasarParams = '';
396 for (keys %$params) {
397 my @pasarParam = $cgi->multi_param($_);
398 for my $paramValue(@pasarParam) {
399 $pasarParams .= '&' if ($j > 0);
400 $pasarParams .= $_ . '=' . uri_escape_utf8($paramValue);
405 # Params that can have more than one value
406 # sort by is used to sort the query
407 # in theory can have more than one but generally there's just one
410 if ( C4::Context->preference('OPACdefaultSortField')
411 && C4::Context->preference('OPACdefaultSortOrder') ) {
413 C4::Context->preference('OPACdefaultSortField') . '_'
414 . C4::Context->preference('OPACdefaultSortOrder');
417 my @allowed_sortby = qw /acqdate_asc acqdate_dsc author_az author_za call_number_asc call_number_dsc popularity_asc popularity_dsc pubdate_asc pubdate_dsc relevance title_az title_za/;
418 @sort_by = $cgi->multi_param('sort_by');
419 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
420 foreach my $sort (@sort_by) {
421 if ( grep { $_ eq $sort } @allowed_sortby ) {
422 $template->param($sort => 1);
425 $template->param('sort_by' => $sort_by[0]);
427 # Use the servers defined, or just search our local catalog(default)
428 my @servers = $cgi->multi_param('server');
430 #FIXME: this should be handled using Context.pm
431 @servers = ("biblioserver");
432 # @servers = C4::Context->config("biblioserver");
435 # operators include boolean and proximity operators and are used
436 # to evaluate multiple operands
437 my @operators = $cgi->multi_param('op');
438 @operators = map { uri_unescape($_) } @operators;
440 # indexes are query qualifiers, like 'title', 'author', etc. They
441 # can be single or multiple parameters separated by comma: kw,right-Truncation
442 my @indexes = $cgi->multi_param('idx');
443 @indexes = map { uri_unescape($_) } @indexes;
445 # if a simple index (only one) display the index used in the top search box
446 if ($indexes[0] && !$indexes[1]) {
447 my $idx = "ms_".$indexes[0];
448 $idx =~ s/\,/comma/g; # template toolkit doesn't like variables with a , in it
449 $idx =~ s/-/dash/g; # template toolkit doesn't like variables with a dash in it
450 $template->param($idx => 1);
452 # an operand can be a single term, a phrase, or a complete ccl query
453 my @operands = $cgi->multi_param('q');
454 @operands = map { uri_unescape($_) } @operands;
456 $template->{VARS}->{querystring} = join(' ', @operands);
458 # if a simple search, display the value in the search box
459 if ($operands[0] && !$operands[1]) {
460 my $ms_query = $operands[0];
461 $ms_query =~ s/ #\S+//;
462 $template->param(ms_value => $ms_query);
465 # limits are use to limit to results to a pre-defined category such as branch or language
466 my @limits = $cgi->multi_param('limit');
467 @limits = map { uri_unescape($_) } @limits;
468 my @nolimits = $cgi->multi_param('nolimit');
469 @nolimits = map { uri_unescape($_) } @nolimits;
470 my %is_nolimit = map { $_ => 1 } @nolimits;
471 @limits = grep { not $is_nolimit{$_} } @limits;
473 if (@searchCategories > 0) {
475 foreach my $typecategory (@searchCategories) {
476 my @itemtypes = Koha::ItemTypes->search({ searchcategory => $typecategory });
477 push @tabcat, $_->itemtype for @itemtypes;
480 foreach my $itemtypeInCategory (@tabcat) {
481 push (@limits, "mc-$itype_or_itemtype,phr:".$itemtypeInCategory);
485 @limits = map { uri_unescape($_) } @limits;
487 if ( $params->{'multibranchlimit'} || ( $branch_group_limit && $branch_group_limit =~ /^multibranchlimit-/ ) ) {
488 my $branchfield = C4::Context->preference('SearchLimitLibrary');
489 my $search_group = Koha::Library::Groups->find( $params->{multibranchlimit} );
491 my @branchcodes = map { $_->branchcode } $search_group->all_libraries;
494 if ( $branchfield eq "homebranch" ) {
495 push @limits, sprintf "(%s)", join " or ", map { 'homebranch: ' . $_ } @branchcodes;
497 elsif ( $branchfield eq "holdingbranch" ) {
498 push @limits, sprintf "(%s)", join " or ", map { 'holdingbranch: ' . $_ } @branchcodes;
501 push @limits, sprintf "(%s or %s)",
502 join( " or ", map { 'homebranch: ' . $_ } @branchcodes ),
503 join( " or ", map { 'holdingbranch: ' . $_ } @branchcodes );
508 for ( my $i=0; $i<@limits; $i++ ) {
509 if ( $limits[$i] =~ /^branch:/ ) {
510 my $branchfield = C4::Context->preference('SearchLimitLibrary');
511 if ( $branchfield eq "homebranch" ) {
512 $limits[$i] =~ s/branch/homebranch/;
514 elsif ( $branchfield eq "holdingbranch" ) {
515 $limits[$i] =~ s/branch/holdingbranch/;
518 my $homebranchlimit = $limits[$i];
519 my $holdingbranchlimit = $limits[$i];
520 $homebranchlimit =~ s/branch/homebranch/;
521 $holdingbranchlimit =~ s/branch/holdingbranch/;
522 $limits[$i] = "($homebranchlimit or $holdingbranchlimit)";
528 foreach my $limit(@limits) {
529 if ($limit =~/available/) {
533 $template->param(available => $available);
535 # append year limits if they exist
536 if ($params->{'limit-yr'}) {
537 if ($params->{'limit-yr'} =~ /\d{4}/) {
538 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
541 #FIXME: Should return a error to the user, incorect date format specified
545 # Params that can only have one value
546 my $scan = $params->{'scan'};
547 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
548 my $countRSS = C4::Context->preference('numSearchRSSResults') || 50;
549 my $results_per_page = $params->{'count'} || $count;
550 my $offset = $params->{'offset'} || 0;
551 $offset = 0 if $offset < 0;
552 my $page = $cgi->param('page') || 1;
553 $offset = ($page-1)*$results_per_page if $page>1;
555 my $weight_search = $cgi->param('advsearch') ? $cgi->param('weight_search') || 0 : 1;
557 # Define some global variables
558 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
561 if (C4::Context->preference('OpacSuppression')) {
562 # OPAC suppression by IP address
563 if (C4::Context->preference('OpacSuppressionByIPRange')) {
564 my $IPAddress = $ENV{'REMOTE_ADDR'};
565 my $IPRange = C4::Context->preference('OpacSuppressionByIPRange');
566 $suppress = ($IPAddress !~ /^$IPRange/);
573 ## I. BUILD THE QUERY
574 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type)
575 = $builder->build_query_compat(
584 suppress => $suppress,
586 weighted_fields => $weight_search
590 $template->param( search_query => $query ) if C4::Context->preference('DumpSearchQueryTemplate');
592 sub _input_cgi_parse {
594 my $query_cgi = shift or return @elements;
595 for my $this_cgi ( split('&',$query_cgi) ) {
596 next unless $this_cgi;
597 $this_cgi =~ /(.*?)=(.*)/;
598 push @elements, { input_name => $1, input_value => Encode::decode_utf8( uri_unescape($2) ) };
603 ## parse the query_cgi string and put it into a form suitable for <input>s
604 my @query_inputs = _input_cgi_parse($query_cgi);
605 $template->param ( QUERY_INPUTS => \@query_inputs );
607 ## parse the limit_cgi string and put it into a form suitable for <input>s
608 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
612 if (C4::Context->preference('OPACShowOpenURL')) {
613 @OpenURL_itypes = split( /\s/, C4::Context->preference('OPACOpenURLItemTypes') );
615 OPACShowOpenURL => 1,
616 OpenURLResolverURL => C4::Context->preference('OpenURLResolverURL'),
617 OpenURLText => C4::Context->preference('OpenURLText'),
618 OpenURLImageLocation => C4::Context->preference('OpenURLImageLocation')
622 $template->param ( LIMIT_INPUTS => \@limit_inputs );
623 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
625 ## II. DO THE SEARCH AND GET THE RESULTS
626 my $total = 0; # the total results for the whole set
627 my $facets; # this object stores the faceted results that display on the left-hand of the results page
631 $query_cgi = "tag=" . uri_escape_utf8( $tag ) . "&" . $query_cgi;
632 my $taglist = get_tags({term=>$tag, approved=>1});
633 $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
634 my @marclist = map { C4::Biblio::GetXmlBiblio( $_->{biblionumber} ) } @$taglist;
635 $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
636 # FIXME: tag search and standard search should work together, not exclusively
637 # FIXME: Because search and standard search don't work together OpacHiddenItems
638 # displays search results which should be hidden.
639 # FIXME: No facets for tags search.
641 $pasarParams .= '&query=' . uri_escape_utf8($query);
642 $pasarParams .= '&count=' . uri_escape_utf8($results_per_page);
643 $pasarParams .= '&simple_query=' . uri_escape_utf8($simple_query);
644 $pasarParams .= '&query_type=' . uri_escape_utf8($query_type) if ($query_type);
645 my $itemtypes_nocategory = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
647 ($error, $results_hashref, $facets) = $searcher->search_compat($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,undef,$itemtypes_nocategory,$query_type,$scan,1);
651 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
652 if (not $tag and ( $@ || $error)) {
653 $template->param(query_error => $error.$@);
654 output_html_with_http_headers $cgi, $cookie, $template->output;
658 # At this point, each server has given us a result set
659 # now we build that set for template display
660 my @sup_results_array;
661 my $search_context = {};
662 $search_context->{'interface'} = 'opac';
663 if (C4::Context->preference('OpacHiddenItemsExceptions')){
664 $search_context->{'category'} = $patron ? $patron->categorycode : q{};
667 my $variables = { anonymous_session => ($borrowernumber) ? 0 : 1 };
669 my @plugin_responses = Koha::Plugins->call(
670 'opac_results_xslt_variables',
673 patron_id => $borrowernumber
676 for my $plugin_variables ( @plugin_responses ) {
677 $variables = { %$variables, %$plugin_variables };
680 for (my $i=0;$i<@servers;$i++) {
681 my $server = $servers[$i];
682 if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
683 $hits = $results_hashref->{$server}->{"hits"};
684 my $page = $cgi->param('page') || 0;
685 my @newresults = searchResults( $search_context, $query_desc, $hits, $results_per_page, $offset, $scan,
686 $results_hashref->{$server}->{"RECORDS"}, $variables);
687 $hits = 0 unless @newresults;
690 if( C4::Context->preference('ArticleRequests') ) {
691 $art_req_itypes = Koha::CirculationRules->guess_article_requestable_itemtypes({ $patron ? ( categorycode => $patron->categorycode ) : () });
694 foreach my $res (@newresults) {
696 # must define a value for size if not present in DB
697 # in order to avoid problems generated by the default size value in TT
698 if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
699 # while we're checking each line, see if item is in the cart
700 if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
701 $res->{'incart'} = 1;
704 if (C4::Context->preference('COinSinOPACResults')) {
705 my $biblio = Koha::Biblios->find( $res->{'biblionumber'} );
706 # Catch the exception as Koha::Biblio::Metadata->record can explode if the MARCXML is invalid
707 $res->{coins} = $biblio ? eval {$biblio->get_coins} : q{}; # FIXME This should be moved at the beginning of the @newresults loop
709 if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
710 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
711 $isbn = $isbn->as_isbn13->as_string;
713 my $social_datas = C4::SocialData::get_data( $isbn );
714 if ( $social_datas ) {
715 for my $key ( keys %$social_datas ) {
716 $res->{$key} = $$social_datas{$key};
717 if ( $key eq 'score_avg' ){
718 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
725 if (C4::Context->preference('TagsEnabled') and
726 C4::Context->preference('TagsShowOnList')) {
727 if ( my $bibnum = $res->{biblionumber} ) {
728 $res->{itemsissued} = CountItemsIssued( $bibnum );
729 $res->{'TagLoop'} = get_tags({
730 biblionumber => $bibnum,
733 limit => C4::Context->preference('TagsShowOnList')
738 $res->{shelves} = Koha::Virtualshelves->get_shelves_containing_record(
740 biblionumber => $res->{biblionumber},
741 borrowernumber => $borrowernumber
745 if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
746 my $ratings = Koha::Ratings->search({ biblionumber => $res->{biblionumber} });
747 $res->{ratings} = $ratings;
748 $res->{my_rating} = $borrowernumber ? $ratings->search({ borrowernumber => $borrowernumber })->next : undef;
751 # BZ17530: 'Intelligent' guess if result can be article requested
752 $res->{artreqpossible} = ( $art_req_itypes->{ $res->{itemtype} // q{} } || $art_req_itypes->{ '*' } ) ? 1 : q{};
755 if ($results_hashref->{$server}->{"hits"}){
756 $total = $total + $hits;
759 # Opac search history
760 if (C4::Context->preference('EnableOpacSearchHistory')) {
762 my $path_info = $cgi->url(-path_info=>1);
763 my $query_cgi_history = $cgi->url(-query=>1);
764 $query_cgi_history =~ s/^$path_info\?//;
765 $query_cgi_history =~ s/;/&/g;
766 my $query_desc_history = join ", ", grep { defined $_ } $query_desc, $limit_desc;
768 unless ( $borrowernumber ) {
769 my $new_searches = C4::Search::History::add_to_session({
771 query_desc => $query_desc_history,
772 query_cgi => $query_cgi_history,
777 # To the session (the user is logged in)
778 C4::Search::History::add({
779 userid => $borrowernumber,
780 sessionid => $cgi->cookie("CGISESSID"),
781 query_desc => $query_desc_history,
782 query_cgi => $query_cgi_history,
788 $template->param( EnableOpacSearchHistory => 1 );
791 ## If there's just one result, redirect to the detail page
792 if ($total == 1 && $format ne 'rss'
793 && $format ne 'opensearchdescription' && $format ne 'atom') {
794 my $biblionumber=$newresults[0]->{biblionumber};
795 if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
796 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
797 } elsif (C4::Context->preference('BiblioDefaultView') eq 'marc') {
798 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
800 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
805 # We build the encrypted list of first OPACnumSearchResults biblios to pass with the search criteria for paging on opac-detail
806 $pasarParams .= '&listBiblios=';
808 foreach (@newresults) {
809 my $bibnum = ($_->{biblionumber})?$_->{biblionumber}:0;
810 $pasarParams .= uri_escape_utf8($bibnum) . ',';
812 last if ($j == $results_per_page);
814 chop $pasarParams if ($pasarParams =~ /,$/);
815 $pasarParams .= '&total=' . uri_escape_utf8( int($total) ) if ($pasarParams !~ /total=(?:[0-9]+)?/);
817 my $session = get_session($cgi->cookie("CGISESSID"));
818 $session->param('busc' => $pasarParams);
820 $template->param(total => $hits);
821 my $limit_cgi_not_availablity = $limit_cgi;
822 $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
823 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
824 $template->param(limit_cgi => $limit_cgi);
825 $template->param(countrss => $countRSS );
826 $template->param(query_cgi => $query_cgi);
827 $template->param(query_desc => $query_desc);
828 $template->param(limit_desc => $limit_desc);
829 $template->param(offset => $offset);
830 $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
831 if ($query_desc || $limit_desc) {
832 $template->param(searchdesc => 1);
834 $template->param(results_per_page => $results_per_page);
835 my $hide = ($hidingrules) ? 1 : 0;
837 if (C4::Context->userenv){
838 $branch = C4::Context->userenv->{branch};
840 if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
842 ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
844 C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
847 if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
848 $branchcode = $branch;
850 elsif ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
851 $branchcode = $ENV{'BRANCHCODE'};
854 foreach my $res ( @newresults ) {
857 my @old_loop = @{$res->{'available_items_loop'}};
858 foreach my $item ( @old_loop ) {
859 if ( $item->{'branchcode'} eq $branchcode ) {
860 $item->{'this_branch'} = 1;
861 push( @top_loop, $item );
863 push( @new_loop, $item );
866 my @complete_loop = ( @top_loop, @new_loop );
867 $res->{'available_items_loop'} = \@complete_loop;
873 SEARCH_RESULTS => \@newresults,
874 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
875 suppress_result_number => $hide,
877 if (C4::Context->preference("OPACLocalCoverImages")){
878 $template->param(OPACLocalCoverImages => 1);
879 $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
881 ## Build the page numbers on the bottom of the page
882 my ( $page_numbers, $hits_to_paginate, $pages, $current_page_number, $previous_page_offset, $next_page_offset, $last_page_offset ) =
883 Koha::SearchEngine::Search->pagination_bar(
886 max_result_window => $searcher->max_result_window,
887 results_per_page => $results_per_page,
892 $template->param( hits_to_paginate => $hits_to_paginate );
893 $template->param( PAGE_NUMBERS => $page_numbers,
894 last_page_offset => $last_page_offset,
895 previous_page_offset => $previous_page_offset) unless $pages < 2;
896 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
900 my $nohits = C4::Context->preference('OPACNoResultsFound');
901 if ($nohits and $nohits=~/{QUERY_KW}/){
902 # extracting keywords in case of relaunching search
903 (my $query_kw=$query_desc)=~s/ and|or / /g;
904 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^:]|$)/g);
905 $query_kw=join('+',@query_kw);
906 $nohits=~s/{QUERY_KW}/$query_kw/g;
907 $template->param('OPACNoResultsFound' =>$nohits);
911 query_desc => $query_desc,
912 limit_desc => $limit_desc,
913 query_cgi => $query_cgi,
914 limit_cgi => $limit_cgi
917 } # end of the if local
918 # asynchronously search the authority server
919 elsif ($server && $server =~/authorityserver/) { # this is the local authority server
920 my @inner_sup_results_array;
921 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
922 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
923 my $title_field = $marc_record_object->field(100);
924 push @inner_sup_results_array, {
925 'title' => $title_field->subfield('a'),
926 'link' => "&idx=an&q=".$marc_record_object->field('001')->as_string(),
929 my $servername = $server;
930 push @sup_results_array, { servername => $servername,
931 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
933 # FIXME: can add support for other targets as needed here
934 $template->param( outer_sup_results_loop => \@sup_results_array);
935 } #/end of the for loop
937 for my $facet ( @$facets ) {
938 for my $entry ( @{ $facet->{facets} } ) {
939 my $index = $entry->{type_link_value};
940 my $value = $entry->{facet_link_value};
941 $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
947 #classlist => $classlist,
950 facets_loop => $facets,
951 displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
953 search_error => $error,
956 if ($query_desc || $limit_desc) {
957 $template->param(searchdesc => 1);
960 # VI. BUILD THE TEMPLATE
961 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
963 borrowernumber => $borrowernumber,
968 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
970 borrowernumber => $borrowernumber,
977 add_to_some_private_shelves => $some_private_shelves,
978 add_to_some_public_shelves => $some_public_shelves,
981 my $content_type = ($format eq 'rss' or $format eq 'atom' or $format eq 'opensearchdescription') ? $format : 'html';
983 $template->{VARS}->{DidYouMean} =
984 ( defined C4::Context->preference('OPACdidyoumean')
985 && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
988 $template->param(firstPage => 1);
991 $template->param( borrowernumber => $borrowernumber);
992 output_with_http_headers $cgi, $cookie, $template->output, $content_type;