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