Bug 13799: Reword 'borrower' to 'patron'
[koha.git] / opac / opac-search.pl
blob1780b5518ab9149274162c23163439cba69f9538
1 #!/usr/bin/perl
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
24 use Modern::Perl;
26 ## STEP 1. Load things that are used in both search page and
27 # results page and decide which template to load, operations
28 # to perform, etc.
29 ## load Koha modules
30 use C4::Context;
31 use List::MoreUtils q/any/;
33 use C4::Output;
34 use C4::Auth qw(:DEFAULT get_session);
35 use C4::Languages qw(getLanguages);
36 use C4::Search;
37 use C4::Search::History;
38 use C4::Biblio; # GetBiblioData
39 use C4::Koha;
40 use C4::Tags qw(get_tags);
41 use C4::Branch; # GetBranches
42 use C4::SocialData;
43 use C4::Ratings;
44 use C4::External::OverDrive;
46 use POSIX qw(ceil floor strftime);
47 use URI::Escape;
48 use JSON qw/decode_json encode_json/;
49 use Business::ISBN;
51 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
52 # create a new CGI object
53 # FIXME: no_undef_params needs to be tested
54 use CGI qw('-no_undef_params' -utf8);
55 my $cgi = new CGI;
57 my $branch_group_limit = $cgi->param("branch_group_limit");
58 if ( $branch_group_limit ) {
59 if ( $branch_group_limit =~ /^multibranchlimit-/ ) {
60 # For search groups we are going to convert this branch_group_limit CGI
61 # parameter into a multibranchlimit CGI parameter for the purposes of
62 # actually performing the query
63 $cgi->param(
64 -name => 'multibranchlimit',
65 -values => substr($branch_group_limit, 17)
67 } else {
68 $cgi->append(
69 -name => 'limit',
70 -values => [ $branch_group_limit ]
75 BEGIN {
76 if (C4::Context->preference('BakerTaylorEnabled')) {
77 require C4::External::BakerTaylor;
78 import C4::External::BakerTaylor qw(&image_url &link_url);
82 my ($template,$borrowernumber,$cookie);
83 # decide which template to use
84 my $template_name;
85 my $template_type = 'basic';
86 my @params = $cgi->param("limit");
87 my @searchCategories = $cgi->param('searchcat');
89 my $format = $cgi->param("format") || '';
90 my $build_grouped_results = C4::Context->preference('OPACGroupResults');
91 if ($format =~ /(rss|atom|opensearchdescription)/) {
92 $template_name = 'opac-opensearch.tt';
94 elsif (@params && $build_grouped_results) {
95 $template_name = 'opac-results-grouped.tt';
97 elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
98 $template_name = 'opac-results.tt';
100 else {
101 $template_name = 'opac-advsearch.tt';
102 $template_type = 'advsearch';
104 # load the template
105 ($template, $borrowernumber, $cookie) = get_template_and_user({
106 template_name => $template_name,
107 query => $cgi,
108 type => "opac",
109 authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
113 my $lang = C4::Languages::getlanguage($cgi);
115 if ($template_name eq 'opac-results.tt') {
116 $template->param('COinSinOPACResults' => C4::Context->preference('COinSinOPACResults'));
119 # get biblionumbers stored in the cart
120 my @cart_list;
122 if($cgi->cookie("bib_list")){
123 my $cart_list = $cgi->cookie("bib_list");
124 @cart_list = split(/\//, $cart_list);
127 if ($format eq 'rss2' or $format eq 'opensearchdescription' or $format eq 'atom') {
128 $template->param($format => 1);
129 $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime)) if ($format eq 'atom');
130 # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
131 # entry, but not sure if that's worth an extra database query for each bib
133 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
134 $template->param('UNIMARC' => 1);
136 elsif (C4::Context->preference("marcflavour") eq "MARC21" ) {
137 $template->param('usmarc' => 1);
140 $template->param( 'OPACNoResultsFound' => C4::Context->preference('OPACNoResultsFound') );
142 $template->param(
143 OpacStarRatings => C4::Context->preference("OpacStarRatings") );
145 if (C4::Context->preference('BakerTaylorEnabled')) {
146 $template->param(
147 BakerTaylorEnabled => 1,
148 BakerTaylorImageURL => &image_url(),
149 BakerTaylorLinkURL => &link_url(),
150 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
154 if (C4::Context->preference('TagsEnabled')) {
155 $template->param(TagsEnabled => 1);
156 foreach (qw(TagsShowOnList TagsInputOnList)) {
157 C4::Context->preference($_) and $template->param($_ => 1);
161 ## URI Re-Writing
162 # Deprecated, but preserved because it's interesting :-)
163 # The same thing can be accomplished with mod_rewrite in
164 # a more elegant way
166 #my $rewrite_flag;
167 #my $uri = $cgi->url(-base => 1);
168 #my $relative_url = $cgi->url(-relative=>1);
169 #$uri.="/".$relative_url."?";
170 #warn "URI:$uri";
171 #my @cgi_params_list = $cgi->param();
172 #my $url_params = $cgi->Vars;
174 #for my $each_param_set (@cgi_params_list) {
175 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
177 #warn "New URI:$uri";
178 # Only re-write a URI if there are params or if it already hasn't been re-written
179 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
180 # print $cgi->redirect( -uri=>$uri."&r=1",
181 # -cookie => $cookie);
182 # exit;
185 # load the branches
187 if ($cgi->param("returntosearch")) {
188 $template->param('ReturnToSearch' => 1);
190 if ($cgi->cookie("search_path_code")) {
191 my $pathcode = $cgi->cookie("search_path_code");
192 if ($pathcode eq '"ads"') {
193 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?returntosearch=1');
195 elsif ($pathcode eq '"exs"') {
196 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?expanded_options=1&returntosearch=1');
198 else {
199 warn "ReturnPath switch error";
203 my $branches = GetBranches(); # used later in *getRecords, probably should be internalized by those functions after caching in C4::Branch is established
204 $template->param(
205 searchdomainloop => GetBranchCategories('searchdomain'),
208 # load the language limits (for search)
209 my $languages_limit_loop = getLanguages($lang, 1);
210 $template->param(search_languages_loop => $languages_limit_loop,);
212 # load the Type stuff
213 my $itemtypes = GetItemTypesCategorized;
214 # add translated_description to itemtypes
215 foreach my $itemtype ( keys %{$itemtypes} ) {
216 $itemtypes->{$itemtype}->{translated_description} = getitemtypeinfo( $itemtype, 'opac' )->{translated_description};
218 # the index parameter is different for item-level itemtypes
219 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
220 my @advancedsearchesloop;
221 my $cnt;
222 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
223 my @advanced_search_types = split(/\|/, $advanced_search_types);
225 my $hidingrules = {};
226 my $yaml = C4::Context->preference('OpacHiddenItems');
227 if ( $yaml =~ /\S/ ) {
228 $yaml = "$yaml\n\n"; # YAML expects trailing newline. Surplus does not hurt.
229 eval {
230 $hidingrules = YAML::Load($yaml);
232 if ($@) {
233 warn "Unable to parse OpacHiddenItems syspref : $@";
237 foreach my $advanced_srch_type (@advanced_search_types) {
238 $advanced_srch_type =~ s/^\s*//;
239 $advanced_srch_type =~ s/\s*$//;
240 if ($advanced_srch_type eq 'itemtypes') {
241 # itemtype is a special case, since it's not defined in authorized values
242 my @itypesloop;
243 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{translated_description} cmp $itemtypes->{$b}->{translated_description} } keys %$itemtypes ) {
244 next if $hidingrules->{itype} && any { $_ eq $thisitemtype } @{$hidingrules->{itype}};
245 next if $hidingrules->{itemtype} && any { $_ eq $thisitemtype } @{$hidingrules->{itemtype}};
246 my %row =( number=>$cnt++,
247 ccl => "$itype_or_itemtype,phr",
248 code => $thisitemtype,
249 description => $itemtypes->{$thisitemtype}->{translated_description},
250 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
251 cat => $itemtypes->{$thisitemtype}->{'iscat'},
252 hideinopac => $itemtypes->{$thisitemtype}->{'hideinopac'},
253 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
255 if ( !$itemtypes->{$thisitemtype}->{'hideinopac'} ) {
256 push @itypesloop, \%row;
259 my %search_code = ( advanced_search_type => $advanced_srch_type,
260 code_loop => \@itypesloop );
261 push @advancedsearchesloop, \%search_code;
262 } else {
263 # covers all the other cases: non-itemtype authorized values
264 my $advsearchtypes = GetAuthorisedValues($advanced_srch_type, '', 'opac');
265 my @authvalueloop;
266 for my $thisitemtype (@$advsearchtypes) {
267 my $hiding_key = lc $thisitemtype->{category};
268 $hiding_key = "location" if $hiding_key eq 'loc';
269 next if $hidingrules->{$hiding_key} && any { $_ eq $thisitemtype->{authorised_value} } @{$hidingrules->{$hiding_key}};
270 my %row =(
271 number=>$cnt++,
272 ccl => $advanced_srch_type,
273 code => $thisitemtype->{authorised_value},
274 description => $thisitemtype->{'lib_opac'} || $thisitemtype->{'lib'},
275 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
276 imageurl => getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
278 push @authvalueloop, \%row;
280 my %search_code = ( advanced_search_type => $advanced_srch_type,
281 code_loop => \@authvalueloop );
282 push @advancedsearchesloop, \%search_code;
285 $template->param(advancedsearchesloop => \@advancedsearchesloop);
287 # The following should only be loaded if we're bringing up the advanced search template
288 if ( $template_type && $template_type eq 'advsearch' ) {
289 # load the servers (used for searching -- to do federated searching, etc.)
290 my $primary_servers_loop;# = displayPrimaryServers();
291 $template->param(outer_servers_loop => $primary_servers_loop,);
293 my $secondary_servers_loop;
294 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
296 # set the default sorting
297 if ( C4::Context->preference('OPACdefaultSortField')
298 && C4::Context->preference('OPACdefaultSortOrder') ) {
299 my $default_sort_by =
300 C4::Context->preference('OPACdefaultSortField') . '_'
301 . C4::Context->preference('OPACdefaultSortOrder');
302 $template->param( sort_by => $default_sort_by );
305 # determine what to display next to the search boxes (ie, boolean option
306 # shouldn't appear on the first one, scan indexes should, adding a new
307 # box should only appear on the last, etc.
308 my @search_boxes_array;
309 my $search_boxes_count = 3; # begin whith 3 boxes
310 $template->param( search_boxes_count => $search_boxes_count );
312 if ($cgi->cookie("num_paragraph")){
313 $search_boxes_count = $cgi->cookie("num_paragraph");
316 for (my $i=1;$i<=$search_boxes_count;$i++) {
317 # if it's the first one, don't display boolean option, but show scan indexes
318 if ($i==1) {
319 push @search_boxes_array,
321 scan_index => 1,
325 # if it's the last one, show the 'add field' box
326 elsif ($i==$search_boxes_count) {
327 push @search_boxes_array,
329 boolean => 1,
330 add_field => 1,
333 else {
334 push @search_boxes_array,
336 boolean => 1,
342 my @advsearch_limits = split /,/, C4::Context->preference('OpacAdvSearchOptions');
343 my @advsearch_more_limits = split /,/,
344 C4::Context->preference('OpacAdvSearchMoreOptions');
345 $template->param(
346 uc( C4::Context->preference("marcflavour") ) => 1, # we already did this for UNIMARC
347 advsearch => 1,
348 search_boxes_loop => \@search_boxes_array,
349 OpacAdvSearchOptions => \@advsearch_limits,
350 OpacAdvSearchMoreOptions => \@advsearch_more_limits,
353 # use the global setting by default
354 if ( C4::Context->preference("expandedSearchOption") == 1 ) {
355 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
357 # but let the user override it
358 if (defined $cgi->param('expanded_options')) {
359 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
360 $template->param( expanded_options => $cgi->param('expanded_options'));
364 if (C4::Context->preference('OPACNumbersPreferPhrase')) {
365 $template->param('numbersphr' => 1);
368 output_html_with_http_headers $cgi, $cookie, $template->output;
369 exit;
372 ### OK, if we're this far, we're performing an actual search
374 # Fetch the paramater list as a hash in scalar context:
375 # * returns paramater list as tied hash ref
376 # * we can edit the values by changing the key
377 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
378 my $params = $cgi->Vars;
379 my $tag;
380 if ( $params->{tag} ) {
381 $tag = $params->{tag};
382 $template->param( tag => $tag );
385 # String with params with the search criteria for the paging in opac-detail
386 # param value is URI encoded and params separator is HTML encode (&amp;)
387 my $pasarParams = '';
388 my $j = 0;
389 for (keys %$params) {
390 my @pasarParam = $cgi->param($_);
391 for my $paramValue(@pasarParam) {
392 $pasarParams .= '&amp;' if ($j > 0);
393 $pasarParams .= $_ . '=' . uri_escape_utf8($paramValue);
394 $j++;
398 # Params that can have more than one value
399 # sort by is used to sort the query
400 # in theory can have more than one but generally there's just one
401 my @sort_by;
402 my $default_sort_by;
403 if ( C4::Context->preference('OPACdefaultSortField')
404 && C4::Context->preference('OPACdefaultSortOrder') ) {
405 $default_sort_by =
406 C4::Context->preference('OPACdefaultSortField') . '_'
407 . C4::Context->preference('OPACdefaultSortOrder');
410 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/;
411 @sort_by = $cgi->param('sort_by');
412 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
413 foreach my $sort (@sort_by) {
414 if ( grep { /^$sort$/ } @allowed_sortby ) {
415 $template->param($sort => 1);
418 $template->param('sort_by' => $sort_by[0]);
420 # Use the servers defined, or just search our local catalog(default)
421 my @servers = $cgi->param('server');
422 unless (@servers) {
423 #FIXME: this should be handled using Context.pm
424 @servers = ("biblioserver");
425 # @servers = C4::Context->config("biblioserver");
428 # operators include boolean and proximity operators and are used
429 # to evaluate multiple operands
430 my @operators = $cgi->param('op');
431 @operators = map { uri_unescape($_) } @operators;
433 # indexes are query qualifiers, like 'title', 'author', etc. They
434 # can be single or multiple parameters separated by comma: kw,right-Truncation
435 my @indexes = $cgi->param('idx');
436 @indexes = map { uri_unescape($_) } @indexes;
438 # if a simple index (only one) display the index used in the top search box
439 if ($indexes[0] && !$indexes[1]) {
440 $template->param("ms_".$indexes[0] => 1);
442 # an operand can be a single term, a phrase, or a complete ccl query
443 my @operands = $cgi->param('q');
444 @operands = map { uri_unescape($_) } @operands;
446 $template->{VARS}->{querystring} = join(' ', @operands);
448 # if a simple search, display the value in the search box
449 if ($operands[0] && !$operands[1]) {
450 my $ms_query = $operands[0];
451 $ms_query =~ s/ #\S+//;
452 $template->param(ms_value => $ms_query);
455 # limits are use to limit to results to a pre-defined category such as branch or language
456 my @limits = $cgi->param('limit');
457 @limits = map { uri_unescape($_) } @limits;
458 my @nolimits = $cgi->param('nolimit');
459 @nolimits = map { uri_unescape($_) } @nolimits;
460 my %is_nolimit = map { $_ => 1 } @nolimits;
461 @limits = grep { not $is_nolimit{$_} } @limits;
463 if (@searchCategories > 0) {
464 my @tabcat;
465 foreach my $typecategory (@searchCategories) {
466 push (@tabcat, GetItemTypesByCategory($typecategory));
469 foreach my $itemtypeInCategory (@tabcat) {
470 push (@limits, "mc-$itype_or_itemtype,phr:".$itemtypeInCategory);
474 @limits = map { uri_unescape($_) } @limits;
476 if($params->{'multibranchlimit'}) {
477 my $multibranch = '('.join( " or ", map { "branch: $_ " } @{ GetBranchesInCategory( $params->{'multibranchlimit'} ) } ).')';
478 push @limits, $multibranch if ($multibranch ne '()');
481 my $available;
482 foreach my $limit(@limits) {
483 if ($limit =~/available/) {
484 $available = 1;
487 $template->param(available => $available);
489 # append year limits if they exist
490 if ($params->{'limit-yr'}) {
491 if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
492 my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
493 push @limits, "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
495 elsif ($params->{'limit-yr'} =~ /\d{4}/) {
496 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
498 else {
499 #FIXME: Should return a error to the user, incorect date format specified
503 # Params that can only have one value
504 my $scan = $params->{'scan'};
505 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
506 my $countRSS = C4::Context->preference('numSearchRSSResults') || 50;
507 my $results_per_page = $params->{'count'} || $count;
508 my $offset = $params->{'offset'} || 0;
509 my $page = $cgi->param('page') || 1;
510 $offset = ($page-1)*$results_per_page if $page>1;
511 my $hits;
512 my $expanded_facet = $params->{'expand'};
514 # Define some global variables
515 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
517 my @results;
519 ## I. BUILD THE QUERY
520 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by, 0, $lang);
522 sub _input_cgi_parse {
523 my @elements;
524 for my $this_cgi ( split('&',shift) ) {
525 next unless $this_cgi;
526 $this_cgi =~ /(.*?)=(.*)/;
527 push @elements, { input_name => $1, input_value => Encode::decode_utf8( uri_unescape($2) ) };
529 return @elements;
532 ## parse the query_cgi string and put it into a form suitable for <input>s
533 my @query_inputs = _input_cgi_parse($query_cgi);
534 $template->param ( QUERY_INPUTS => \@query_inputs );
536 ## parse the limit_cgi string and put it into a form suitable for <input>s
537 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
539 # add OPAC 'hidelostitems'
540 #if (C4::Context->preference('hidelostitems') == 1) {
541 # # either lost ge 0 or no value in the lost register
542 # $query ="($query) and ( (lost,st-numeric <= 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='') )";
545 # add OPAC suppression - requires at least one item indexed with Suppress
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 if ($IPAddress !~ /^$IPRange/) {
552 if ( $query_type eq 'pqf' ) {
553 $query = '@not '.$query.' @attr 1=9011 1';
554 } else {
555 $query = "($query) not Suppress=1";
559 else {
560 if ( $query_type eq 'pqf' ) {
561 #$query = "($query) && -(suppress:1)"; #QP syntax
562 $query = '@not '.$query.' @attr 1=9011 1'; #PQF syntax
563 } else {
564 $query = "($query) not Suppress=1";
569 $template->param ( LIMIT_INPUTS => \@limit_inputs );
570 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
572 ## II. DO THE SEARCH AND GET THE RESULTS
573 my $total = 0; # the total results for the whole set
574 my $facets; # this object stores the faceted results that display on the left-hand of the results page
575 my @results_array;
576 my $results_hashref;
577 my @coins;
579 if ($tag) {
580 $query_cgi = "tag=" .$tag . "&" . $query_cgi;
581 my $taglist = get_tags({term=>$tag, approved=>1});
582 $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
583 my @biblist = (map {GetBiblioData($_->{biblionumber})} @$taglist);
584 my @marclist = (map { (C4::Context->config('zebra_bib_index_mode') eq 'dom')? $_->{marcxml}: $_->{marc}; } @biblist);
585 $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
586 $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
587 # FIXME: tag search and standard search should work together, not exclusively
588 # FIXME: No facets for tags search.
589 } elsif ($build_grouped_results) {
590 eval {
591 ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
593 } else {
594 $pasarParams .= '&amp;query=' . uri_escape_utf8($query);
595 $pasarParams .= '&amp;count=' . uri_escape_utf8($results_per_page);
596 $pasarParams .= '&amp;simple_query=' . uri_escape_utf8($simple_query);
597 $pasarParams .= '&amp;query_type=' . uri_escape_utf8($query_type) if ($query_type);
598 eval {
599 ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$itemtypes,$query_type,$scan,1);
602 # This sorts the facets into alphabetical order
603 if ($facets) {
604 foreach my $f (@$facets) {
605 $f->{facets} = [ sort { uc($a->{facet_label_value}) cmp uc($b->{facet_label_value}) } @{ $f->{facets} } ];
607 @$facets = sort {$a->{expand} cmp $b->{expand}} @$facets;
610 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
611 if ($@ || $error) {
612 $template->param(query_error => $error.$@);
613 output_html_with_http_headers $cgi, $cookie, $template->output;
614 exit;
617 # At this point, each server has given us a result set
618 # now we build that set for template display
619 my @sup_results_array;
620 for (my $i=0;$i<@servers;$i++) {
621 my $server = $servers[$i];
622 if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
623 $hits = $results_hashref->{$server}->{"hits"};
624 my $page = $cgi->param('page') || 0;
625 my @newresults;
626 if ($build_grouped_results) {
627 foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
628 # because pazGetRecords handles retieving only the records
629 # we want as specified by $offset and $results_per_page,
630 # we need to set the offset parameter of searchResults to 0
631 my @group_results = searchResults( 'opac', $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
632 $group->{"RECORDS"});
633 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
635 } else {
636 @newresults = searchResults('opac', $query_desc, $hits, $results_per_page, $offset, $scan,
637 $results_hashref->{$server}->{"RECORDS"});
639 $hits = 0 unless @newresults;
641 foreach my $res (@newresults) {
643 # must define a value for size if not present in DB
644 # in order to avoid problems generated by the default size value in TT
645 if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
646 # while we're checking each line, see if item is in the cart
647 if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
648 $res->{'incart'} = 1;
651 if (C4::Context->preference('COinSinOPACResults')) {
652 my $record = GetMarcBiblio($res->{'biblionumber'});
653 $res->{coins} = GetCOinSBiblio($record);
655 if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
656 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
657 $isbn = $isbn->as_isbn13->as_string;
658 $isbn =~ s/-//g;
659 my $social_datas = C4::SocialData::get_data( $isbn );
660 if ( $social_datas ) {
661 for my $key ( keys %$social_datas ) {
662 $res->{$key} = $$social_datas{$key};
663 if ( $key eq 'score_avg' ){
664 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
671 if (C4::Context->preference('TagsEnabled') and
672 C4::Context->preference('TagsShowOnList')) {
673 if ( my $bibnum = $res->{biblionumber} ) {
674 $res->{itemsissued} = CountItemsIssued( $bibnum );
675 $res->{'TagLoop'} = get_tags({
676 biblionumber => $bibnum,
677 approved => 1,
678 sort => '-weight',
679 limit => C4::Context->preference('TagsShowOnList')
684 if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
685 my $rating = GetRating( $res->{'biblionumber'}, $borrowernumber );
686 $res->{'rating_value'} = $rating->{'rating_value'};
687 $res->{'rating_total'} = $rating->{'rating_total'};
688 $res->{'rating_avg'} = $rating->{'rating_avg'};
689 $res->{'rating_avg_int'} = $rating->{'rating_avg_int'};
693 if ($results_hashref->{$server}->{"hits"}){
694 $total = $total + $hits;
697 # Opac search history
698 if (C4::Context->preference('EnableOpacSearchHistory')) {
699 unless ( $offset ) {
700 my $path_info = $cgi->url(-path_info=>1);
701 my $query_cgi_history = $cgi->url(-query=>1);
702 $query_cgi_history =~ s/^$path_info\?//;
703 $query_cgi_history =~ s/;/&/g;
704 my $query_desc_history = join ", ", grep { defined $_ } $query_desc, $limit_desc;
706 unless ( $borrowernumber ) {
707 my $new_searches = C4::Search::History::add_to_session({
708 cgi => $cgi,
709 query_desc => $query_desc_history,
710 query_cgi => $query_cgi_history,
711 total => $total,
712 type => "biblio",
714 } else {
715 # To the session (the user is logged in)
716 C4::Search::History::add({
717 userid => $borrowernumber,
718 sessionid => $cgi->cookie("CGISESSID"),
719 query_desc => $query_desc_history,
720 query_cgi => $query_cgi_history,
721 total => $total,
722 type => "biblio",
726 $template->param( EnableOpacSearchHistory => 1 );
729 ## If there's just one result, redirect to the detail page
730 if ($total == 1 && $format ne 'rss2'
731 && $format ne 'opensearchdescription' && $format ne 'atom') {
732 my $biblionumber=$newresults[0]->{biblionumber};
733 if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
734 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
735 } elsif (C4::Context->preference('BiblioDefaultView') eq 'marc') {
736 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
737 } else {
738 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
740 exit;
742 if ($hits) {
743 if ( !$build_grouped_results ) {
744 # We build the encrypted list of first OPACnumSearchResults biblios to pass with the search criteria for paging on opac-detail
745 $pasarParams .= '&amp;listBiblios=';
746 my $j = 0;
747 foreach (@newresults) {
748 my $bibnum = ($_->{biblionumber})?$_->{biblionumber}:0;
749 $pasarParams .= uri_escape_utf8($bibnum) . ',';
750 $j++;
751 last if ($j == $results_per_page);
753 chop $pasarParams if ($pasarParams =~ /,$/);
754 $pasarParams .= '&amp;total=' . uri_escape_utf8( int($total) ) if ($pasarParams !~ /total=(?:[0-9]+)?/);
755 if ($pasarParams) {
756 my $session = get_session($cgi->cookie("CGISESSID"));
757 $session->param('busc' => $pasarParams);
761 $template->param(total => $hits);
762 my $limit_cgi_not_availablity = $limit_cgi;
763 $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
764 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
765 $template->param(limit_cgi => $limit_cgi);
766 $template->param(countrss => $countRSS );
767 $template->param(query_cgi => $query_cgi);
768 $template->param(query_desc => $query_desc);
769 $template->param(limit_desc => $limit_desc);
770 $template->param(offset => $offset);
771 $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
772 if ($query_desc || $limit_desc) {
773 $template->param(searchdesc => 1);
775 $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
776 $template->param(results_per_page => $results_per_page);
777 my $hide = C4::Context->preference('OpacHiddenItems');
778 $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
779 my $branch = '';
780 if (C4::Context->userenv){
781 $branch = C4::Context->userenv->{branch};
783 if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
784 if (
785 ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
787 C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
789 my $branchname;
790 if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
791 $branchname = $branches->{$branch}->{'branchname'};
793 elsif ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
794 $branchname = $branches->{ $ENV{'BRANCHCODE'} }->{'branchname'};
797 foreach my $res ( @newresults ) {
798 my @new_loop;
799 my @top_loop;
800 my @old_loop = @{$res->{'available_items_loop'}};
801 foreach my $item ( @old_loop ) {
802 if ( $item->{'branchname'} eq $branchname ) {
803 $item->{'this_branch'} = 1;
804 push( @top_loop, $item );
805 } else {
806 push( @new_loop, $item );
809 my @complete_loop = ( @top_loop, @new_loop );
810 $res->{'available_items_loop'} = \@complete_loop;
815 $template->param(
816 SEARCH_RESULTS => \@newresults,
817 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
818 suppress_result_number => $hide,
820 if (C4::Context->preference("OPACLocalCoverImages")){
821 $template->param(OPACLocalCoverImages => 1);
822 $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
824 ## Build the page numbers on the bottom of the page
825 my @page_numbers;
826 # total number of pages there will be
827 my $pages = ceil($hits / $results_per_page);
828 # default page number
829 my $current_page_number = 1;
830 if ($offset) {
831 $current_page_number = ( $offset / $results_per_page + 1 );
833 my $previous_page_offset;
834 if ( $offset >= $results_per_page ) {
835 $previous_page_offset = $offset - $results_per_page;
837 my $next_page_offset = $offset + $results_per_page;
838 # If we're within the first 10 pages, keep it simple
839 #warn "current page:".$current_page_number;
840 if ($current_page_number < 10) {
841 # just show the first 10 pages
842 # Loop through the pages
843 my $pages_to_show = 10;
844 $pages_to_show = $pages if $pages<10;
845 for ($i=1; $i<=$pages_to_show;$i++) {
846 # the offset for this page
847 my $this_offset = (($i*$results_per_page)-$results_per_page);
848 # the page number for this page
849 my $this_page_number = $i;
850 # put it in the array
851 push @page_numbers,
852 { offset => $this_offset,
853 pg => $this_page_number,
854 highlight => $this_page_number == $current_page_number,
855 sort_by => join ' ', @sort_by
861 # now, show twenty pages, with the current one smack in the middle
862 else {
863 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
864 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
865 my $this_page_number = $i-9;
866 if ( $this_page_number <= $pages ) {
867 push @page_numbers,
868 { offset => $this_offset,
869 pg => $this_page_number,
870 highlight => $this_page_number == $current_page_number,
871 sort_by => join ' ', @sort_by
877 $template->param( PAGE_NUMBERS => \@page_numbers,
878 previous_page_offset => $previous_page_offset) unless $pages < 2;
879 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
881 # no hits
882 else {
883 my $nohits = C4::Context->preference('OPACNoResultsFound');
884 if ($nohits and $nohits=~/{QUERY_KW}/){
885 # extracting keywords in case of relaunching search
886 (my $query_kw=$query_desc)=~s/ and|or / /g;
887 $query_kw = Encode::decode_utf8($query_kw);
888 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^,:]|$)/g);
889 $query_kw=join('+',@query_kw);
890 $nohits=~s/{QUERY_KW}/$query_kw/g;
891 $template->param('OPACNoResultsFound' =>$nohits);
893 $template->param(
894 searchdesc => 1,
895 query_desc => $query_desc,
896 limit_desc => $limit_desc,
897 query_cgi => $query_cgi,
898 limit_cgi => $limit_cgi
901 } # end of the if local
902 # asynchronously search the authority server
903 elsif ($server && $server =~/authorityserver/) { # this is the local authority server
904 my @inner_sup_results_array;
905 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
906 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
907 my $title_field = $marc_record_object->field(100);
908 push @inner_sup_results_array, {
909 'title' => $title_field->subfield('a'),
910 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
913 my $servername = $server;
914 push @sup_results_array, { servername => $servername,
915 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
917 # FIXME: can add support for other targets as needed here
918 $template->param( outer_sup_results_loop => \@sup_results_array);
919 } #/end of the for loop
920 #$template->param(FEDERATED_RESULTS => \@results_array);
922 for my $facet ( @$facets ) {
923 for my $entry ( @{ $facet->{facets} } ) {
924 my $index = $entry->{type_link_value};
925 my $value = $entry->{facet_link_value};
926 $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
931 $template->param(
932 #classlist => $classlist,
933 total => $total,
934 opacfacets => 1,
935 facets_loop => $facets,
936 displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
937 scan => $scan,
938 search_error => $error,
941 if ($query_desc || $limit_desc) {
942 $template->param(searchdesc => 1);
945 # VI. BUILD THE TEMPLATE
946 # Build drop-down list for 'Add To:' menu...
947 my ($totalref, $pubshelves, $barshelves)=
948 C4::VirtualShelves::GetSomeShelfNames($borrowernumber,'COMBO',1);
949 $template->param(
950 addbarshelves => $totalref->{bartotal},
951 addbarshelvesloop => $barshelves,
952 addpubshelves => $totalref->{pubtotal},
953 addpubshelvesloop => $pubshelves,
956 my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
958 # If GoogleIndicTransliteration system preference is On Set paramter to load Google's javascript in OPAC search screens
959 if (C4::Context->preference('GoogleIndicTransliteration')) {
960 $template->param('GoogleIndicTransliteration' => 1);
963 $template->{VARS}->{DidYouMean} =
964 ( defined C4::Context->preference('OPACdidyoumean')
965 && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
966 $template->{VARS}->{IDreamBooksReviews} = C4::Context->preference('IDreamBooksReviews');
967 $template->{VARS}->{IDreamBooksReadometer} = C4::Context->preference('IDreamBooksReadometer');
968 $template->{VARS}->{IDreamBooksResults} = C4::Context->preference('IDreamBooksResults');
970 if ($offset == 0 && IsOverDriveEnabled()) {
971 $template->param(OverDriveEnabled => 1);
972 $template->param(OverDriveLibraryID => C4::Context->preference('OverDriveLibraryID'));
975 $template->param( borrowernumber => $borrowernumber);
976 output_with_http_headers $cgi, $cookie, $template->output, $content_type;