opac/opac-search.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2008 Garry Collum and the Koha Development team
   4 # Copyright 2010 BibLibre
   5 # Copyright 2011 KohaAloha, NZ
   6 #
   7 # This file is part of Koha.
   8 #
   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.
  13 #
  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.
  17 #
  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.
  21
  22 # Script to perform searching
  23 # Mostly copied from search.pl, see POD there
  24 use Modern::Perl;
  25
  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
  32 my $searchengine = C4::Context->preference("SearchEngine");
  33 if ( $searchengine =~ /^Solr$/ ) {
  34     warn "We use Solr";
  35     require 'opac/search.pl';
  36     exit;
  37 } elsif ( $searchengine =~ /^Zebra$/ ) {
  38
  39 }
  40
  41 use C4::Output;
  42 use C4::Auth qw(:DEFAULT get_session);
  43 use C4::Languages qw(getLanguages);
  44 use C4::Search;
  45 use C4::Search::History;
  46 use C4::Biblio;  # GetBiblioData
  47 use C4::Koha;
  48 use C4::Tags qw(get_tags);
  49 use C4::Branch; # GetBranches
  50 use C4::SocialData;
  51 use C4::Ratings;
  52 use C4::External::OverDrive;
  53
  54 use POSIX qw(ceil floor strftime);
  55 use URI::Escape;
  56 use JSON qw/decode_json encode_json/;
  57 use Business::ISBN;
  58
  59 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
  60 # create a new CGI object
  61 # FIXME: no_undef_params needs to be tested
  62 use CGI qw('-no_undef_params');
  63 my $cgi = new CGI;
  64
  65 my $branch_group_limit = $cgi->param("branch_group_limit");
  66 if ( $branch_group_limit ) {
  67     if ( $branch_group_limit =~ /^multibranchlimit-/ ) {
  68         # For search groups we are going to convert this branch_group_limit CGI
  69         # parameter into a multibranchlimit CGI parameter for the purposes of
  70         # actually performing the query
  71         $cgi->param(
  72             -name => 'multibranchlimit',
  73             -values => substr($branch_group_limit, 17)
  74         );
  75     } else {
  76         $cgi->append(
  77             -name => 'limit',
  78             -values => [ $branch_group_limit ]
  79         );
  80     }
  81 }
  82
  83 BEGIN {
  84     if (C4::Context->preference('BakerTaylorEnabled')) {
  85         require C4::External::BakerTaylor;
  86         import C4::External::BakerTaylor qw(&image_url &link_url);
  87     }
  88 }
  89
  90 my ($template,$borrowernumber,$cookie);
  91 # decide which template to use
  92 my $template_name;
  93 my $template_type = 'basic';
  94 my @params = $cgi->param("limit");
  95
  96
  97 my $format = $cgi->param("format") || '';
  98 my $build_grouped_results = C4::Context->preference('OPACGroupResults');
  99 if ($format =~ /(rss|atom|opensearchdescription)/) {
 100     $template_name = 'opac-opensearch.tt';
 101 }
 102 elsif (@params && $build_grouped_results) {
 103     $template_name = 'opac-results-grouped.tt';
 104 }
 105 elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
 106     $template_name = 'opac-results.tt';
 107 }
 108 else {
 109     $template_name = 'opac-advsearch.tt';
 110     $template_type = 'advsearch';
 111 }
 112 # load the template
 113 ($template, $borrowernumber, $cookie) = get_template_and_user({
 114     template_name => $template_name,
 115     query => $cgi,
 116     type => "opac",
 117     authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
 118     }
 119 );
 120
 121 my $lang = C4::Languages::getlanguage($cgi);
 122
 123 if ($template_name eq 'opac-results.tt') {
 124    $template->param('COinSinOPACResults' => C4::Context->preference('COinSinOPACResults'));
 125 }
 126
 127 # get biblionumbers stored in the cart
 128 my @cart_list;
 129
 130 if($cgi->cookie("bib_list")){
 131     my $cart_list = $cgi->cookie("bib_list");
 132     @cart_list = split(/\//, $cart_list);
 133 }
 134
 135 if ($format eq 'rss2' or $format eq 'opensearchdescription' or $format eq 'atom') {
 136     $template->param($format => 1);
 137     $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime)) if ($format eq 'atom');
 138     # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
 139     # entry, but not sure if that's worth an extra database query for each bib
 140 }
 141 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
 142     $template->param('UNIMARC' => 1);
 143 }
 144 elsif (C4::Context->preference("marcflavour") eq "MARC21" ) {
 145     $template->param('usmarc' => 1);
 146 }
 147 $template->param( 'AllowOnShelfHolds' => C4::Context->preference('AllowOnShelfHolds') );
 148 $template->param( 'OPACNoResultsFound' => C4::Context->preference('OPACNoResultsFound') );
 149
 150 $template->param(
 151     OpacStarRatings => C4::Context->preference("OpacStarRatings") );
 152
 153 if (C4::Context->preference('BakerTaylorEnabled')) {
 154     $template->param(
 155         BakerTaylorEnabled  => 1,
 156         BakerTaylorImageURL => &image_url(),
 157         BakerTaylorLinkURL  => &link_url(),
 158         BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
 159     );
 160 }
 161
 162 if (C4::Context->preference('TagsEnabled')) {
 163     $template->param(TagsEnabled => 1);
 164     foreach (qw(TagsShowOnList TagsInputOnList)) {
 165         C4::Context->preference($_) and $template->param($_ => 1);
 166     }
 167 }
 168
 169 ## URI Re-Writing
 170 # Deprecated, but preserved because it's interesting :-)
 171 # The same thing can be accomplished with mod_rewrite in
 172 # a more elegant way
 173 #
 174 #my $rewrite_flag;
 175 #my $uri = $cgi->url(-base => 1);
 176 #my $relative_url = $cgi->url(-relative=>1);
 177 #$uri.="/".$relative_url."?";
 178 #warn "URI:$uri";
 179 #my @cgi_params_list = $cgi->param();
 180 #my $url_params = $cgi->Vars;
 181 #
 182 #for my $each_param_set (@cgi_params_list) {
 183 #    $uri.= join "",  map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
 184 #}
 185 #warn "New URI:$uri";
 186 # Only re-write a URI if there are params or if it already hasn't been re-written
 187 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
 188 #    print $cgi->redirect(     -uri=>$uri."&r=1",
 189 #                            -cookie => $cookie);
 190 #    exit;
 191 #}
 192
 193 # load the branches
 194
 195 my $branches = GetBranches();   # used later in *getRecords, probably should be internalized by those functions after caching in C4::Branch is established
 196 $template->param(
 197     searchdomainloop => GetBranchCategories('searchdomain'),
 198 );
 199
 200 # load the language limits (for search)
 201 my $languages_limit_loop = getLanguages($lang, 1);
 202 $template->param(search_languages_loop => $languages_limit_loop,);
 203
 204 # load the Type stuff
 205 my $itemtypes = GetItemTypes;
 206 # the index parameter is different for item-level itemtypes
 207 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
 208 my @advancedsearchesloop;
 209 my $cnt;
 210 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 211 my @advanced_search_types = split(/\|/, $advanced_search_types);
 212
 213 foreach my $advanced_srch_type (@advanced_search_types) {
 214    if ($advanced_srch_type eq 'itemtypes') {
 215    # itemtype is a special case, since it's not defined in authorized values
 216         my @itypesloop;
 217         foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
 218             my %row =(  number=>$cnt++,
 219                 ccl => "$itype_or_itemtype,phr",
 220                 code => $thisitemtype,
 221                 description => $itemtypes->{$thisitemtype}->{'description'},
 222                 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
 223             );
 224             push @itypesloop, \%row;
 225         }
 226         my %search_code = (  advanced_search_type => $advanced_srch_type,
 227                              code_loop => \@itypesloop );
 228         push @advancedsearchesloop, \%search_code;
 229     } else {
 230     # covers all the other cases: non-itemtype authorized values
 231        my $advsearchtypes = GetAuthorisedValues($advanced_srch_type, '', 'opac');
 232         my @authvalueloop;
 233         for my $thisitemtype (@$advsearchtypes) {
 234                 my %row =(
 235                                 number=>$cnt++,
 236                                 ccl => $advanced_srch_type,
 237                 code => $thisitemtype->{authorised_value},
 238                 description => $thisitemtype->{'lib_opac'} || $thisitemtype->{'lib'},
 239                 imageurl => getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
 240                 );
 241                 push @authvalueloop, \%row;
 242         }
 243         my %search_code = (  advanced_search_type => $advanced_srch_type,
 244                              code_loop => \@authvalueloop );
 245         push @advancedsearchesloop, \%search_code;
 246     }
 247 }
 248 $template->param(advancedsearchesloop => \@advancedsearchesloop);
 249
 250 # The following should only be loaded if we're bringing up the advanced search template
 251 if ( $template_type && $template_type eq 'advsearch' ) {
 252     # load the servers (used for searching -- to do federated searching, etc.)
 253     my $primary_servers_loop;# = displayPrimaryServers();
 254     $template->param(outer_servers_loop =>  $primary_servers_loop,);
 255
 256     my $secondary_servers_loop;
 257     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 258
 259     # set the default sorting
 260     if (   C4::Context->preference('OPACdefaultSortField')
 261         && C4::Context->preference('OPACdefaultSortOrder') ) {
 262         my $default_sort_by =
 263             C4::Context->preference('OPACdefaultSortField') . '_'
 264           . C4::Context->preference('OPACdefaultSortOrder');
 265         $template->param( sort_by => $default_sort_by );
 266     }
 267
 268     # determine what to display next to the search boxes (ie, boolean option
 269     # shouldn't appear on the first one, scan indexes should, adding a new
 270     # box should only appear on the last, etc.
 271     my @search_boxes_array;
 272     my $search_boxes_count = 3; # begin whith 3 boxes
 273     for (my $i=1;$i<=$search_boxes_count;$i++) {
 274         # if it's the first one, don't display boolean option, but show scan indexes
 275         if ($i==1) {
 276             push @search_boxes_array,
 277                 {
 278                 scan_index => 1,
 279                 };
 280
 281         }
 282         # if it's the last one, show the 'add field' box
 283         elsif ($i==$search_boxes_count) {
 284             push @search_boxes_array,
 285                 {
 286                 boolean => 1,
 287                 add_field => 1,
 288                 };
 289         }
 290         else {
 291             push @search_boxes_array,
 292                 {
 293                 boolean => 1,
 294                 };
 295         }
 296
 297     }
 298     $template->param(uc(    C4::Context->preference("marcflavour")) => 1,   # we already did this for UNIMARC
 299                             advsearch => 1,
 300                             search_boxes_loop => \@search_boxes_array);
 301
 302     # use the global setting by default
 303     if ( C4::Context->preference("expandedSearchOption") == 1 ) {
 304         $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
 305     }
 306     # but let the user override it
 307     if (defined $cgi->param('expanded_options')) {
 308         if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
 309             $template->param( expanded_options => $cgi->param('expanded_options'));
 310         }
 311     }
 312
 313     if (C4::Context->preference('OPACNumbersPreferPhrase')) {
 314         $template->param('numbersphr' => 1);
 315     }
 316
 317     output_html_with_http_headers $cgi, $cookie, $template->output;
 318     exit;
 319 }
 320
 321 ### OK, if we're this far, we're performing an actual search
 322
 323 # Fetch the paramater list as a hash in scalar context:
 324 #  * returns paramater list as tied hash ref
 325 #  * we can edit the values by changing the key
 326 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 327 my $params = $cgi->Vars;
 328 my $tag;
 329 $tag = $params->{tag} if $params->{tag};
 330
 331
 332 # String with params with the search criteria for the paging in opac-detail
 333 my $pasarParams = '';
 334 my $j = 0;
 335 for (keys %$params) {
 336     my @pasarParam = $cgi->param($_);
 337     for my $paramValue(@pasarParam) {
 338         $pasarParams .= '&amp;' if ($j > 0);
 339         $pasarParams .= $_ . '=' . $paramValue;
 340         $j++;
 341     }
 342 }
 343
 344 # Params that can have more than one value
 345 # sort by is used to sort the query
 346 # in theory can have more than one but generally there's just one
 347 my @sort_by;
 348 my $default_sort_by;
 349 if (   C4::Context->preference('OPACdefaultSortField')
 350     && C4::Context->preference('OPACdefaultSortOrder') ) {
 351     $default_sort_by =
 352         C4::Context->preference('OPACdefaultSortField') . '_'
 353       . C4::Context->preference('OPACdefaultSortOrder');
 354 }
 355
 356 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/;
 357 @sort_by = $cgi->param('sort_by');
 358 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
 359 foreach my $sort (@sort_by) {
 360     if ( grep { /^$sort$/ } @allowed_sortby ) {
 361         $template->param($sort => 1);
 362     }
 363 }
 364 $template->param('sort_by' => $sort_by[0]);
 365
 366 # Use the servers defined, or just search our local catalog(default)
 367 my @servers = $cgi->param('server');
 368 unless (@servers) {
 369     #FIXME: this should be handled using Context.pm
 370     @servers = ("biblioserver");
 371     # @servers = C4::Context->config("biblioserver");
 372 }
 373
 374 # operators include boolean and proximity operators and are used
 375 # to evaluate multiple operands
 376 my @operators = $cgi->param('op');
 377 @operators = map { uri_unescape($_) } @operators;
 378
 379 # indexes are query qualifiers, like 'title', 'author', etc. They
 380 # can be single or multiple parameters separated by comma: kw,right-Truncation
 381 my @indexes = $cgi->param('idx');
 382 @indexes = map { uri_unescape($_) } @indexes;
 383
 384 # if a simple index (only one)  display the index used in the top search box
 385 if ($indexes[0] && !$indexes[1]) {
 386     $template->param("ms_".$indexes[0] => 1);
 387 }
 388 # an operand can be a single term, a phrase, or a complete ccl query
 389 my @operands = $cgi->param('q');
 390 @operands = map { uri_unescape($_) } @operands;
 391
 392 $template->{VARS}->{querystring} = join(' ', @operands);
 393
 394 # if a simple search, display the value in the search box
 395 if ($operands[0] && !$operands[1]) {
 396     my $ms_query = $operands[0];
 397     $ms_query =~ s/ #\S+//;
 398     $template->param(ms_value => $ms_query);
 399 }
 400
 401 # limits are use to limit to results to a pre-defined category such as branch or language
 402 my @limits = $cgi->param('limit');
 403 my @nolimits = $cgi->param('nolimit');
 404 my %is_nolimit = map { $_ => 1 } @nolimits;
 405 @limits = grep { not $is_nolimit{$_} } @limits;
 406 @limits = map { uri_unescape($_) } @limits;
 407
 408 if($params->{'multibranchlimit'}) {
 409     my $multibranch = '('.join( " or ", map { "branch: $_ " } @{ GetBranchesInCategory( $params->{'multibranchlimit'} ) } ).')';
 410     push @limits, $multibranch if ($multibranch ne  '()');
 411 }
 412
 413 my $available;
 414 foreach my $limit(@limits) {
 415     if ($limit =~/available/) {
 416         $available = 1;
 417     }
 418 }
 419 $template->param(available => $available);
 420
 421 # append year limits if they exist
 422 if ($params->{'limit-yr'}) {
 423     if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
 424         my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
 425         push @limits, "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
 426     }
 427     elsif ($params->{'limit-yr'} =~ /\d{4}/) {
 428         push @limits, "yr,st-numeric=$params->{'limit-yr'}";
 429     }
 430     else {
 431         #FIXME: Should return a error to the user, incorect date format specified
 432     }
 433 }
 434
 435 # Params that can only have one value
 436 my $scan = $params->{'scan'};
 437 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
 438 my $countRSS         = C4::Context->preference('numSearchRSSResults') || 50;
 439 my $results_per_page = $params->{'count'} || $count;
 440 my $offset = $params->{'offset'} || 0;
 441 my $page = $cgi->param('page') || 1;
 442 $offset = ($page-1)*$results_per_page if $page>1;
 443 my $hits;
 444 my $expanded_facet = $params->{'expand'};
 445
 446 # Define some global variables
 447 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
 448
 449 my @results;
 450
 451 ## I. BUILD THE QUERY
 452 ( $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);
 453
 454 sub _input_cgi_parse {
 455     my @elements;
 456     for my $this_cgi ( split('&',shift) ) {
 457         next unless $this_cgi;
 458         $this_cgi =~ /(.*?)=(.*)/;
 459         push @elements, { input_name => $1, input_value => uri_unescape($2) };
 460     }
 461     return @elements;
 462 }
 463
 464 ## parse the query_cgi string and put it into a form suitable for <input>s
 465 my @query_inputs = _input_cgi_parse($query_cgi);
 466 $template->param ( QUERY_INPUTS => \@query_inputs );
 467
 468 ## parse the limit_cgi string and put it into a form suitable for <input>s
 469 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
 470
 471 # add OPAC 'hidelostitems'
 472 #if (C4::Context->preference('hidelostitems') == 1) {
 473 #    # either lost ge 0 or no value in the lost register
 474 #    $query ="($query) and ( (lost,st-numeric <= 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='') )";
 475 #}
 476 #
 477 # add OPAC suppression - requires at least one item indexed with Suppress
 478 if (C4::Context->preference('OpacSuppression')) {
 479     # OPAC suppression by IP address
 480     if (C4::Context->preference('OpacSuppressionByIPRange')) {
 481         my $IPAddress = $ENV{'REMOTE_ADDR'};
 482         my $IPRange = C4::Context->preference('OpacSuppressionByIPRange');
 483         if ($IPAddress !~ /^$IPRange/)  {
 484             if ( $query_type eq 'pqf' ) {
 485                 $query = '@not '.$query.' @attr 1=9011 1';
 486             } else {
 487                 $query = "($query) not Suppress=1";
 488             }
 489         }
 490     }
 491     else {
 492         if ( $query_type eq 'pqf' ) {
 493             #$query = "($query) && -(suppress:1)"; #QP syntax
 494             $query = '@not '.$query.' @attr 1=9011 1'; #PQF syntax
 495         } else {
 496             $query = "($query) not Suppress=1";
 497         }
 498     }
 499 }
 500
 501 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 502 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
 503
 504 ## II. DO THE SEARCH AND GET THE RESULTS
 505 my $total = 0; # the total results for the whole set
 506 my $facets; # this object stores the faceted results that display on the left-hand of the results page
 507 my @results_array;
 508 my $results_hashref;
 509 my @coins;
 510
 511 if ($tag) {
 512     $query_cgi = "tag=" .$tag . "&" . $query_cgi;
 513     my $taglist = get_tags({term=>$tag, approved=>1});
 514     $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
 515     my @biblist  = (map {GetBiblioData($_->{biblionumber})} @$taglist);
 516     my @marclist = (map { (C4::Context->config('zebra_bib_index_mode') eq 'dom')? $_->{marcxml}: $_->{marc}; } @biblist);
 517     $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
 518     $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
 519     # FIXME: tag search and standard search should work together, not exclusively
 520     # FIXME: No facets for tags search.
 521 } elsif ($build_grouped_results) {
 522     eval {
 523         ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
 524     };
 525 } else {
 526     $pasarParams .= '&amp;query=' . $query;
 527     $pasarParams .= '&amp;count=' . $results_per_page;
 528     $pasarParams .= '&amp;simple_query=' . $simple_query;
 529     $pasarParams .= '&amp;query_type=' . $query_type if ($query_type);
 530     eval {
 531         ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$itemtypes,$query_type,$scan,1);
 532     };
 533 }
 534 # This sorts the facets into alphabetical order
 535 if ($facets) {
 536     foreach my $f (@$facets) {
 537         $f->{facets} = [ sort { uc($a->{facet_title_value}) cmp uc($b->{facet_title_value}) } @{ $f->{facets} } ];
 538     }
 539     @$facets = sort {$a->{expand} cmp $b->{expand}} @$facets;
 540 }
 541
 542 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
 543 if ($@ || $error) {
 544     $template->param(query_error => $error.$@);
 545     output_html_with_http_headers $cgi, $cookie, $template->output;
 546     exit;
 547 }
 548
 549 # At this point, each server has given us a result set
 550 # now we build that set for template display
 551 my @sup_results_array;
 552 for (my $i=0;$i<@servers;$i++) {
 553     my $server = $servers[$i];
 554     if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
 555         $hits = $results_hashref->{$server}->{"hits"};
 556         my $page = $cgi->param('page') || 0;
 557         my @newresults;
 558         if ($build_grouped_results) {
 559             foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
 560                 # because pazGetRecords handles retieving only the records
 561                 # we want as specified by $offset and $results_per_page,
 562                 # we need to set the offset parameter of searchResults to 0
 563                 my @group_results = searchResults( 'opac', $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
 564                                                    $group->{"RECORDS"});
 565                 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
 566             }
 567         } else {
 568             @newresults = searchResults('opac', $query_desc, $hits, $results_per_page, $offset, $scan,
 569                                         $results_hashref->{$server}->{"RECORDS"});
 570         }
 571         $hits = 0 unless @newresults;
 572
 573         foreach my $res (@newresults) {
 574
 575             # must define a value for size if not present in DB
 576             # in order to avoid problems generated by the default size value in TT
 577             if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
 578             # while we're checking each line, see if item is in the cart
 579             if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
 580                 $res->{'incart'} = 1;
 581             }
 582
 583             if (C4::Context->preference('COinSinOPACResults')) {
 584                 my $record = GetMarcBiblio($res->{'biblionumber'});
 585                 $res->{coins} = GetCOinSBiblio($record);
 586             }
 587             if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
 588                 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
 589                     $isbn = $isbn->as_isbn13->as_string;
 590                     $isbn =~ s/-//g;
 591                     my $social_datas = C4::SocialData::get_data( $isbn );
 592                     if ( $social_datas ) {
 593                         for my $key ( keys %$social_datas ) {
 594                             $res->{$key} = $$social_datas{$key};
 595                             if ( $key eq 'score_avg' ){
 596                                 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
 597                             }
 598                         }
 599                     }
 600                 }
 601             }
 602
 603             if (C4::Context->preference('TagsEnabled') and
 604                 C4::Context->preference('TagsShowOnList')) {
 605                 if ( my $bibnum = $res->{biblionumber} ) {
 606                     $res->{itemsissued} = CountItemsIssued( $bibnum );
 607                     $res->{'TagLoop'} = get_tags({
 608                         biblionumber => $bibnum,
 609                         approved => 1,
 610                         sort => '-weight',
 611                         limit => C4::Context->preference('TagsShowOnList')
 612                     });
 613                 }
 614             }
 615
 616             if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
 617                 my $rating = GetRating( $res->{'biblionumber'}, $borrowernumber );
 618                 $res->{'rating_value'}  = $rating->{'rating_value'};
 619                 $res->{'rating_total'}  = $rating->{'rating_total'};
 620                 $res->{'rating_avg'}    = $rating->{'rating_avg'};
 621                 $res->{'rating_avg_int'} = $rating->{'rating_avg_int'};
 622             }
 623         }
 624
 625         if ($results_hashref->{$server}->{"hits"}){
 626             $total = $total + $hits;
 627         }
 628
 629         # Opac search history
 630         if (C4::Context->preference('EnableOpacSearchHistory')) {
 631             unless ( $offset ) {
 632                 my $path_info = $cgi->url(-path_info=>1);
 633                 my $query_cgi_history = $cgi->url(-query=>1);
 634                 $query_cgi_history =~ s/^$path_info\?//;
 635                 $query_cgi_history =~ s/;/&/g;
 636                 my $query_desc_history = join ", ", grep { defined $_ } $query_desc, $limit_desc;
 637
 638                 unless ( $borrowernumber ) {
 639                     my $new_searches = C4::Search::History::add_to_session({
 640                             cgi => $cgi,
 641                             query_desc => $query_desc_history,
 642                             query_cgi => $query_cgi_history,
 643                             total => $total,
 644                             type => "biblio",
 645                     });
 646                 } else {
 647                     # To the session (the user is logged in)
 648                     C4::Search::History::add({
 649                         userid => $borrowernumber,
 650                         sessionid => $cgi->cookie("CGISESSID"),
 651                         query_desc => $query_desc_history,
 652                         query_cgi => $query_cgi_history,
 653                         total => $total,
 654                         type => "biblio",
 655                     });
 656                 }
 657             }
 658             $template->param( EnableOpacSearchHistory => 1 );
 659         }
 660
 661         ## If there's just one result, redirect to the detail page
 662         if ($total == 1 && $format ne 'rss2'
 663         && $format ne 'opensearchdescription' && $format ne 'atom') {
 664             my $biblionumber=$newresults[0]->{biblionumber};
 665             if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
 666                 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
 667             } elsif  (C4::Context->preference('BiblioDefaultView') eq 'marc') {
 668                 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
 669             } else {
 670                 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
 671             }
 672             exit;
 673         }
 674         if ($hits) {
 675             if ( !$build_grouped_results ) {
 676                 # We build the encrypted list of first OPACnumSearchResults biblios to pass with the search criteria for paging on opac-detail
 677                 $pasarParams .= '&amp;listBiblios=';
 678                 my $j = 0;
 679                 foreach (@newresults) {
 680                     my $bibnum = ($_->{biblionumber})?$_->{biblionumber}:0;
 681                     $pasarParams .= $bibnum . ',';
 682                     $j++;
 683                     last if ($j == $results_per_page);
 684                 }
 685                 chop $pasarParams if ($pasarParams =~ /,$/);
 686                 $pasarParams .= '&amp;total=' . int($total) if ($pasarParams !~ /total=(?:[0-9]+)?/);
 687                 if ($pasarParams) {
 688                     my $session = get_session($cgi->cookie("CGISESSID"));
 689                     $session->param('busc' => $pasarParams);
 690                 }
 691                 #
 692             }
 693             $template->param(total => $hits);
 694             my $limit_cgi_not_availablity = $limit_cgi;
 695             $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
 696             $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
 697             $template->param(limit_cgi => $limit_cgi);
 698             $template->param(countrss  => $countRSS );
 699             $template->param(query_cgi => $query_cgi);
 700             $template->param(query_desc => $query_desc);
 701             $template->param(limit_desc => $limit_desc);
 702             $template->param(offset     => $offset);
 703             $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
 704             if ($query_desc || $limit_desc) {
 705                 $template->param(searchdesc => 1);
 706             }
 707             $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
 708             $template->param(results_per_page =>  $results_per_page);
 709             my $hide = C4::Context->preference('OpacHiddenItems');
 710             $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
 711             my $branch = '';
 712             if (C4::Context->userenv){
 713                 $branch = C4::Context->userenv->{branch};
 714             }
 715             if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
 716                 if (
 717                     ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
 718                     ||
 719                     C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
 720                 ) {
 721                     my $branchname;
 722                     if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
 723                         $branchname = $branches->{$branch}->{'branchname'};
 724                     }
 725                     elsif (  C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
 726                         $branchname = $branches->{ $ENV{'BRANCHCODE'} }->{'branchname'};
 727                     }
 728
 729                     foreach my $res ( @newresults ) {
 730                         my @new_loop;
 731                         my @top_loop;
 732                         my @old_loop = @{$res->{'available_items_loop'}};
 733                         foreach my $item ( @old_loop ) {
 734                             if ( $item->{'branchname'} eq $branchname ) {
 735                                 $item->{'this_branch'} = 1;
 736                                 push( @top_loop, $item );
 737                             } else {
 738                                 push( @new_loop, $item );
 739                             }
 740                         }
 741                         my @complete_loop = ( @top_loop, @new_loop );
 742                         $res->{'available_items_loop'} = \@complete_loop;
 743                     }
 744                 }
 745             }
 746
 747             $template->param(
 748                 SEARCH_RESULTS => \@newresults,
 749                 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
 750                 suppress_result_number => $hide,
 751                             );
 752             if (C4::Context->preference("OPACLocalCoverImages")){
 753                 $template->param(OPACLocalCoverImages => 1);
 754                 $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
 755             }
 756             ## Build the page numbers on the bottom of the page
 757             my @page_numbers;
 758             # total number of pages there will be
 759             my $pages = ceil($hits / $results_per_page);
 760             # default page number
 761             my $current_page_number = 1;
 762             if ($offset) {
 763                 $current_page_number = ( $offset / $results_per_page + 1 );
 764             }
 765             my $previous_page_offset;
 766             if ( $offset >= $results_per_page ) {
 767                 $previous_page_offset = $offset - $results_per_page;
 768             }
 769             my $next_page_offset = $offset + $results_per_page;
 770             # If we're within the first 10 pages, keep it simple
 771             #warn "current page:".$current_page_number;
 772             if ($current_page_number < 10) {
 773                 # just show the first 10 pages
 774                 # Loop through the pages
 775                 my $pages_to_show = 10;
 776                 $pages_to_show = $pages if $pages<10;
 777                 for ($i=1; $i<=$pages_to_show;$i++) {
 778                     # the offset for this page
 779                     my $this_offset = (($i*$results_per_page)-$results_per_page);
 780                     # the page number for this page
 781                     my $this_page_number = $i;
 782                     # put it in the array
 783                     push @page_numbers,
 784                       { offset    => $this_offset,
 785                         pg        => $this_page_number,
 786                         highlight => $this_page_number == $current_page_number,
 787                         sort_by   => join ' ', @sort_by
 788                       };
 789
 790                 }
 791
 792             }
 793             # now, show twenty pages, with the current one smack in the middle
 794             else {
 795                 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
 796                     my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
 797                     my $this_page_number = $i-9;
 798                     if ( $this_page_number <= $pages ) {
 799                         push @page_numbers,
 800                           { offset    => $this_offset,
 801                             pg        => $this_page_number,
 802                             highlight => $this_page_number == $current_page_number,
 803                             sort_by => join ' ', @sort_by
 804                           };
 805                     }
 806                 }
 807
 808             }
 809             $template->param(   PAGE_NUMBERS => \@page_numbers,
 810                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
 811             $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
 812         }
 813         # no hits
 814         else {
 815             my $nohits = C4::Context->preference('OPACNoResultsFound');
 816             if ($nohits and $nohits=~/{QUERY_KW}/){
 817                 # extracting keywords in case of relaunching search
 818                 (my $query_kw=$query_desc)=~s/ and|or / /g;
 819                 $query_kw = Encode::decode_utf8($query_kw);
 820                 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^,:]|$)/g);
 821                 $query_kw=join('+',@query_kw);
 822                 $nohits=~s/{QUERY_KW}/$query_kw/g;
 823                 $template->param('OPACNoResultsFound' =>$nohits);
 824             }
 825             $template->param(
 826                 searchdesc => 1,
 827                 query_desc => $query_desc,
 828                 limit_desc => $limit_desc,
 829                 query_cgi  => $query_cgi,
 830                 limit_cgi  => $limit_cgi
 831             );
 832         }
 833     } # end of the if local
 834     # asynchronously search the authority server
 835     elsif ($server && $server =~/authorityserver/) { # this is the local authority server
 836         my @inner_sup_results_array;
 837         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
 838             my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
 839             my $title_field = $marc_record_object->field(100);
 840             push @inner_sup_results_array, {
 841                 'title' => $title_field->subfield('a'),
 842                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
 843             };
 844         }
 845         my $servername = $server;
 846         push @sup_results_array, {  servername => $servername,
 847                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
 848     }
 849     # FIXME: can add support for other targets as needed here
 850     $template->param(           outer_sup_results_loop => \@sup_results_array);
 851 } #/end of the for loop
 852 #$template->param(FEDERATED_RESULTS => \@results_array);
 853
 854 my @input_values = map { Encode::decode_utf8($_->{input_value}) } @limit_inputs;
 855 for my $facet ( @$facets ) {
 856     for my $entry ( @{ $facet->{facets} } ) {
 857         my $index = $entry->{type_link_value};
 858         my $value = $entry->{facet_link_value};
 859         $entry->{active} = grep { $_ eq qq{$index:$value} } @input_values;
 860     }
 861 }
 862
 863
 864 $template->param(
 865             #classlist => $classlist,
 866             total => $total,
 867             opacfacets => 1,
 868             facets_loop => $facets,
 869             displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
 870             scan => $scan,
 871             search_error => $error,
 872 );
 873
 874 if ($query_desc || $limit_desc) {
 875     $template->param(searchdesc => 1);
 876 }
 877
 878 # VI. BUILD THE TEMPLATE
 879 # Build drop-down list for 'Add To:' menu...
 880 my ($totalref, $pubshelves, $barshelves)=
 881         C4::VirtualShelves::GetSomeShelfNames($borrowernumber,'COMBO',1);
 882 $template->param(
 883         addbarshelves     => $totalref->{bartotal},
 884         addbarshelvesloop => $barshelves,
 885         addpubshelves     => $totalref->{pubtotal},
 886         addpubshelvesloop => $pubshelves,
 887         );
 888
 889 my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
 890
 891 # If GoogleIndicTransliteration system preference is On Set paramter to load Google's javascript in OPAC search screens
 892 if (C4::Context->preference('GoogleIndicTransliteration')) {
 893         $template->param('GoogleIndicTransliteration' => 1);
 894 }
 895
 896 $template->{VARS}->{DidYouMean} =
 897   ( defined C4::Context->preference('OPACdidyoumean')
 898       && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
 899 $template->{VARS}->{IDreamBooksReviews} = C4::Context->preference('IDreamBooksReviews');
 900 $template->{VARS}->{IDreamBooksReadometer} = C4::Context->preference('IDreamBooksReadometer');
 901 $template->{VARS}->{IDreamBooksResults} = C4::Context->preference('IDreamBooksResults');
 902
 903 if ($offset == 0 && IsOverDriveEnabled()) {
 904     $template->param(OverDriveEnabled => 1);
 905     $template->param(OverDriveLibraryID => C4::Context->preference('OverDriveLibraryID'));
 906 }
 907
 908     $template->param( borrowernumber    => $borrowernumber);
 909 output_with_http_headers $cgi, $cookie, $template->output, $content_type;