Bug 10480: Use the framework plugin object in cataloguing
[koha.git] / opac / opac-search.pl
blob55b9774ad506b9fbb322d0186518c3237f3c65d3
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 under the
10 # terms of the GNU General Public License as published by the Free Software
11 # Foundation; either version 2 of the License, or (at your option) any later
12 # version.
14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License along
19 # with Koha; if not, write to the Free Software Foundation, Inc.,
20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
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");
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 given ($pathcode)
194 when ('"ads"') { $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?returntosearch=1'); }
195 when ('"exs"') {
196 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?expanded_options=1&returntosearch=1');
198 default {warn "ReturnPath swith error";}
202 my $branches = GetBranches(); # used later in *getRecords, probably should be internalized by those functions after caching in C4::Branch is established
203 $template->param(
204 searchdomainloop => GetBranchCategories('searchdomain'),
207 # load the language limits (for search)
208 my $languages_limit_loop = getLanguages($lang, 1);
209 $template->param(search_languages_loop => $languages_limit_loop,);
211 # load the Type stuff
212 my $itemtypes = GetItemTypes;
213 # the index parameter is different for item-level itemtypes
214 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
215 my @advancedsearchesloop;
216 my $cnt;
217 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
218 my @advanced_search_types = split(/\|/, $advanced_search_types);
220 my $hidingrules = {};
221 my $yaml = C4::Context->preference('OpacHiddenItems');
222 if ( $yaml =~ /\S/ ) {
223 $yaml = "$yaml\n\n"; # YAML expects trailing newline. Surplus does not hurt.
224 eval {
225 $hidingrules = YAML::Load($yaml);
227 if ($@) {
228 warn "Unable to parse OpacHiddenItems syspref : $@";
232 foreach my $advanced_srch_type (@advanced_search_types) {
233 $advanced_srch_type =~ s/^\s*//;
234 $advanced_srch_type =~ s/\s*$//;
235 if ($advanced_srch_type eq 'itemtypes') {
236 # itemtype is a special case, since it's not defined in authorized values
237 my @itypesloop;
238 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
239 next if $hidingrules->{itype} && any { $_ eq $thisitemtype } @{$hidingrules->{itype}};
240 next if $hidingrules->{itemtype} && any { $_ eq $thisitemtype } @{$hidingrules->{itemtype}};
241 my %row =( number=>$cnt++,
242 ccl => "$itype_or_itemtype,phr",
243 code => $thisitemtype,
244 description => $itemtypes->{$thisitemtype}->{'description'},
245 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
247 push @itypesloop, \%row;
249 my %search_code = ( advanced_search_type => $advanced_srch_type,
250 code_loop => \@itypesloop );
251 push @advancedsearchesloop, \%search_code;
252 } else {
253 # covers all the other cases: non-itemtype authorized values
254 my $advsearchtypes = GetAuthorisedValues($advanced_srch_type, '', 'opac');
255 my @authvalueloop;
256 for my $thisitemtype (@$advsearchtypes) {
257 my $hiding_key = lc $thisitemtype->{category};
258 $hiding_key = "location" if $hiding_key eq 'loc';
259 next if $hidingrules->{$hiding_key} && any { $_ eq $thisitemtype->{authorised_value} } @{$hidingrules->{$hiding_key}};
260 my %row =(
261 number=>$cnt++,
262 ccl => $advanced_srch_type,
263 code => $thisitemtype->{authorised_value},
264 description => $thisitemtype->{'lib_opac'} || $thisitemtype->{'lib'},
265 imageurl => getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
267 push @authvalueloop, \%row;
269 my %search_code = ( advanced_search_type => $advanced_srch_type,
270 code_loop => \@authvalueloop );
271 push @advancedsearchesloop, \%search_code;
274 $template->param(advancedsearchesloop => \@advancedsearchesloop);
276 # The following should only be loaded if we're bringing up the advanced search template
277 if ( $template_type && $template_type eq 'advsearch' ) {
278 # load the servers (used for searching -- to do federated searching, etc.)
279 my $primary_servers_loop;# = displayPrimaryServers();
280 $template->param(outer_servers_loop => $primary_servers_loop,);
282 my $secondary_servers_loop;
283 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
285 # set the default sorting
286 if ( C4::Context->preference('OPACdefaultSortField')
287 && C4::Context->preference('OPACdefaultSortOrder') ) {
288 my $default_sort_by =
289 C4::Context->preference('OPACdefaultSortField') . '_'
290 . C4::Context->preference('OPACdefaultSortOrder');
291 $template->param( sort_by => $default_sort_by );
294 # determine what to display next to the search boxes (ie, boolean option
295 # shouldn't appear on the first one, scan indexes should, adding a new
296 # box should only appear on the last, etc.
297 my @search_boxes_array;
298 my $search_boxes_count = 3; # begin whith 3 boxes
299 $template->param( search_boxes_count => $search_boxes_count );
301 if ($cgi->cookie("num_paragraph")){
302 $search_boxes_count = $cgi->cookie("num_paragraph");
305 for (my $i=1;$i<=$search_boxes_count;$i++) {
306 # if it's the first one, don't display boolean option, but show scan indexes
307 if ($i==1) {
308 push @search_boxes_array,
310 scan_index => 1,
314 # if it's the last one, show the 'add field' box
315 elsif ($i==$search_boxes_count) {
316 push @search_boxes_array,
318 boolean => 1,
319 add_field => 1,
322 else {
323 push @search_boxes_array,
325 boolean => 1,
331 my @advsearch_limits = split /,/, C4::Context->preference('OpacAdvSearchOptions');
332 my @advsearch_more_limits = split /,/,
333 C4::Context->preference('OpacAdvSearchMoreOptions');
334 $template->param(
335 uc( C4::Context->preference("marcflavour") ) => 1, # we already did this for UNIMARC
336 advsearch => 1,
337 search_boxes_loop => \@search_boxes_array,
338 OpacAdvSearchOptions => \@advsearch_limits,
339 OpacAdvSearchMoreOptions => \@advsearch_more_limits,
342 # use the global setting by default
343 if ( C4::Context->preference("expandedSearchOption") == 1 ) {
344 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
346 # but let the user override it
347 if (defined $cgi->param('expanded_options')) {
348 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
349 $template->param( expanded_options => $cgi->param('expanded_options'));
353 if (C4::Context->preference('OPACNumbersPreferPhrase')) {
354 $template->param('numbersphr' => 1);
357 output_html_with_http_headers $cgi, $cookie, $template->output;
358 exit;
361 ### OK, if we're this far, we're performing an actual search
363 # Fetch the paramater list as a hash in scalar context:
364 # * returns paramater list as tied hash ref
365 # * we can edit the values by changing the key
366 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
367 my $params = $cgi->Vars;
368 my $tag;
369 if ( $params->{tag} ) {
370 $tag = $params->{tag};
371 $template->param( tag => $tag );
374 # String with params with the search criteria for the paging in opac-detail
375 # param value is URI encoded and params separator is HTML encode (&amp;)
376 my $pasarParams = '';
377 my $j = 0;
378 for (keys %$params) {
379 my @pasarParam = $cgi->param($_);
380 for my $paramValue(@pasarParam) {
381 $pasarParams .= '&amp;' if ($j > 0);
382 $pasarParams .= $_ . '=' . uri_escape_utf8($paramValue);
383 $j++;
387 # Params that can have more than one value
388 # sort by is used to sort the query
389 # in theory can have more than one but generally there's just one
390 my @sort_by;
391 my $default_sort_by;
392 if ( C4::Context->preference('OPACdefaultSortField')
393 && C4::Context->preference('OPACdefaultSortOrder') ) {
394 $default_sort_by =
395 C4::Context->preference('OPACdefaultSortField') . '_'
396 . C4::Context->preference('OPACdefaultSortOrder');
399 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/;
400 @sort_by = $cgi->param('sort_by');
401 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
402 foreach my $sort (@sort_by) {
403 if ( grep { /^$sort$/ } @allowed_sortby ) {
404 $template->param($sort => 1);
407 $template->param('sort_by' => $sort_by[0]);
409 # Use the servers defined, or just search our local catalog(default)
410 my @servers = $cgi->param('server');
411 unless (@servers) {
412 #FIXME: this should be handled using Context.pm
413 @servers = ("biblioserver");
414 # @servers = C4::Context->config("biblioserver");
417 # operators include boolean and proximity operators and are used
418 # to evaluate multiple operands
419 my @operators = $cgi->param('op');
420 @operators = map { uri_unescape($_) } @operators;
422 # indexes are query qualifiers, like 'title', 'author', etc. They
423 # can be single or multiple parameters separated by comma: kw,right-Truncation
424 my @indexes = $cgi->param('idx');
425 @indexes = map { uri_unescape($_) } @indexes;
427 # if a simple index (only one) display the index used in the top search box
428 if ($indexes[0] && !$indexes[1]) {
429 $template->param("ms_".$indexes[0] => 1);
431 # an operand can be a single term, a phrase, or a complete ccl query
432 my @operands = $cgi->param('q');
433 @operands = map { uri_unescape($_) } @operands;
435 $template->{VARS}->{querystring} = join(' ', @operands);
437 # if a simple search, display the value in the search box
438 if ($operands[0] && !$operands[1]) {
439 my $ms_query = $operands[0];
440 $ms_query =~ s/ #\S+//;
441 $template->param(ms_value => $ms_query);
444 # limits are use to limit to results to a pre-defined category such as branch or language
445 my @limits = $cgi->param('limit');
446 @limits = map { uri_unescape($_) } @limits;
447 my @nolimits = $cgi->param('nolimit');
448 @nolimits = map { uri_unescape($_) } @nolimits;
449 my %is_nolimit = map { $_ => 1 } @nolimits;
450 @limits = grep { not $is_nolimit{$_} } @limits;
452 if($params->{'multibranchlimit'}) {
453 my $multibranch = '('.join( " or ", map { "branch: $_ " } @{ GetBranchesInCategory( $params->{'multibranchlimit'} ) } ).')';
454 push @limits, $multibranch if ($multibranch ne '()');
457 my $available;
458 foreach my $limit(@limits) {
459 if ($limit =~/available/) {
460 $available = 1;
463 $template->param(available => $available);
465 # append year limits if they exist
466 if ($params->{'limit-yr'}) {
467 if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
468 my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
469 push @limits, "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
471 elsif ($params->{'limit-yr'} =~ /\d{4}/) {
472 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
474 else {
475 #FIXME: Should return a error to the user, incorect date format specified
479 # Params that can only have one value
480 my $scan = $params->{'scan'};
481 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
482 my $countRSS = C4::Context->preference('numSearchRSSResults') || 50;
483 my $results_per_page = $params->{'count'} || $count;
484 my $offset = $params->{'offset'} || 0;
485 my $page = $cgi->param('page') || 1;
486 $offset = ($page-1)*$results_per_page if $page>1;
487 my $hits;
488 my $expanded_facet = $params->{'expand'};
490 # Define some global variables
491 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
493 my @results;
495 ## I. BUILD THE QUERY
496 ( $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);
498 sub _input_cgi_parse {
499 my @elements;
500 for my $this_cgi ( split('&',shift) ) {
501 next unless $this_cgi;
502 $this_cgi =~ /(.*?)=(.*)/;
503 push @elements, { input_name => $1, input_value => Encode::decode_utf8( uri_unescape($2) ) };
505 return @elements;
508 ## parse the query_cgi string and put it into a form suitable for <input>s
509 my @query_inputs = _input_cgi_parse($query_cgi);
510 $template->param ( QUERY_INPUTS => \@query_inputs );
512 ## parse the limit_cgi string and put it into a form suitable for <input>s
513 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
515 # add OPAC 'hidelostitems'
516 #if (C4::Context->preference('hidelostitems') == 1) {
517 # # either lost ge 0 or no value in the lost register
518 # $query ="($query) and ( (lost,st-numeric <= 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='') )";
521 # add OPAC suppression - requires at least one item indexed with Suppress
522 if (C4::Context->preference('OpacSuppression')) {
523 # OPAC suppression by IP address
524 if (C4::Context->preference('OpacSuppressionByIPRange')) {
525 my $IPAddress = $ENV{'REMOTE_ADDR'};
526 my $IPRange = C4::Context->preference('OpacSuppressionByIPRange');
527 if ($IPAddress !~ /^$IPRange/) {
528 if ( $query_type eq 'pqf' ) {
529 $query = '@not '.$query.' @attr 1=9011 1';
530 } else {
531 $query = "($query) not Suppress=1";
535 else {
536 if ( $query_type eq 'pqf' ) {
537 #$query = "($query) && -(suppress:1)"; #QP syntax
538 $query = '@not '.$query.' @attr 1=9011 1'; #PQF syntax
539 } else {
540 $query = "($query) not Suppress=1";
545 $template->param ( LIMIT_INPUTS => \@limit_inputs );
546 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
548 ## II. DO THE SEARCH AND GET THE RESULTS
549 my $total = 0; # the total results for the whole set
550 my $facets; # this object stores the faceted results that display on the left-hand of the results page
551 my @results_array;
552 my $results_hashref;
553 my @coins;
555 if ($tag) {
556 $query_cgi = "tag=" .$tag . "&" . $query_cgi;
557 my $taglist = get_tags({term=>$tag, approved=>1});
558 $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
559 my @biblist = (map {GetBiblioData($_->{biblionumber})} @$taglist);
560 my @marclist = (map { (C4::Context->config('zebra_bib_index_mode') eq 'dom')? $_->{marcxml}: $_->{marc}; } @biblist);
561 $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
562 $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
563 # FIXME: tag search and standard search should work together, not exclusively
564 # FIXME: No facets for tags search.
565 } elsif ($build_grouped_results) {
566 eval {
567 ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
569 } else {
570 $pasarParams .= '&amp;query=' . uri_escape_utf8($query);
571 $pasarParams .= '&amp;count=' . uri_escape_utf8($results_per_page);
572 $pasarParams .= '&amp;simple_query=' . uri_escape_utf8($simple_query);
573 $pasarParams .= '&amp;query_type=' . uri_escape_utf8($query_type) if ($query_type);
574 eval {
575 ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$itemtypes,$query_type,$scan,1);
578 # This sorts the facets into alphabetical order
579 if ($facets) {
580 foreach my $f (@$facets) {
581 $f->{facets} = [ sort { uc($a->{facet_title_value}) cmp uc($b->{facet_title_value}) } @{ $f->{facets} } ];
583 @$facets = sort {$a->{expand} cmp $b->{expand}} @$facets;
586 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
587 if ($@ || $error) {
588 $template->param(query_error => $error.$@);
589 output_html_with_http_headers $cgi, $cookie, $template->output;
590 exit;
593 # At this point, each server has given us a result set
594 # now we build that set for template display
595 my @sup_results_array;
596 for (my $i=0;$i<@servers;$i++) {
597 my $server = $servers[$i];
598 if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
599 $hits = $results_hashref->{$server}->{"hits"};
600 my $page = $cgi->param('page') || 0;
601 my @newresults;
602 if ($build_grouped_results) {
603 foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
604 # because pazGetRecords handles retieving only the records
605 # we want as specified by $offset and $results_per_page,
606 # we need to set the offset parameter of searchResults to 0
607 my @group_results = searchResults( 'opac', $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
608 $group->{"RECORDS"});
609 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
611 } else {
612 @newresults = searchResults('opac', $query_desc, $hits, $results_per_page, $offset, $scan,
613 $results_hashref->{$server}->{"RECORDS"});
615 $hits = 0 unless @newresults;
617 foreach my $res (@newresults) {
619 # must define a value for size if not present in DB
620 # in order to avoid problems generated by the default size value in TT
621 if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
622 # while we're checking each line, see if item is in the cart
623 if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
624 $res->{'incart'} = 1;
627 if (C4::Context->preference('COinSinOPACResults')) {
628 my $record = GetMarcBiblio($res->{'biblionumber'});
629 $res->{coins} = GetCOinSBiblio($record);
631 if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
632 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
633 $isbn = $isbn->as_isbn13->as_string;
634 $isbn =~ s/-//g;
635 my $social_datas = C4::SocialData::get_data( $isbn );
636 if ( $social_datas ) {
637 for my $key ( keys %$social_datas ) {
638 $res->{$key} = $$social_datas{$key};
639 if ( $key eq 'score_avg' ){
640 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
647 if (C4::Context->preference('TagsEnabled') and
648 C4::Context->preference('TagsShowOnList')) {
649 if ( my $bibnum = $res->{biblionumber} ) {
650 $res->{itemsissued} = CountItemsIssued( $bibnum );
651 $res->{'TagLoop'} = get_tags({
652 biblionumber => $bibnum,
653 approved => 1,
654 sort => '-weight',
655 limit => C4::Context->preference('TagsShowOnList')
660 if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
661 my $rating = GetRating( $res->{'biblionumber'}, $borrowernumber );
662 $res->{'rating_value'} = $rating->{'rating_value'};
663 $res->{'rating_total'} = $rating->{'rating_total'};
664 $res->{'rating_avg'} = $rating->{'rating_avg'};
665 $res->{'rating_avg_int'} = $rating->{'rating_avg_int'};
669 if ($results_hashref->{$server}->{"hits"}){
670 $total = $total + $hits;
673 # Opac search history
674 if (C4::Context->preference('EnableOpacSearchHistory')) {
675 unless ( $offset ) {
676 my $path_info = $cgi->url(-path_info=>1);
677 my $query_cgi_history = $cgi->url(-query=>1);
678 $query_cgi_history =~ s/^$path_info\?//;
679 $query_cgi_history =~ s/;/&/g;
680 my $query_desc_history = join ", ", grep { defined $_ } $query_desc, $limit_desc;
682 unless ( $borrowernumber ) {
683 my $new_searches = C4::Search::History::add_to_session({
684 cgi => $cgi,
685 query_desc => $query_desc_history,
686 query_cgi => $query_cgi_history,
687 total => $total,
688 type => "biblio",
690 } else {
691 # To the session (the user is logged in)
692 C4::Search::History::add({
693 userid => $borrowernumber,
694 sessionid => $cgi->cookie("CGISESSID"),
695 query_desc => $query_desc_history,
696 query_cgi => $query_cgi_history,
697 total => $total,
698 type => "biblio",
702 $template->param( EnableOpacSearchHistory => 1 );
705 ## If there's just one result, redirect to the detail page
706 if ($total == 1 && $format ne 'rss2'
707 && $format ne 'opensearchdescription' && $format ne 'atom') {
708 my $biblionumber=$newresults[0]->{biblionumber};
709 if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
710 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
711 } elsif (C4::Context->preference('BiblioDefaultView') eq 'marc') {
712 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
713 } else {
714 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
716 exit;
718 if ($hits) {
719 if ( !$build_grouped_results ) {
720 # We build the encrypted list of first OPACnumSearchResults biblios to pass with the search criteria for paging on opac-detail
721 $pasarParams .= '&amp;listBiblios=';
722 my $j = 0;
723 foreach (@newresults) {
724 my $bibnum = ($_->{biblionumber})?$_->{biblionumber}:0;
725 $pasarParams .= uri_escape_utf8($bibnum) . ',';
726 $j++;
727 last if ($j == $results_per_page);
729 chop $pasarParams if ($pasarParams =~ /,$/);
730 $pasarParams .= '&amp;total=' . uri_escape_utf8( int($total) ) if ($pasarParams !~ /total=(?:[0-9]+)?/);
731 if ($pasarParams) {
732 my $session = get_session($cgi->cookie("CGISESSID"));
733 $session->param('busc' => $pasarParams);
737 $template->param(total => $hits);
738 my $limit_cgi_not_availablity = $limit_cgi;
739 $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
740 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
741 $template->param(limit_cgi => $limit_cgi);
742 $template->param(countrss => $countRSS );
743 $template->param(query_cgi => $query_cgi);
744 $template->param(query_desc => $query_desc);
745 $template->param(limit_desc => $limit_desc);
746 $template->param(offset => $offset);
747 $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
748 if ($query_desc || $limit_desc) {
749 $template->param(searchdesc => 1);
751 $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
752 $template->param(results_per_page => $results_per_page);
753 my $hide = C4::Context->preference('OpacHiddenItems');
754 $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
755 my $branch = '';
756 if (C4::Context->userenv){
757 $branch = C4::Context->userenv->{branch};
759 if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
760 if (
761 ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
763 C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
765 my $branchname;
766 if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
767 $branchname = $branches->{$branch}->{'branchname'};
769 elsif ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
770 $branchname = $branches->{ $ENV{'BRANCHCODE'} }->{'branchname'};
773 foreach my $res ( @newresults ) {
774 my @new_loop;
775 my @top_loop;
776 my @old_loop = @{$res->{'available_items_loop'}};
777 foreach my $item ( @old_loop ) {
778 if ( $item->{'branchname'} eq $branchname ) {
779 $item->{'this_branch'} = 1;
780 push( @top_loop, $item );
781 } else {
782 push( @new_loop, $item );
785 my @complete_loop = ( @top_loop, @new_loop );
786 $res->{'available_items_loop'} = \@complete_loop;
791 $template->param(
792 SEARCH_RESULTS => \@newresults,
793 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
794 suppress_result_number => $hide,
796 if (C4::Context->preference("OPACLocalCoverImages")){
797 $template->param(OPACLocalCoverImages => 1);
798 $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
800 ## Build the page numbers on the bottom of the page
801 my @page_numbers;
802 # total number of pages there will be
803 my $pages = ceil($hits / $results_per_page);
804 # default page number
805 my $current_page_number = 1;
806 if ($offset) {
807 $current_page_number = ( $offset / $results_per_page + 1 );
809 my $previous_page_offset;
810 if ( $offset >= $results_per_page ) {
811 $previous_page_offset = $offset - $results_per_page;
813 my $next_page_offset = $offset + $results_per_page;
814 # If we're within the first 10 pages, keep it simple
815 #warn "current page:".$current_page_number;
816 if ($current_page_number < 10) {
817 # just show the first 10 pages
818 # Loop through the pages
819 my $pages_to_show = 10;
820 $pages_to_show = $pages if $pages<10;
821 for ($i=1; $i<=$pages_to_show;$i++) {
822 # the offset for this page
823 my $this_offset = (($i*$results_per_page)-$results_per_page);
824 # the page number for this page
825 my $this_page_number = $i;
826 # put it in the array
827 push @page_numbers,
828 { offset => $this_offset,
829 pg => $this_page_number,
830 highlight => $this_page_number == $current_page_number,
831 sort_by => join ' ', @sort_by
837 # now, show twenty pages, with the current one smack in the middle
838 else {
839 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
840 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
841 my $this_page_number = $i-9;
842 if ( $this_page_number <= $pages ) {
843 push @page_numbers,
844 { offset => $this_offset,
845 pg => $this_page_number,
846 highlight => $this_page_number == $current_page_number,
847 sort_by => join ' ', @sort_by
853 $template->param( PAGE_NUMBERS => \@page_numbers,
854 previous_page_offset => $previous_page_offset) unless $pages < 2;
855 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
857 # no hits
858 else {
859 my $nohits = C4::Context->preference('OPACNoResultsFound');
860 if ($nohits and $nohits=~/{QUERY_KW}/){
861 # extracting keywords in case of relaunching search
862 (my $query_kw=$query_desc)=~s/ and|or / /g;
863 $query_kw = Encode::decode_utf8($query_kw);
864 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^,:]|$)/g);
865 $query_kw=join('+',@query_kw);
866 $nohits=~s/{QUERY_KW}/$query_kw/g;
867 $template->param('OPACNoResultsFound' =>$nohits);
869 $template->param(
870 searchdesc => 1,
871 query_desc => $query_desc,
872 limit_desc => $limit_desc,
873 query_cgi => $query_cgi,
874 limit_cgi => $limit_cgi
877 } # end of the if local
878 # asynchronously search the authority server
879 elsif ($server && $server =~/authorityserver/) { # this is the local authority server
880 my @inner_sup_results_array;
881 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
882 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
883 my $title_field = $marc_record_object->field(100);
884 push @inner_sup_results_array, {
885 'title' => $title_field->subfield('a'),
886 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
889 my $servername = $server;
890 push @sup_results_array, { servername => $servername,
891 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
893 # FIXME: can add support for other targets as needed here
894 $template->param( outer_sup_results_loop => \@sup_results_array);
895 } #/end of the for loop
896 #$template->param(FEDERATED_RESULTS => \@results_array);
898 for my $facet ( @$facets ) {
899 for my $entry ( @{ $facet->{facets} } ) {
900 my $index = $entry->{type_link_value};
901 my $value = $entry->{facet_link_value};
902 $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
907 $template->param(
908 #classlist => $classlist,
909 total => $total,
910 opacfacets => 1,
911 facets_loop => $facets,
912 displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
913 scan => $scan,
914 search_error => $error,
917 if ($query_desc || $limit_desc) {
918 $template->param(searchdesc => 1);
921 # VI. BUILD THE TEMPLATE
922 # Build drop-down list for 'Add To:' menu...
923 my ($totalref, $pubshelves, $barshelves)=
924 C4::VirtualShelves::GetSomeShelfNames($borrowernumber,'COMBO',1);
925 $template->param(
926 addbarshelves => $totalref->{bartotal},
927 addbarshelvesloop => $barshelves,
928 addpubshelves => $totalref->{pubtotal},
929 addpubshelvesloop => $pubshelves,
932 my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
934 # If GoogleIndicTransliteration system preference is On Set paramter to load Google's javascript in OPAC search screens
935 if (C4::Context->preference('GoogleIndicTransliteration')) {
936 $template->param('GoogleIndicTransliteration' => 1);
939 $template->{VARS}->{DidYouMean} =
940 ( defined C4::Context->preference('OPACdidyoumean')
941 && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
942 $template->{VARS}->{IDreamBooksReviews} = C4::Context->preference('IDreamBooksReviews');
943 $template->{VARS}->{IDreamBooksReadometer} = C4::Context->preference('IDreamBooksReadometer');
944 $template->{VARS}->{IDreamBooksResults} = C4::Context->preference('IDreamBooksResults');
946 if ($offset == 0 && IsOverDriveEnabled()) {
947 $template->param(OverDriveEnabled => 1);
948 $template->param(OverDriveLibraryID => C4::Context->preference('OverDriveLibraryID'));
951 $template->param( borrowernumber => $borrowernumber);
952 output_with_http_headers $cgi, $cookie, $template->output, $content_type;