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