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/;
33 use Data::Dumper; # TODO remove
35 use Koha::SearchEngine::Search;
36 use Koha::SearchEngine::QueryBuilder;
38 my $searchengine = C4::Context->preference("SearchEngine");
39 my ($builder, $searcher);
40 #$searchengine = 'Zebra'; # XXX
41 $builder = Koha::SearchEngine::QueryBuilder->new({index => 'biblios'});
42 $searcher = Koha::SearchEngine::Search->new({index => 'biblios'});
45 use C4::Auth qw(:DEFAULT get_session);
46 use C4::Languages qw(getLanguages);
48 use C4::Search::History;
49 use C4::Biblio; # Unused here?
51 use C4::Tags qw(get_tags);
53 use C4::External::OverDrive;
55 use Koha::CirculationRules;
59 use Koha::Virtualshelves;
60 use Koha::Library::Groups;
62 use Koha::SearchFields;
64 use POSIX qw(ceil floor strftime);
66 use JSON qw/decode_json encode_json/;
69 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
70 # create a new CGI object
71 # FIXME: no_undef_params needs to be tested
72 use CGI qw('-no_undef_params' -utf8);
75 my $branch_group_limit = $cgi->param("branch_group_limit");
76 if ( $branch_group_limit ) {
77 if ( $branch_group_limit =~ /^multibranchlimit-/ ) {
78 # For search groups we are going to convert this branch_group_limit CGI
79 # parameter into a multibranchlimit CGI parameter for the purposes of
80 # actually performing the query
82 -name => 'multibranchlimit',
83 -values => substr($branch_group_limit, 17)
88 -values => [ $branch_group_limit ]
94 if (C4::Context->preference('BakerTaylorEnabled')) {
95 require C4::External::BakerTaylor;
96 import C4::External::BakerTaylor qw(&image_url &link_url);
100 my ($template,$borrowernumber,$cookie);
101 # decide which template to use
103 my $template_type = 'basic';
104 my @params = $cgi->multi_param("limit");
105 my @searchCategories = $cgi->multi_param('searchcat');
107 my $format = $cgi->param("format") || '';
108 my $build_grouped_results = C4::Context->preference('OPACGroupResults');
109 if ($format =~ /(rss|atom|opensearchdescription)/) {
110 $template_name = 'opac-opensearch.tt';
112 elsif (@params && $build_grouped_results) {
113 $template_name = 'opac-results-grouped.tt';
115 elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) || @searchCategories ) {
116 $template_name = 'opac-results.tt';
119 $template_name = 'opac-advsearch.tt';
120 $template_type = 'advsearch';
123 $format = 'rss' if $format =~ /^rss2?$/;
126 ($template, $borrowernumber, $cookie) = get_template_and_user({
127 template_name => $template_name,
130 authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
133 my $patron = Koha::Patrons->find( $borrowernumber );
135 my $lang = C4::Languages::getlanguage($cgi);
137 if ($template_name eq 'opac-results.tt') {
138 $template->param('COinSinOPACResults' => C4::Context->preference('COinSinOPACResults'));
141 # get biblionumbers stored in the cart
144 if($cgi->cookie("bib_list")){
145 my $cart_list = $cgi->cookie("bib_list");
146 @cart_list = split(/\//, $cart_list);
149 if ($format eq 'rss' or $format eq 'opensearchdescription' or $format eq 'atom') {
150 $template->param($format => 1);
151 $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime)) if ($format eq 'atom');
152 # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
153 # entry, but not sure if that's worth an extra database query for each bib
155 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
156 $template->param('UNIMARC' => 1);
158 elsif (C4::Context->preference("marcflavour") eq "MARC21" ) {
159 $template->param('usmarc' => 1);
162 $template->param( 'OPACNoResultsFound' => C4::Context->preference('OPACNoResultsFound') );
165 OpacStarRatings => C4::Context->preference("OpacStarRatings") );
167 if (C4::Context->preference('BakerTaylorEnabled')) {
169 BakerTaylorEnabled => 1,
170 BakerTaylorImageURL => &image_url(),
171 BakerTaylorLinkURL => &link_url(),
172 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
176 if (C4::Context->preference('TagsEnabled')) {
177 $template->param(TagsEnabled => 1);
178 foreach (qw(TagsShowOnList TagsInputOnList)) {
179 C4::Context->preference($_) and $template->param($_ => 1);
184 # Deprecated, but preserved because it's interesting :-)
185 # The same thing can be accomplished with mod_rewrite in
189 #my $uri = $cgi->url(-base => 1);
190 #my $relative_url = $cgi->url(-relative=>1);
191 #$uri.="/".$relative_url."?";
193 #my @cgi_params_list = $cgi->param();
194 #my $url_params = $cgi->Vars;
196 #for my $each_param_set (@cgi_params_list) {
197 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
199 #warn "New URI:$uri";
200 # Only re-write a URI if there are params or if it already hasn't been re-written
201 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
202 # print $cgi->redirect( -uri=>$uri."&r=1",
203 # -cookie => $cookie);
209 if ($cgi->param("returntosearch")) {
210 $template->param('ReturnToSearch' => 1);
212 if ($cgi->cookie("search_path_code")) {
213 my $pathcode = $cgi->cookie("search_path_code");
214 if ($pathcode eq '"ads"') {
215 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?returntosearch=1');
217 elsif ($pathcode eq '"exs"') {
218 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?expanded_options=1&returntosearch=1');
221 warn "ReturnPath switch error";
225 my @search_groups = Koha::Library::Groups->get_search_groups();
226 $template->param( search_groups => \@search_groups );
228 # load the language limits (for search)
229 my $languages_limit_loop = getLanguages($lang, 1);
230 $template->param(search_languages_loop => $languages_limit_loop,);
232 # load the Type stuff
233 my $itemtypes = GetItemTypesCategorized;
234 # add translated_description to itemtypes
235 foreach my $itemtype ( keys %{$itemtypes} ) {
236 # Itemtypes search categories don't have (yet) translated descriptions, they are auth values (and could still have no descriptions too BZ 18400)
237 # If 'iscat' (see ITEMTYPECAT) then there is no itemtype and the description is not translated
238 my $translated_description = $itemtypes->{$itemtype}->{iscat}
239 ? $itemtypes->{$itemtype}->{description}
240 : Koha::ItemTypes->find($itemtype)->translated_description;
241 $itemtypes->{$itemtype}->{translated_description} = $translated_description || $itemtypes->{$itemtype}->{description} || q{};
244 # the index parameter is different for item-level itemtypes
245 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
246 my @advancedsearchesloop;
248 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
249 my @advanced_search_types = split(/\|/, $advanced_search_types);
251 my $hidingrules = {};
252 my $yaml = C4::Context->preference('OpacHiddenItems');
253 if ( $yaml =~ /\S/ ) {
254 $yaml = "$yaml\n\n"; # YAML expects trailing newline. Surplus does not hurt.
256 $hidingrules = YAML::Load($yaml);
259 warn "Unable to parse OpacHiddenItems syspref : $@";
263 my @sorted_itemtypes = sort { $itemtypes->{$a}->{translated_description} cmp $itemtypes->{$b}->{translated_description} } keys %$itemtypes;
264 foreach my $advanced_srch_type (@advanced_search_types) {
265 $advanced_srch_type =~ s/^\s*//;
266 $advanced_srch_type =~ s/\s*$//;
267 if ($advanced_srch_type eq 'itemtypes') {
268 # itemtype is a special case, since it's not defined in authorized values
270 foreach my $thisitemtype ( @sorted_itemtypes ) {
271 next if $hidingrules->{itype} && any { $_ eq $thisitemtype } @{$hidingrules->{itype}};
272 next if $hidingrules->{itemtype} && any { $_ eq $thisitemtype } @{$hidingrules->{itemtype}};
273 my %row =( number=>$cnt++,
274 ccl => "$itype_or_itemtype,phr",
275 code => $thisitemtype,
276 description => $itemtypes->{$thisitemtype}->{translated_description},
277 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
278 cat => $itemtypes->{$thisitemtype}->{'iscat'},
279 hideinopac => $itemtypes->{$thisitemtype}->{'hideinopac'},
280 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
282 if ( !$itemtypes->{$thisitemtype}->{'hideinopac'} ) {
283 push @itypesloop, \%row;
286 my %search_code = ( advanced_search_type => $advanced_srch_type,
287 code_loop => \@itypesloop );
288 push @advancedsearchesloop, \%search_code;
290 # covers all the other cases: non-itemtype authorized values
291 my $advsearchtypes = GetAuthorisedValues($advanced_srch_type, 'opac');
293 for my $thisitemtype (@$advsearchtypes) {
294 my $hiding_key = lc $thisitemtype->{category};
295 $hiding_key = "location" if $hiding_key eq 'loc';
296 next if $hidingrules->{$hiding_key} && any { $_ eq $thisitemtype->{authorised_value} } @{$hidingrules->{$hiding_key}};
299 ccl => $advanced_srch_type,
300 code => $thisitemtype->{authorised_value},
301 description => $thisitemtype->{'lib_opac'} || $thisitemtype->{'lib'},
302 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
303 imageurl => getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
305 push @authvalueloop, \%row;
307 my %search_code = ( advanced_search_type => $advanced_srch_type,
308 code_loop => \@authvalueloop );
309 push @advancedsearchesloop, \%search_code;
312 $template->param(advancedsearchesloop => \@advancedsearchesloop);
314 # The following should only be loaded if we're bringing up the advanced search template
315 if ( $template_type && $template_type eq 'advsearch' ) {
316 # load the servers (used for searching -- to do federated searching, etc.)
317 my $primary_servers_loop;# = displayPrimaryServers();
318 $template->param(outer_servers_loop => $primary_servers_loop,);
320 my $secondary_servers_loop;
321 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
323 # set the default sorting
324 if ( C4::Context->preference('OPACdefaultSortField')
325 && C4::Context->preference('OPACdefaultSortOrder') ) {
326 my $default_sort_by =
327 C4::Context->preference('OPACdefaultSortField') . '_'
328 . C4::Context->preference('OPACdefaultSortOrder');
329 $template->param( sort_by => $default_sort_by );
332 # determine what to display next to the search boxes (ie, boolean option
333 # shouldn't appear on the first one, scan indexes should, adding a new
334 # box should only appear on the last, etc.
335 my @search_boxes_array;
336 my $search_boxes_count = 3; # begin with 3 boxes
337 $template->param( search_boxes_count => $search_boxes_count );
339 if ($cgi->cookie("num_paragraph")){
340 $search_boxes_count = $cgi->cookie("num_paragraph");
343 for (my $i=1;$i<=$search_boxes_count;$i++) {
344 # if it's the first one, don't display boolean option, but show scan indexes
346 push @search_boxes_array,
352 # if it's the last one, show the 'add field' box
353 elsif ($i==$search_boxes_count) {
354 push @search_boxes_array,
361 push @search_boxes_array,
369 my @advsearch_limits = split /,/, C4::Context->preference('OpacAdvSearchOptions');
370 my @advsearch_more_limits = split /,/,
371 C4::Context->preference('OpacAdvSearchMoreOptions');
373 uc( C4::Context->preference("marcflavour") ) => 1, # we already did this for UNIMARC
375 search_boxes_loop => \@search_boxes_array,
376 OpacAdvSearchOptions => \@advsearch_limits,
377 OpacAdvSearchMoreOptions => \@advsearch_more_limits,
380 # use the global setting by default
381 if ( C4::Context->preference("expandedSearchOption") == 1 ) {
382 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
384 # but let the user override it
385 if (defined $cgi->param('expanded_options')) {
386 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
387 $template->param( expanded_options => scalar $cgi->param('expanded_options'));
392 output_html_with_http_headers $cgi, $cookie, $template->output;
396 ### OK, if we're this far, we're performing an actual search
398 # Fetch the paramater list as a hash in scalar context:
399 # * returns paramater list as tied hash ref
400 # * we can edit the values by changing the key
401 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
402 my $params = $cgi->Vars;
404 if ( $params->{tag} ) {
405 $tag = $params->{tag};
406 $template->param( tag => $tag );
409 # String with params with the search criteria for the paging in opac-detail
410 # param value is URI encoded and params separator is HTML encode (&)
411 my $pasarParams = '';
413 for (keys %$params) {
414 my @pasarParam = $cgi->multi_param($_);
415 for my $paramValue(@pasarParam) {
416 $pasarParams .= '&' if ($j > 0);
417 $pasarParams .= $_ . '=' . uri_escape_utf8($paramValue);
422 # Params that can have more than one value
423 # sort by is used to sort the query
424 # in theory can have more than one but generally there's just one
427 if ( C4::Context->preference('OPACdefaultSortField')
428 && C4::Context->preference('OPACdefaultSortOrder') ) {
430 C4::Context->preference('OPACdefaultSortField') . '_'
431 . C4::Context->preference('OPACdefaultSortOrder');
434 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/;
435 @sort_by = $cgi->multi_param('sort_by');
436 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
437 foreach my $sort (@sort_by) {
438 if ( grep { $_ eq $sort } @allowed_sortby ) {
439 $template->param($sort => 1);
442 $template->param('sort_by' => $sort_by[0]);
444 # Use the servers defined, or just search our local catalog(default)
445 my @servers = $cgi->multi_param('server');
447 #FIXME: this should be handled using Context.pm
448 @servers = ("biblioserver");
449 # @servers = C4::Context->config("biblioserver");
452 # operators include boolean and proximity operators and are used
453 # to evaluate multiple operands
454 my @operators = $cgi->multi_param('op');
455 @operators = map { uri_unescape($_) } @operators;
457 # indexes are query qualifiers, like 'title', 'author', etc. They
458 # can be single or multiple parameters separated by comma: kw,right-Truncation
459 my @indexes = $cgi->multi_param('idx');
460 @indexes = map { uri_unescape($_) } @indexes;
462 # if a simple index (only one) display the index used in the top search box
463 if ($indexes[0] && !$indexes[1]) {
464 my $idx = "ms_".$indexes[0];
465 $idx =~ s/\,/comma/g; # template toolkit doesn't like variables with a , in it
466 $idx =~ s/-/dash/g; # template toolkit doesn't like variables with a dash in it
467 $template->param($idx => 1);
469 # an operand can be a single term, a phrase, or a complete ccl query
470 my @operands = $cgi->multi_param('q');
471 @operands = map { uri_unescape($_) } @operands;
473 $template->{VARS}->{querystring} = join(' ', @operands);
475 # if a simple search, display the value in the search box
476 if ($operands[0] && !$operands[1]) {
477 my $ms_query = $operands[0];
478 $ms_query =~ s/ #\S+//;
479 $template->param(ms_value => $ms_query);
482 # limits are use to limit to results to a pre-defined category such as branch or language
483 my @limits = $cgi->multi_param('limit');
484 @limits = map { uri_unescape($_) } @limits;
485 my @nolimits = $cgi->multi_param('nolimit');
486 @nolimits = map { uri_unescape($_) } @nolimits;
487 my %is_nolimit = map { $_ => 1 } @nolimits;
488 @limits = grep { not $is_nolimit{$_} } @limits;
490 if (@searchCategories > 0) {
492 foreach my $typecategory (@searchCategories) {
493 my @itemtypes = Koha::ItemTypes->search({ searchcategory => $typecategory });
494 push @tabcat, $_->itemtype for @itemtypes;
497 foreach my $itemtypeInCategory (@tabcat) {
498 push (@limits, "mc-$itype_or_itemtype,phr:".$itemtypeInCategory);
502 @limits = map { uri_unescape($_) } @limits;
504 if($params->{'multibranchlimit'}) {
505 my $search_group = Koha::Library::Groups->find( $params->{multibranchlimit} );
506 my @libraries = $search_group->all_libraries;
507 my $multibranch = '('.join( " OR ", map { 'homebranch: ' . $_->branchcode } @libraries ) .')';
508 push @limits, $multibranch if ($multibranch ne '()');
512 foreach my $limit(@limits) {
513 if ($limit =~/available/) {
517 $template->param(available => $available);
519 # append year limits if they exist
520 if ($params->{'limit-yr'}) {
521 if ($params->{'limit-yr'} =~ /\d{4}/) {
522 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
525 #FIXME: Should return a error to the user, incorect date format specified
529 # Params that can only have one value
530 my $scan = $params->{'scan'};
531 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
532 my $countRSS = C4::Context->preference('numSearchRSSResults') || 50;
533 my $results_per_page = $params->{'count'} || $count;
534 my $offset = $params->{'offset'} || 0;
535 $offset = 0 if $offset < 0;
536 my $page = $cgi->param('page') || 1;
537 $offset = ($page-1)*$results_per_page if $page>1;
540 # Define some global variables
541 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
546 if (C4::Context->preference('OpacSuppression')) {
547 # OPAC suppression by IP address
548 if (C4::Context->preference('OpacSuppressionByIPRange')) {
549 my $IPAddress = $ENV{'REMOTE_ADDR'};
550 my $IPRange = C4::Context->preference('OpacSuppressionByIPRange');
551 $suppress = ($IPAddress !~ /^$IPRange/);
558 ## I. BUILD THE QUERY
559 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type)
560 = $builder->build_query_compat(
569 suppress => $suppress,
571 weighted_fields => !$cgi->param('advsearch')
575 $template->param( search_query => $query ) if C4::Context->preference('DumpSearchQueryTemplate');
577 sub _input_cgi_parse {
579 my $query_cgi = shift or return @elements;
580 for my $this_cgi ( split('&',$query_cgi) ) {
581 next unless $this_cgi;
582 $this_cgi =~ /(.*?)=(.*)/;
583 push @elements, { input_name => $1, input_value => Encode::decode_utf8( uri_unescape($2) ) };
588 ## parse the query_cgi string and put it into a form suitable for <input>s
589 my @query_inputs = _input_cgi_parse($query_cgi);
590 $template->param ( QUERY_INPUTS => \@query_inputs );
592 ## parse the limit_cgi string and put it into a form suitable for <input>s
593 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
597 if (C4::Context->preference('OPACShowOpenURL')) {
598 @OpenURL_itypes = split( /\s/, C4::Context->preference('OPACOpenURLItemTypes') );
600 OPACShowOpenURL => 1,
601 OpenURLResolverURL => C4::Context->preference('OpenURLResolverURL'),
602 OpenURLText => C4::Context->preference('OpenURLText'),
603 OpenURLImageLocation => C4::Context->preference('OpenURLImageLocation')
607 $template->param ( LIMIT_INPUTS => \@limit_inputs );
608 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
610 ## II. DO THE SEARCH AND GET THE RESULTS
611 my $total = 0; # the total results for the whole set
612 my $facets; # this object stores the faceted results that display on the left-hand of the results page
618 $query_cgi = "tag=" . uri_escape_utf8( $tag ) . "&" . $query_cgi;
619 my $taglist = get_tags({term=>$tag, approved=>1});
620 $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
621 my @marclist = map { C4::Biblio::GetXmlBiblio( $_->{biblionumber} ) } @$taglist;
622 $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
623 $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
624 # FIXME: tag search and standard search should work together, not exclusively
625 # FIXME: Because search and standard search don't work together OpacHiddenItems
626 # displays search results which should be hidden.
627 # FIXME: No facets for tags search.
628 } elsif ($build_grouped_results) {
630 ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,undef,$query_type,$scan);
633 $pasarParams .= '&query=' . uri_escape_utf8($query);
634 $pasarParams .= '&count=' . uri_escape_utf8($results_per_page);
635 $pasarParams .= '&simple_query=' . uri_escape_utf8($simple_query);
636 $pasarParams .= '&query_type=' . uri_escape_utf8($query_type) if ($query_type);
637 my $itemtypes_nocategory = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
639 ($error, $results_hashref, $facets) = $searcher->search_compat($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,undef,$itemtypes_nocategory,$query_type,$scan,1);
643 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
644 if (not $tag and ( $@ || $error)) {
645 $template->param(query_error => $error.$@);
646 output_html_with_http_headers $cgi, $cookie, $template->output;
650 # At this point, each server has given us a result set
651 # now we build that set for template display
652 my @sup_results_array;
653 my $search_context = {};
654 $search_context->{'interface'} = 'opac';
655 if (C4::Context->preference('OpacHiddenItemsExceptions')){
656 $search_context->{'category'} = $patron ? $patron->categorycode : q{};
659 for (my $i=0;$i<@servers;$i++) {
660 my $server = $servers[$i];
661 if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
662 $hits = $results_hashref->{$server}->{"hits"};
663 my $page = $cgi->param('page') || 0;
665 if ($build_grouped_results) {
666 foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
667 # because pazGetRecords handles retieving only the records
668 # we want as specified by $offset and $results_per_page,
669 # we need to set the offset parameter of searchResults to 0
670 my @group_results = searchResults( $search_context, $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
671 $group->{"RECORDS"});
672 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
675 @newresults = searchResults( $search_context, $query_desc, $hits, $results_per_page, $offset, $scan,
676 $results_hashref->{$server}->{"RECORDS"});
678 $hits = 0 unless @newresults;
681 if( C4::Context->preference('ArticleRequests') ) {
682 $art_req_itypes = Koha::CirculationRules->guess_article_requestable_itemtypes({ $patron ? ( categorycode => $patron->categorycode ) : () });
685 foreach my $res (@newresults) {
687 # must define a value for size if not present in DB
688 # in order to avoid problems generated by the default size value in TT
689 if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
690 # while we're checking each line, see if item is in the cart
691 if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
692 $res->{'incart'} = 1;
695 if (C4::Context->preference('COinSinOPACResults')) {
696 my $biblio = Koha::Biblios->find( $res->{'biblionumber'} );
697 # Catch the exception as Koha::Biblio::Metadata->record can explode if the MARCXML is invalid
698 $res->{coins} = $biblio ? eval {$biblio->get_coins} : q{}; # FIXME This should be moved at the beginning of the @newresults loop
700 if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
701 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
702 $isbn = $isbn->as_isbn13->as_string;
704 my $social_datas = C4::SocialData::get_data( $isbn );
705 if ( $social_datas ) {
706 for my $key ( keys %$social_datas ) {
707 $res->{$key} = $$social_datas{$key};
708 if ( $key eq 'score_avg' ){
709 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
716 if (C4::Context->preference('TagsEnabled') and
717 C4::Context->preference('TagsShowOnList')) {
718 if ( my $bibnum = $res->{biblionumber} ) {
719 $res->{itemsissued} = CountItemsIssued( $bibnum );
720 $res->{'TagLoop'} = get_tags({
721 biblionumber => $bibnum,
724 limit => C4::Context->preference('TagsShowOnList')
729 $res->{shelves} = Koha::Virtualshelves->get_shelves_containing_record(
731 biblionumber => $res->{biblionumber},
732 borrowernumber => $borrowernumber
736 if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
737 my $ratings = Koha::Ratings->search({ biblionumber => $res->{biblionumber} });
738 $res->{ratings} = $ratings;
739 $res->{my_rating} = $borrowernumber ? $ratings->search({ borrowernumber => $borrowernumber })->next : undef;
742 # BZ17530: 'Intelligent' guess if result can be article requested
743 $res->{artreqpossible} = ( $art_req_itypes->{ $res->{itemtype} // q{} } || $art_req_itypes->{ '*' } ) ? 1 : q{};
746 if ($results_hashref->{$server}->{"hits"}){
747 $total = $total + $hits;
750 # Opac search history
751 if (C4::Context->preference('EnableOpacSearchHistory')) {
753 my $path_info = $cgi->url(-path_info=>1);
754 my $query_cgi_history = $cgi->url(-query=>1);
755 $query_cgi_history =~ s/^$path_info\?//;
756 $query_cgi_history =~ s/;/&/g;
757 my $query_desc_history = join ", ", grep { defined $_ } $query_desc, $limit_desc;
759 unless ( $borrowernumber ) {
760 my $new_searches = C4::Search::History::add_to_session({
762 query_desc => $query_desc_history,
763 query_cgi => $query_cgi_history,
768 # To the session (the user is logged in)
769 C4::Search::History::add({
770 userid => $borrowernumber,
771 sessionid => $cgi->cookie("CGISESSID"),
772 query_desc => $query_desc_history,
773 query_cgi => $query_cgi_history,
779 $template->param( EnableOpacSearchHistory => 1 );
782 ## If there's just one result, redirect to the detail page
783 if ($total == 1 && $format ne 'rss'
784 && $format ne 'opensearchdescription' && $format ne 'atom') {
785 my $biblionumber=$newresults[0]->{biblionumber};
786 if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
787 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
788 } elsif (C4::Context->preference('BiblioDefaultView') eq 'marc') {
789 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
791 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
796 if ( !$build_grouped_results ) {
797 # We build the encrypted list of first OPACnumSearchResults biblios to pass with the search criteria for paging on opac-detail
798 $pasarParams .= '&listBiblios=';
800 foreach (@newresults) {
801 my $bibnum = ($_->{biblionumber})?$_->{biblionumber}:0;
802 $pasarParams .= uri_escape_utf8($bibnum) . ',';
804 last if ($j == $results_per_page);
806 chop $pasarParams if ($pasarParams =~ /,$/);
807 $pasarParams .= '&total=' . uri_escape_utf8( int($total) ) if ($pasarParams !~ /total=(?:[0-9]+)?/);
809 my $session = get_session($cgi->cookie("CGISESSID"));
810 $session->param('busc' => $pasarParams);
814 $template->param(total => $hits);
815 my $limit_cgi_not_availablity = $limit_cgi;
816 $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
817 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
818 $template->param(limit_cgi => $limit_cgi);
819 $template->param(countrss => $countRSS );
820 $template->param(query_cgi => $query_cgi);
821 $template->param(query_desc => $query_desc);
822 $template->param(limit_desc => $limit_desc);
823 $template->param(offset => $offset);
824 $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
825 if ($query_desc || $limit_desc) {
826 $template->param(searchdesc => 1);
828 $template->param(results_per_page => $results_per_page);
829 my $hide = C4::Context->preference('OpacHiddenItems');
830 $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
832 if (C4::Context->userenv){
833 $branch = C4::Context->userenv->{branch};
835 if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
837 ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
839 C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
842 if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
843 $branchcode = $branch;
845 elsif ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
846 $branchcode = $ENV{'BRANCHCODE'};
849 foreach my $res ( @newresults ) {
852 my @old_loop = @{$res->{'available_items_loop'}};
853 foreach my $item ( @old_loop ) {
854 if ( $item->{'branchcode'} eq $branchcode ) {
855 $item->{'this_branch'} = 1;
856 push( @top_loop, $item );
858 push( @new_loop, $item );
861 my @complete_loop = ( @top_loop, @new_loop );
862 $res->{'available_items_loop'} = \@complete_loop;
868 SEARCH_RESULTS => \@newresults,
869 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
870 suppress_result_number => $hide,
872 if (C4::Context->preference("OPACLocalCoverImages")){
873 $template->param(OPACLocalCoverImages => 1);
874 $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
876 ## Build the page numbers on the bottom of the page
878 my $max_result_window = $searcher->max_result_window;
879 my $hits_to_paginate = ($max_result_window && $max_result_window < $hits) ? $max_result_window : $hits;
880 $template->param( hits_to_paginate => $hits_to_paginate );
881 # total number of pages there will be
882 my $pages = ceil($hits_to_paginate / $results_per_page);
883 my $last_page_offset = ( $pages - 1 ) * $results_per_page;
884 # default page number
885 my $current_page_number = 1;
887 $current_page_number = ( $offset / $results_per_page + 1 );
889 my $previous_page_offset;
890 if ( $offset >= $results_per_page ) {
891 $previous_page_offset = $offset - $results_per_page;
893 my $next_page_offset = $offset + $results_per_page;
894 # If we're within the first 10 pages, keep it simple
895 #warn "current page:".$current_page_number;
896 if ($current_page_number < 10) {
897 # just show the first 10 pages
898 # Loop through the pages
899 my $pages_to_show = 10;
900 $pages_to_show = $pages if $pages<10;
901 for ($i=1; $i<=$pages_to_show;$i++) {
902 # the offset for this page
903 my $this_offset = (($i*$results_per_page)-$results_per_page);
904 # the page number for this page
905 my $this_page_number = $i;
906 # put it in the array
908 { offset => $this_offset,
909 pg => $this_page_number,
910 highlight => $this_page_number == $current_page_number,
911 sort_by => join ' ', @sort_by
917 # now, show twenty pages, with the current one smack in the middle
919 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
920 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
921 my $this_page_number = $i-9;
922 if ( $this_page_number <= $pages ) {
924 { offset => $this_offset,
925 pg => $this_page_number,
926 highlight => $this_page_number == $current_page_number,
927 sort_by => join ' ', @sort_by
933 $template->param( PAGE_NUMBERS => \@page_numbers,
934 last_page_offset => $last_page_offset,
935 previous_page_offset => $previous_page_offset) unless $pages < 2;
936 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
940 my $nohits = C4::Context->preference('OPACNoResultsFound');
941 if ($nohits and $nohits=~/{QUERY_KW}/){
942 # extracting keywords in case of relaunching search
943 (my $query_kw=$query_desc)=~s/ and|or / /g;
944 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^,:]|$)/g);
945 $query_kw=join('+',@query_kw);
946 $nohits=~s/{QUERY_KW}/$query_kw/g;
947 $template->param('OPACNoResultsFound' =>$nohits);
951 query_desc => $query_desc,
952 limit_desc => $limit_desc,
953 query_cgi => $query_cgi,
954 limit_cgi => $limit_cgi
957 } # end of the if local
958 # asynchronously search the authority server
959 elsif ($server && $server =~/authorityserver/) { # this is the local authority server
960 my @inner_sup_results_array;
961 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
962 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
963 my $title_field = $marc_record_object->field(100);
964 push @inner_sup_results_array, {
965 'title' => $title_field->subfield('a'),
966 'link' => "&idx=an&q=".$marc_record_object->field('001')->as_string(),
969 my $servername = $server;
970 push @sup_results_array, { servername => $servername,
971 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
973 # FIXME: can add support for other targets as needed here
974 $template->param( outer_sup_results_loop => \@sup_results_array);
975 } #/end of the for loop
976 #$template->param(FEDERATED_RESULTS => \@results_array);
978 for my $facet ( @$facets ) {
979 for my $entry ( @{ $facet->{facets} } ) {
980 my $index = $entry->{type_link_value};
981 my $value = $entry->{facet_link_value};
982 $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
988 #classlist => $classlist,
991 facets_loop => $facets,
992 displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
994 search_error => $error,
997 if ($query_desc || $limit_desc) {
998 $template->param(searchdesc => 1);
1001 # VI. BUILD THE TEMPLATE
1002 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
1004 borrowernumber => $borrowernumber,
1009 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1011 borrowernumber => $borrowernumber,
1018 add_to_some_private_shelves => $some_private_shelves,
1019 add_to_some_public_shelves => $some_public_shelves,
1022 my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
1024 # If GoogleIndicTransliteration system preference is On Set parameter to load Google's javascript in OPAC search screens
1025 if (C4::Context->preference('GoogleIndicTransliteration')) {
1026 $template->param('GoogleIndicTransliteration' => 1);
1029 $template->{VARS}->{DidYouMean} =
1030 ( defined C4::Context->preference('OPACdidyoumean')
1031 && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
1032 $template->{VARS}->{IDreamBooksReviews} = C4::Context->preference('IDreamBooksReviews');
1033 $template->{VARS}->{IDreamBooksReadometer} = C4::Context->preference('IDreamBooksReadometer');
1034 $template->{VARS}->{IDreamBooksResults} = C4::Context->preference('IDreamBooksResults');
1037 $template->param(firstPage => 1);
1040 $template->param( borrowernumber => $borrowernumber);
1041 output_with_http_headers $cgi, $cookie, $template->output, $content_type;