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;
54 use C4::External::BakerTaylor qw( image_url link_url );
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 ]
93 my ($template,$borrowernumber,$cookie);
94 # decide which template to use
96 my $template_type = 'basic';
97 my @params = $cgi->multi_param("limit");
98 my @searchCategories = $cgi->multi_param('searchcat');
100 my $format = $cgi->param("format") || '';
101 my $build_grouped_results = C4::Context->preference('OPACGroupResults');
102 if ($format =~ /(rss|atom|opensearchdescription)/) {
103 $template_name = 'opac-opensearch.tt';
105 elsif (@params && $build_grouped_results) {
106 $template_name = 'opac-results-grouped.tt';
108 elsif ((@params>=1) || ($cgi->param("q")) || ($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 = {};
245 my $yaml = C4::Context->preference('OpacHiddenItems');
246 if ( $yaml =~ /\S/ ) {
247 $yaml = "$yaml\n\n"; # YAML expects trailing newline. Surplus does not hurt.
249 $hidingrules = YAML::Load($yaml);
252 warn "Unable to parse OpacHiddenItems syspref : $@";
256 my @sorted_itemtypes = sort { $itemtypes->{$a}->{translated_description} cmp $itemtypes->{$b}->{translated_description} } keys %$itemtypes;
257 foreach my $advanced_srch_type (@advanced_search_types) {
258 $advanced_srch_type =~ s/^\s*//;
259 $advanced_srch_type =~ s/\s*$//;
260 if ($advanced_srch_type eq 'itemtypes') {
261 # itemtype is a special case, since it's not defined in authorized values
263 foreach my $thisitemtype ( @sorted_itemtypes ) {
264 next if $hidingrules->{itype} && any { $_ eq $thisitemtype } @{$hidingrules->{itype}};
265 next if $hidingrules->{itemtype} && any { $_ eq $thisitemtype } @{$hidingrules->{itemtype}};
266 my %row =( number=>$cnt++,
267 ccl => "$itype_or_itemtype,phr",
268 code => $thisitemtype,
269 description => $itemtypes->{$thisitemtype}->{translated_description},
270 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
271 cat => $itemtypes->{$thisitemtype}->{'iscat'},
272 hideinopac => $itemtypes->{$thisitemtype}->{'hideinopac'},
273 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
275 if ( !$itemtypes->{$thisitemtype}->{'hideinopac'} ) {
276 push @itypesloop, \%row;
279 my %search_code = ( advanced_search_type => $advanced_srch_type,
280 code_loop => \@itypesloop );
281 push @advancedsearchesloop, \%search_code;
283 # covers all the other cases: non-itemtype authorized values
284 my $advsearchtypes = GetAuthorisedValues($advanced_srch_type, 'opac');
286 for my $thisitemtype (@$advsearchtypes) {
287 my $hiding_key = lc $thisitemtype->{category};
288 $hiding_key = "location" if $hiding_key eq 'loc';
289 next if $hidingrules->{$hiding_key} && any { $_ eq $thisitemtype->{authorised_value} } @{$hidingrules->{$hiding_key}};
292 ccl => $advanced_srch_type,
293 code => $thisitemtype->{authorised_value},
294 description => $thisitemtype->{'lib_opac'} || $thisitemtype->{'lib'},
295 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
296 imageurl => getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
298 push @authvalueloop, \%row;
300 my %search_code = ( advanced_search_type => $advanced_srch_type,
301 code_loop => \@authvalueloop );
302 push @advancedsearchesloop, \%search_code;
305 $template->param(advancedsearchesloop => \@advancedsearchesloop);
307 # The following should only be loaded if we're bringing up the advanced search template
308 if ( $template_type && $template_type eq 'advsearch' ) {
309 # load the servers (used for searching -- to do federated searching, etc.)
310 my $primary_servers_loop;# = displayPrimaryServers();
311 $template->param(outer_servers_loop => $primary_servers_loop,);
313 my $secondary_servers_loop;
314 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
316 # set the default sorting
317 if ( C4::Context->preference('OPACdefaultSortField')
318 && C4::Context->preference('OPACdefaultSortOrder') ) {
319 my $default_sort_by =
320 C4::Context->preference('OPACdefaultSortField') . '_'
321 . C4::Context->preference('OPACdefaultSortOrder');
322 $template->param( sort_by => $default_sort_by );
325 # determine what to display next to the search boxes (ie, boolean option
326 # shouldn't appear on the first one, scan indexes should, adding a new
327 # box should only appear on the last, etc.
328 my @search_boxes_array;
329 my $search_boxes_count = 3; # begin with 3 boxes
330 $template->param( search_boxes_count => $search_boxes_count );
332 if ($cgi->cookie("num_paragraph")){
333 $search_boxes_count = $cgi->cookie("num_paragraph");
336 for (my $i=1;$i<=$search_boxes_count;$i++) {
337 # if it's the first one, don't display boolean option, but show scan indexes
339 push @search_boxes_array,
345 # if it's the last one, show the 'add field' box
346 elsif ($i==$search_boxes_count) {
347 push @search_boxes_array,
354 push @search_boxes_array,
362 my @advsearch_limits = split /,/, C4::Context->preference('OpacAdvSearchOptions');
363 my @advsearch_more_limits = split /,/,
364 C4::Context->preference('OpacAdvSearchMoreOptions');
366 uc( C4::Context->preference("marcflavour") ) => 1, # we already did this for UNIMARC
368 search_boxes_loop => \@search_boxes_array,
369 OpacAdvSearchOptions => \@advsearch_limits,
370 OpacAdvSearchMoreOptions => \@advsearch_more_limits,
373 # use the global setting by default
374 if ( C4::Context->preference("expandedSearchOption") == 1 ) {
375 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
377 # but let the user override it
378 if (defined $cgi->param('expanded_options')) {
379 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
380 $template->param( expanded_options => scalar $cgi->param('expanded_options'));
385 output_html_with_http_headers $cgi, $cookie, $template->output;
389 ### OK, if we're this far, we're performing an actual search
391 # Fetch the paramater list as a hash in scalar context:
392 # * returns paramater list as tied hash ref
393 # * we can edit the values by changing the key
394 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
395 my $params = $cgi->Vars;
397 if ( $params->{tag} ) {
398 $tag = $params->{tag};
399 $template->param( tag => $tag );
402 # String with params with the search criteria for the paging in opac-detail
403 # param value is URI encoded and params separator is HTML encode (&)
404 my $pasarParams = '';
406 for (keys %$params) {
407 my @pasarParam = $cgi->multi_param($_);
408 for my $paramValue(@pasarParam) {
409 $pasarParams .= '&' if ($j > 0);
410 $pasarParams .= $_ . '=' . uri_escape_utf8($paramValue);
415 # Params that can have more than one value
416 # sort by is used to sort the query
417 # in theory can have more than one but generally there's just one
420 if ( C4::Context->preference('OPACdefaultSortField')
421 && C4::Context->preference('OPACdefaultSortOrder') ) {
423 C4::Context->preference('OPACdefaultSortField') . '_'
424 . C4::Context->preference('OPACdefaultSortOrder');
427 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/;
428 @sort_by = $cgi->multi_param('sort_by');
429 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
430 foreach my $sort (@sort_by) {
431 if ( grep { /^$sort$/ } @allowed_sortby ) {
432 $template->param($sort => 1);
435 $template->param('sort_by' => $sort_by[0]);
437 # Use the servers defined, or just search our local catalog(default)
438 my @servers = $cgi->multi_param('server');
440 #FIXME: this should be handled using Context.pm
441 @servers = ("biblioserver");
442 # @servers = C4::Context->config("biblioserver");
445 # operators include boolean and proximity operators and are used
446 # to evaluate multiple operands
447 my @operators = $cgi->multi_param('op');
448 @operators = map { uri_unescape($_) } @operators;
450 # indexes are query qualifiers, like 'title', 'author', etc. They
451 # can be single or multiple parameters separated by comma: kw,right-Truncation
452 my @indexes = $cgi->multi_param('idx');
453 @indexes = map { uri_unescape($_) } @indexes;
455 # if a simple index (only one) display the index used in the top search box
456 if ($indexes[0] && !$indexes[1]) {
457 my $idx = "ms_".$indexes[0];
458 $idx =~ s/\,/comma/g; # template toolkit doesn't like variables with a , in it
459 $idx =~ s/-/dash/g; # template toolkit doesn't like variables with a dash in it
460 $template->param($idx => 1);
462 # an operand can be a single term, a phrase, or a complete ccl query
463 my @operands = $cgi->multi_param('q');
464 @operands = map { uri_unescape($_) } @operands;
466 $template->{VARS}->{querystring} = join(' ', @operands);
468 # if a simple search, display the value in the search box
469 if ($operands[0] && !$operands[1]) {
470 my $ms_query = $operands[0];
471 $ms_query =~ s/ #\S+//;
472 $template->param(ms_value => $ms_query);
475 # limits are use to limit to results to a pre-defined category such as branch or language
476 my @limits = $cgi->multi_param('limit');
477 @limits = map { uri_unescape($_) } @limits;
478 my @nolimits = $cgi->multi_param('nolimit');
479 @nolimits = map { uri_unescape($_) } @nolimits;
480 my %is_nolimit = map { $_ => 1 } @nolimits;
481 @limits = grep { not $is_nolimit{$_} } @limits;
483 if (@searchCategories > 0) {
485 foreach my $typecategory (@searchCategories) {
486 my @itemtypes = Koha::ItemTypes->search({ searchcategory => $typecategory });
487 push @tabcat, $_->itemtype for @itemtypes;
490 foreach my $itemtypeInCategory (@tabcat) {
491 push (@limits, "mc-$itype_or_itemtype,phr:".$itemtypeInCategory);
495 @limits = map { uri_unescape($_) } @limits;
497 if($params->{'multibranchlimit'}) {
498 my $search_group = Koha::Library::Groups->find( $params->{multibranchlimit} );
499 my @libraries = $search_group->all_libraries;
500 my $multibranch = '('.join( " OR ", map { 'homebranch: ' . $_->branchcode } @libraries ) .')';
501 push @limits, $multibranch if ($multibranch ne '()');
505 foreach my $limit(@limits) {
506 if ($limit =~/available/) {
510 $template->param(available => $available);
512 # append year limits if they exist
513 if ($params->{'limit-yr'}) {
514 if ($params->{'limit-yr'} =~ /\d{4}/) {
515 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
518 #FIXME: Should return a error to the user, incorect date format specified
522 # Params that can only have one value
523 my $scan = $params->{'scan'};
524 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
525 my $countRSS = C4::Context->preference('numSearchRSSResults') || 50;
526 my $results_per_page = $params->{'count'} || $count;
527 my $offset = $params->{'offset'} || 0;
528 $offset = 0 if $offset < 0;
529 my $page = $cgi->param('page') || 1;
530 $offset = ($page-1)*$results_per_page if $page>1;
533 # Define some global variables
534 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
539 if (C4::Context->preference('OpacSuppression')) {
540 # OPAC suppression by IP address
541 if (C4::Context->preference('OpacSuppressionByIPRange')) {
542 my $IPAddress = $ENV{'REMOTE_ADDR'};
543 my $IPRange = C4::Context->preference('OpacSuppressionByIPRange');
544 $suppress = ($IPAddress !~ /^$IPRange/);
551 ## I. BUILD THE QUERY
552 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type)
553 = $builder->build_query_compat(
562 suppress => $suppress,
564 weighted_fields => !$cgi->param('advsearch')
568 $template->param( search_query => $query ) if C4::Context->preference('DumpSearchQueryTemplate');
570 sub _input_cgi_parse {
572 my $query_cgi = shift or return @elements;
573 for my $this_cgi ( split('&',$query_cgi) ) {
574 next unless $this_cgi;
575 $this_cgi =~ /(.*?)=(.*)/;
576 push @elements, { input_name => $1, input_value => Encode::decode_utf8( uri_unescape($2) ) };
581 ## parse the query_cgi string and put it into a form suitable for <input>s
582 my @query_inputs = _input_cgi_parse($query_cgi);
583 $template->param ( QUERY_INPUTS => \@query_inputs );
585 ## parse the limit_cgi string and put it into a form suitable for <input>s
586 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
590 if (C4::Context->preference('OPACShowOpenURL')) {
591 @OpenURL_itypes = split( /\s/, C4::Context->preference('OPACOpenURLItemTypes') );
593 OPACShowOpenURL => 1,
594 OpenURLResolverURL => C4::Context->preference('OpenURLResolverURL'),
595 OpenURLText => C4::Context->preference('OpenURLText'),
596 OpenURLImageLocation => C4::Context->preference('OpenURLImageLocation')
600 $template->param ( LIMIT_INPUTS => \@limit_inputs );
601 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
603 ## II. DO THE SEARCH AND GET THE RESULTS
604 my $total = 0; # the total results for the whole set
605 my $facets; # this object stores the faceted results that display on the left-hand of the results page
611 $query_cgi = "tag=" . uri_escape_utf8( $tag ) . "&" . $query_cgi;
612 my $taglist = get_tags({term=>$tag, approved=>1});
613 $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
614 my @marclist = map { C4::Biblio::GetXmlBiblio( $_->{biblionumber} ) } @$taglist;
615 $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
616 $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
617 # FIXME: tag search and standard search should work together, not exclusively
618 # FIXME: Because search and standard search don't work together OpacHiddenItems
619 # displays search results which should be hidden.
620 # FIXME: No facets for tags search.
621 } elsif ($build_grouped_results) {
623 ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,undef,$query_type,$scan);
626 $pasarParams .= '&query=' . uri_escape_utf8($query);
627 $pasarParams .= '&count=' . uri_escape_utf8($results_per_page);
628 $pasarParams .= '&simple_query=' . uri_escape_utf8($simple_query);
629 $pasarParams .= '&query_type=' . uri_escape_utf8($query_type) if ($query_type);
630 my $itemtypes_nocategory = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
632 ($error, $results_hashref, $facets) = $searcher->search_compat($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,undef,$itemtypes_nocategory,$query_type,$scan,1);
636 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
637 if (not $tag and ( $@ || $error)) {
638 $template->param(query_error => $error.$@);
639 output_html_with_http_headers $cgi, $cookie, $template->output;
643 # At this point, each server has given us a result set
644 # now we build that set for template display
645 my @sup_results_array;
646 my $search_context = {};
647 $search_context->{'interface'} = 'opac';
648 if (C4::Context->preference('OpacHiddenItemsExceptions')){
649 $search_context->{'category'} = $patron ? $patron->categorycode : q{};
652 for (my $i=0;$i<@servers;$i++) {
653 my $server = $servers[$i];
654 if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
655 $hits = $results_hashref->{$server}->{"hits"};
656 my $page = $cgi->param('page') || 0;
658 if ($build_grouped_results) {
659 foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
660 # because pazGetRecords handles retieving only the records
661 # we want as specified by $offset and $results_per_page,
662 # we need to set the offset parameter of searchResults to 0
663 my @group_results = searchResults( $search_context, $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
664 $group->{"RECORDS"});
665 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
668 @newresults = searchResults( $search_context, $query_desc, $hits, $results_per_page, $offset, $scan,
669 $results_hashref->{$server}->{"RECORDS"});
671 $hits = 0 unless @newresults;
674 if( C4::Context->preference('ArticleRequests') ) {
675 $art_req_itypes = Koha::IssuingRules->guess_article_requestable_itemtypes({ $patron ? ( categorycode => $patron->categorycode ) : () });
678 foreach my $res (@newresults) {
680 # must define a value for size if not present in DB
681 # in order to avoid problems generated by the default size value in TT
682 if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
683 # while we're checking each line, see if item is in the cart
684 if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
685 $res->{'incart'} = 1;
688 if (C4::Context->preference('COinSinOPACResults')) {
689 my $biblio = Koha::Biblios->find( $res->{'biblionumber'} );
690 # Catch the exception as Koha::Biblio::Metadata->record can explode if the MARCXML is invalid
691 $res->{coins} = $biblio ? eval {$biblio->get_coins} : q{}; # FIXME This should be moved at the beginning of the @newresults loop
693 if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
694 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
695 $isbn = $isbn->as_isbn13->as_string;
697 my $social_datas = C4::SocialData::get_data( $isbn );
698 if ( $social_datas ) {
699 for my $key ( keys %$social_datas ) {
700 $res->{$key} = $$social_datas{$key};
701 if ( $key eq 'score_avg' ){
702 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
709 if (C4::Context->preference('TagsEnabled') and
710 C4::Context->preference('TagsShowOnList')) {
711 if ( my $bibnum = $res->{biblionumber} ) {
712 $res->{itemsissued} = CountItemsIssued( $bibnum );
713 $res->{'TagLoop'} = get_tags({
714 biblionumber => $bibnum,
717 limit => C4::Context->preference('TagsShowOnList')
722 $res->{shelves} = Koha::Virtualshelves->get_shelves_containing_record(
724 biblionumber => $res->{biblionumber},
725 borrowernumber => $borrowernumber
729 if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
730 my $ratings = Koha::Ratings->search({ biblionumber => $res->{biblionumber} });
731 $res->{ratings} = $ratings;
732 $res->{my_rating} = $borrowernumber ? $ratings->search({ borrowernumber => $borrowernumber })->next : undef;
735 # BZ17530: 'Intelligent' guess if result can be article requested
736 $res->{artreqpossible} = ( $art_req_itypes->{ $res->{itemtype} // q{} } || $art_req_itypes->{ '*' } ) ? 1 : q{};
739 if ($results_hashref->{$server}->{"hits"}){
740 $total = $total + $hits;
743 # Opac search history
744 if (C4::Context->preference('EnableOpacSearchHistory')) {
746 my $path_info = $cgi->url(-path_info=>1);
747 my $query_cgi_history = $cgi->url(-query=>1);
748 $query_cgi_history =~ s/^$path_info\?//;
749 $query_cgi_history =~ s/;/&/g;
750 my $query_desc_history = join ", ", grep { defined $_ } $query_desc, $limit_desc;
752 unless ( $borrowernumber ) {
753 my $new_searches = C4::Search::History::add_to_session({
755 query_desc => $query_desc_history,
756 query_cgi => $query_cgi_history,
761 # To the session (the user is logged in)
762 C4::Search::History::add({
763 userid => $borrowernumber,
764 sessionid => $cgi->cookie("CGISESSID"),
765 query_desc => $query_desc_history,
766 query_cgi => $query_cgi_history,
772 $template->param( EnableOpacSearchHistory => 1 );
775 ## If there's just one result, redirect to the detail page
776 if ($total == 1 && $format ne 'rss'
777 && $format ne 'opensearchdescription' && $format ne 'atom') {
778 my $biblionumber=$newresults[0]->{biblionumber};
779 if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
780 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
781 } elsif (C4::Context->preference('BiblioDefaultView') eq 'marc') {
782 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
784 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
789 if ( !$build_grouped_results ) {
790 # We build the encrypted list of first OPACnumSearchResults biblios to pass with the search criteria for paging on opac-detail
791 $pasarParams .= '&listBiblios=';
793 foreach (@newresults) {
794 my $bibnum = ($_->{biblionumber})?$_->{biblionumber}:0;
795 $pasarParams .= uri_escape_utf8($bibnum) . ',';
797 last if ($j == $results_per_page);
799 chop $pasarParams if ($pasarParams =~ /,$/);
800 $pasarParams .= '&total=' . uri_escape_utf8( int($total) ) if ($pasarParams !~ /total=(?:[0-9]+)?/);
802 my $session = get_session($cgi->cookie("CGISESSID"));
803 $session->param('busc' => $pasarParams);
807 $template->param(total => $hits);
808 my $limit_cgi_not_availablity = $limit_cgi;
809 $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
810 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
811 $template->param(limit_cgi => $limit_cgi);
812 $template->param(countrss => $countRSS );
813 $template->param(query_cgi => $query_cgi);
814 $template->param(query_desc => $query_desc);
815 $template->param(limit_desc => $limit_desc);
816 $template->param(offset => $offset);
817 $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
818 if ($query_desc || $limit_desc) {
819 $template->param(searchdesc => 1);
821 $template->param(results_per_page => $results_per_page);
822 my $hide = C4::Context->preference('OpacHiddenItems');
823 $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
825 if (C4::Context->userenv){
826 $branch = C4::Context->userenv->{branch};
828 if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
830 ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
832 C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
835 if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
836 $branchcode = $branch;
838 elsif ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
839 $branchcode = $ENV{'BRANCHCODE'};
842 foreach my $res ( @newresults ) {
845 my @old_loop = @{$res->{'available_items_loop'}};
846 foreach my $item ( @old_loop ) {
847 if ( $item->{'branchcode'} eq $branchcode ) {
848 $item->{'this_branch'} = 1;
849 push( @top_loop, $item );
851 push( @new_loop, $item );
854 my @complete_loop = ( @top_loop, @new_loop );
855 $res->{'available_items_loop'} = \@complete_loop;
861 SEARCH_RESULTS => \@newresults,
862 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
863 suppress_result_number => $hide,
865 if (C4::Context->preference("OPACLocalCoverImages")){
866 $template->param(OPACLocalCoverImages => 1);
867 $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
869 ## Build the page numbers on the bottom of the page
871 my $max_result_window = $searcher->max_result_window;
872 my $hits_to_paginate = ($max_result_window && $max_result_window < $hits) ? $max_result_window : $hits;
873 $template->param( hits_to_paginate => $hits_to_paginate );
874 # total number of pages there will be
875 my $pages = ceil($hits_to_paginate / $results_per_page);
876 my $last_page_offset = ( $pages - 1 ) * $results_per_page;
877 # default page number
878 my $current_page_number = 1;
880 $current_page_number = ( $offset / $results_per_page + 1 );
882 my $previous_page_offset;
883 if ( $offset >= $results_per_page ) {
884 $previous_page_offset = $offset - $results_per_page;
886 my $next_page_offset = $offset + $results_per_page;
887 # If we're within the first 10 pages, keep it simple
888 #warn "current page:".$current_page_number;
889 if ($current_page_number < 10) {
890 # just show the first 10 pages
891 # Loop through the pages
892 my $pages_to_show = 10;
893 $pages_to_show = $pages if $pages<10;
894 for ($i=1; $i<=$pages_to_show;$i++) {
895 # the offset for this page
896 my $this_offset = (($i*$results_per_page)-$results_per_page);
897 # the page number for this page
898 my $this_page_number = $i;
899 # put it in the array
901 { offset => $this_offset,
902 pg => $this_page_number,
903 highlight => $this_page_number == $current_page_number,
904 sort_by => join ' ', @sort_by
910 # now, show twenty pages, with the current one smack in the middle
912 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
913 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
914 my $this_page_number = $i-9;
915 if ( $this_page_number <= $pages ) {
917 { offset => $this_offset,
918 pg => $this_page_number,
919 highlight => $this_page_number == $current_page_number,
920 sort_by => join ' ', @sort_by
926 $template->param( PAGE_NUMBERS => \@page_numbers,
927 last_page_offset => $last_page_offset,
928 previous_page_offset => $previous_page_offset) unless $pages < 2;
929 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
933 my $nohits = C4::Context->preference('OPACNoResultsFound');
934 if ($nohits and $nohits=~/{QUERY_KW}/){
935 # extracting keywords in case of relaunching search
936 (my $query_kw=$query_desc)=~s/ and|or / /g;
937 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^,:]|$)/g);
938 $query_kw=join('+',@query_kw);
939 $nohits=~s/{QUERY_KW}/$query_kw/g;
940 $template->param('OPACNoResultsFound' =>$nohits);
944 query_desc => $query_desc,
945 limit_desc => $limit_desc,
946 query_cgi => $query_cgi,
947 limit_cgi => $limit_cgi
950 } # end of the if local
951 # asynchronously search the authority server
952 elsif ($server && $server =~/authorityserver/) { # this is the local authority server
953 my @inner_sup_results_array;
954 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
955 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
956 my $title_field = $marc_record_object->field(100);
957 push @inner_sup_results_array, {
958 'title' => $title_field->subfield('a'),
959 'link' => "&idx=an&q=".$marc_record_object->field('001')->as_string(),
962 my $servername = $server;
963 push @sup_results_array, { servername => $servername,
964 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
966 # FIXME: can add support for other targets as needed here
967 $template->param( outer_sup_results_loop => \@sup_results_array);
968 } #/end of the for loop
969 #$template->param(FEDERATED_RESULTS => \@results_array);
971 for my $facet ( @$facets ) {
972 for my $entry ( @{ $facet->{facets} } ) {
973 my $index = $entry->{type_link_value};
974 my $value = $entry->{facet_link_value};
975 $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
981 #classlist => $classlist,
984 facets_loop => $facets,
985 displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
987 search_error => $error,
990 if ($query_desc || $limit_desc) {
991 $template->param(searchdesc => 1);
994 # VI. BUILD THE TEMPLATE
995 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
997 borrowernumber => $borrowernumber,
1002 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1004 borrowernumber => $borrowernumber,
1011 add_to_some_private_shelves => $some_private_shelves,
1012 add_to_some_public_shelves => $some_public_shelves,
1015 my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
1017 # If GoogleIndicTransliteration system preference is On Set parameter to load Google's javascript in OPAC search screens
1018 if (C4::Context->preference('GoogleIndicTransliteration')) {
1019 $template->param('GoogleIndicTransliteration' => 1);
1022 $template->{VARS}->{DidYouMean} =
1023 ( defined C4::Context->preference('OPACdidyoumean')
1024 && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
1025 $template->{VARS}->{IDreamBooksReviews} = C4::Context->preference('IDreamBooksReviews');
1026 $template->{VARS}->{IDreamBooksReadometer} = C4::Context->preference('IDreamBooksReadometer');
1027 $template->{VARS}->{IDreamBooksResults} = C4::Context->preference('IDreamBooksResults');
1030 $template->param(firstPage => 1);
1033 $template->param( borrowernumber => $borrowernumber);
1034 output_with_http_headers $cgi, $cookie, $template->output, $content_type;