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 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 $tag = $params->{tag} if $params->{tag};
 349
 350
 351 # String with params with the search criteria for the paging in opac-detail
 352 # param value is URI encoded and params separator is HTML encode (&amp;)
 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 .= $_ . '=' . uri_escape($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 @limits = map { uri_unescape($_) } @limits;
 424 my @nolimits = $cgi->param('nolimit');
 425 @nolimits = map { uri_unescape($_) } @nolimits;
 426 my %is_nolimit = map { $_ => 1 } @nolimits;
 427 @limits = grep { not $is_nolimit{$_} } @limits;
 428
 429 if($params->{'multibranchlimit'}) {
 430     my $multibranch = '('.join( " or ", map { "branch: $_ " } @{ GetBranchesInCategory( $params->{'multibranchlimit'} ) } ).')';
 431     push @limits, $multibranch if ($multibranch ne  '()');
 432 }
 433
 434 my $available;
 435 foreach my $limit(@limits) {
 436     if ($limit =~/available/) {
 437         $available = 1;
 438     }
 439 }
 440 $template->param(available => $available);
 441
 442 # append year limits if they exist
 443 if ($params->{'limit-yr'}) {
 444     if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
 445         my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
 446         push @limits, "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
 447     }
 448     elsif ($params->{'limit-yr'} =~ /\d{4}/) {
 449         push @limits, "yr,st-numeric=$params->{'limit-yr'}";
 450     }
 451     else {
 452         #FIXME: Should return a error to the user, incorect date format specified
 453     }
 454 }
 455
 456 # Params that can only have one value
 457 my $scan = $params->{'scan'};
 458 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
 459 my $countRSS         = C4::Context->preference('numSearchRSSResults') || 50;
 460 my $results_per_page = $params->{'count'} || $count;
 461 my $offset = $params->{'offset'} || 0;
 462 my $page = $cgi->param('page') || 1;
 463 $offset = ($page-1)*$results_per_page if $page>1;
 464 my $hits;
 465 my $expanded_facet = $params->{'expand'};
 466
 467 # Define some global variables
 468 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
 469
 470 my @results;
 471
 472 ## I. BUILD THE QUERY
 473 ( $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);
 474
 475 sub _input_cgi_parse {
 476     my @elements;
 477     for my $this_cgi ( split('&',shift) ) {
 478         next unless $this_cgi;
 479         $this_cgi =~ /(.*?)=(.*)/;
 480         push @elements, { input_name => $1, input_value => uri_unescape($2) };
 481     }
 482     return @elements;
 483 }
 484
 485 ## parse the query_cgi string and put it into a form suitable for <input>s
 486 my @query_inputs = _input_cgi_parse($query_cgi);
 487 $template->param ( QUERY_INPUTS => \@query_inputs );
 488
 489 ## parse the limit_cgi string and put it into a form suitable for <input>s
 490 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
 491
 492 # add OPAC 'hidelostitems'
 493 #if (C4::Context->preference('hidelostitems') == 1) {
 494 #    # either lost ge 0 or no value in the lost register
 495 #    $query ="($query) and ( (lost,st-numeric <= 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='') )";
 496 #}
 497 #
 498 # add OPAC suppression - requires at least one item indexed with Suppress
 499 if (C4::Context->preference('OpacSuppression')) {
 500     # OPAC suppression by IP address
 501     if (C4::Context->preference('OpacSuppressionByIPRange')) {
 502         my $IPAddress = $ENV{'REMOTE_ADDR'};
 503         my $IPRange = C4::Context->preference('OpacSuppressionByIPRange');
 504         if ($IPAddress !~ /^$IPRange/)  {
 505             if ( $query_type eq 'pqf' ) {
 506                 $query = '@not '.$query.' @attr 1=9011 1';
 507             } else {
 508                 $query = "($query) not Suppress=1";
 509             }
 510         }
 511     }
 512     else {
 513         if ( $query_type eq 'pqf' ) {
 514             #$query = "($query) && -(suppress:1)"; #QP syntax
 515             $query = '@not '.$query.' @attr 1=9011 1'; #PQF syntax
 516         } else {
 517             $query = "($query) not Suppress=1";
 518         }
 519     }
 520 }
 521
 522 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 523 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
 524
 525 ## II. DO THE SEARCH AND GET THE RESULTS
 526 my $total = 0; # the total results for the whole set
 527 my $facets; # this object stores the faceted results that display on the left-hand of the results page
 528 my @results_array;
 529 my $results_hashref;
 530 my @coins;
 531
 532 if ($tag) {
 533     $query_cgi = "tag=" .$tag . "&" . $query_cgi;
 534     my $taglist = get_tags({term=>$tag, approved=>1});
 535     $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
 536     my @biblist  = (map {GetBiblioData($_->{biblionumber})} @$taglist);
 537     my @marclist = (map { (C4::Context->config('zebra_bib_index_mode') eq 'dom')? $_->{marcxml}: $_->{marc}; } @biblist);
 538     $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
 539     $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
 540     # FIXME: tag search and standard search should work together, not exclusively
 541     # FIXME: No facets for tags search.
 542 } elsif ($build_grouped_results) {
 543     eval {
 544         ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
 545     };
 546 } else {
 547     $pasarParams .= '&amp;query=' . uri_escape($query);
 548     $pasarParams .= '&amp;count=' . uri_escape($results_per_page);
 549     $pasarParams .= '&amp;simple_query=' . uri_escape($simple_query);
 550     $pasarParams .= '&amp;query_type=' . uri_escape($query_type) if ($query_type);
 551     eval {
 552         ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$itemtypes,$query_type,$scan,1);
 553     };
 554 }
 555 # This sorts the facets into alphabetical order
 556 if ($facets) {
 557     foreach my $f (@$facets) {
 558         $f->{facets} = [ sort { uc($a->{facet_title_value}) cmp uc($b->{facet_title_value}) } @{ $f->{facets} } ];
 559     }
 560     @$facets = sort {$a->{expand} cmp $b->{expand}} @$facets;
 561 }
 562
 563 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
 564 if ($@ || $error) {
 565     $template->param(query_error => $error.$@);
 566     output_html_with_http_headers $cgi, $cookie, $template->output;
 567     exit;
 568 }
 569
 570 # At this point, each server has given us a result set
 571 # now we build that set for template display
 572 my @sup_results_array;
 573 for (my $i=0;$i<@servers;$i++) {
 574     my $server = $servers[$i];
 575     if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
 576         $hits = $results_hashref->{$server}->{"hits"};
 577         my $page = $cgi->param('page') || 0;
 578         my @newresults;
 579         if ($build_grouped_results) {
 580             foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
 581                 # because pazGetRecords handles retieving only the records
 582                 # we want as specified by $offset and $results_per_page,
 583                 # we need to set the offset parameter of searchResults to 0
 584                 my @group_results = searchResults( 'opac', $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
 585                                                    $group->{"RECORDS"});
 586                 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
 587             }
 588         } else {
 589             @newresults = searchResults('opac', $query_desc, $hits, $results_per_page, $offset, $scan,
 590                                         $results_hashref->{$server}->{"RECORDS"});
 591         }
 592         $hits = 0 unless @newresults;
 593
 594         foreach my $res (@newresults) {
 595
 596             # must define a value for size if not present in DB
 597             # in order to avoid problems generated by the default size value in TT
 598             if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
 599             # while we're checking each line, see if item is in the cart
 600             if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
 601                 $res->{'incart'} = 1;
 602             }
 603
 604             if (C4::Context->preference('COinSinOPACResults')) {
 605                 my $record = GetMarcBiblio($res->{'biblionumber'});
 606                 $res->{coins} = GetCOinSBiblio($record);
 607             }
 608             if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
 609                 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
 610                     $isbn = $isbn->as_isbn13->as_string;
 611                     $isbn =~ s/-//g;
 612                     my $social_datas = C4::SocialData::get_data( $isbn );
 613                     if ( $social_datas ) {
 614                         for my $key ( keys %$social_datas ) {
 615                             $res->{$key} = $$social_datas{$key};
 616                             if ( $key eq 'score_avg' ){
 617                                 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
 618                             }
 619                         }
 620                     }
 621                 }
 622             }
 623
 624             if (C4::Context->preference('TagsEnabled') and
 625                 C4::Context->preference('TagsShowOnList')) {
 626                 if ( my $bibnum = $res->{biblionumber} ) {
 627                     $res->{itemsissued} = CountItemsIssued( $bibnum );
 628                     $res->{'TagLoop'} = get_tags({
 629                         biblionumber => $bibnum,
 630                         approved => 1,
 631                         sort => '-weight',
 632                         limit => C4::Context->preference('TagsShowOnList')
 633                     });
 634                 }
 635             }
 636
 637             if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
 638                 my $rating = GetRating( $res->{'biblionumber'}, $borrowernumber );
 639                 $res->{'rating_value'}  = $rating->{'rating_value'};
 640                 $res->{'rating_total'}  = $rating->{'rating_total'};
 641                 $res->{'rating_avg'}    = $rating->{'rating_avg'};
 642                 $res->{'rating_avg_int'} = $rating->{'rating_avg_int'};
 643             }
 644         }
 645
 646         if ($results_hashref->{$server}->{"hits"}){
 647             $total = $total + $hits;
 648         }
 649
 650         # Opac search history
 651         if (C4::Context->preference('EnableOpacSearchHistory')) {
 652             unless ( $offset ) {
 653                 my $path_info = $cgi->url(-path_info=>1);
 654                 my $query_cgi_history = $cgi->url(-query=>1);
 655                 $query_cgi_history =~ s/^$path_info\?//;
 656                 $query_cgi_history =~ s/;/&/g;
 657                 my $query_desc_history = join ", ", grep { defined $_ } $query_desc, $limit_desc;
 658
 659                 unless ( $borrowernumber ) {
 660                     my $new_searches = C4::Search::History::add_to_session({
 661                             cgi => $cgi,
 662                             query_desc => $query_desc_history,
 663                             query_cgi => $query_cgi_history,
 664                             total => $total,
 665                             type => "biblio",
 666                     });
 667                 } else {
 668                     # To the session (the user is logged in)
 669                     C4::Search::History::add({
 670                         userid => $borrowernumber,
 671                         sessionid => $cgi->cookie("CGISESSID"),
 672                         query_desc => $query_desc_history,
 673                         query_cgi => $query_cgi_history,
 674                         total => $total,
 675                         type => "biblio",
 676                     });
 677                 }
 678             }
 679             $template->param( EnableOpacSearchHistory => 1 );
 680         }
 681
 682         ## If there's just one result, redirect to the detail page
 683         if ($total == 1 && $format ne 'rss2'
 684         && $format ne 'opensearchdescription' && $format ne 'atom') {
 685             my $biblionumber=$newresults[0]->{biblionumber};
 686             if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
 687                 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
 688             } elsif  (C4::Context->preference('BiblioDefaultView') eq 'marc') {
 689                 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
 690             } else {
 691                 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
 692             }
 693             exit;
 694         }
 695         if ($hits) {
 696             if ( !$build_grouped_results ) {
 697                 # We build the encrypted list of first OPACnumSearchResults biblios to pass with the search criteria for paging on opac-detail
 698                 $pasarParams .= '&amp;listBiblios=';
 699                 my $j = 0;
 700                 foreach (@newresults) {
 701                     my $bibnum = ($_->{biblionumber})?$_->{biblionumber}:0;
 702                     $pasarParams .= uri_escape($bibnum) . ',';
 703                     $j++;
 704                     last if ($j == $results_per_page);
 705                 }
 706                 chop $pasarParams if ($pasarParams =~ /,$/);
 707                 $pasarParams .= '&amp;total=' . uri_escape( int($total) ) if ($pasarParams !~ /total=(?:[0-9]+)?/);
 708                 if ($pasarParams) {
 709                     my $session = get_session($cgi->cookie("CGISESSID"));
 710                     $session->param('busc' => $pasarParams);
 711                 }
 712                 #
 713             }
 714             $template->param(total => $hits);
 715             my $limit_cgi_not_availablity = $limit_cgi;
 716             $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
 717             $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
 718             $template->param(limit_cgi => $limit_cgi);
 719             $template->param(countrss  => $countRSS );
 720             $template->param(query_cgi => $query_cgi);
 721             $template->param(query_desc => $query_desc);
 722             $template->param(limit_desc => $limit_desc);
 723             $template->param(offset     => $offset);
 724             $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
 725             if ($query_desc || $limit_desc) {
 726                 $template->param(searchdesc => 1);
 727             }
 728             $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
 729             $template->param(results_per_page =>  $results_per_page);
 730             my $hide = C4::Context->preference('OpacHiddenItems');
 731             $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
 732             my $branch = '';
 733             if (C4::Context->userenv){
 734                 $branch = C4::Context->userenv->{branch};
 735             }
 736             if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
 737                 if (
 738                     ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
 739                     ||
 740                     C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
 741                 ) {
 742                     my $branchname;
 743                     if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
 744                         $branchname = $branches->{$branch}->{'branchname'};
 745                     }
 746                     elsif (  C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
 747                         $branchname = $branches->{ $ENV{'BRANCHCODE'} }->{'branchname'};
 748                     }
 749
 750                     foreach my $res ( @newresults ) {
 751                         my @new_loop;
 752                         my @top_loop;
 753                         my @old_loop = @{$res->{'available_items_loop'}};
 754                         foreach my $item ( @old_loop ) {
 755                             if ( $item->{'branchname'} eq $branchname ) {
 756                                 $item->{'this_branch'} = 1;
 757                                 push( @top_loop, $item );
 758                             } else {
 759                                 push( @new_loop, $item );
 760                             }
 761                         }
 762                         my @complete_loop = ( @top_loop, @new_loop );
 763                         $res->{'available_items_loop'} = \@complete_loop;
 764                     }
 765                 }
 766             }
 767
 768             $template->param(
 769                 SEARCH_RESULTS => \@newresults,
 770                 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
 771                 suppress_result_number => $hide,
 772                             );
 773             if (C4::Context->preference("OPACLocalCoverImages")){
 774                 $template->param(OPACLocalCoverImages => 1);
 775                 $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
 776             }
 777             ## Build the page numbers on the bottom of the page
 778             my @page_numbers;
 779             # total number of pages there will be
 780             my $pages = ceil($hits / $results_per_page);
 781             # default page number
 782             my $current_page_number = 1;
 783             if ($offset) {
 784                 $current_page_number = ( $offset / $results_per_page + 1 );
 785             }
 786             my $previous_page_offset;
 787             if ( $offset >= $results_per_page ) {
 788                 $previous_page_offset = $offset - $results_per_page;
 789             }
 790             my $next_page_offset = $offset + $results_per_page;
 791             # If we're within the first 10 pages, keep it simple
 792             #warn "current page:".$current_page_number;
 793             if ($current_page_number < 10) {
 794                 # just show the first 10 pages
 795                 # Loop through the pages
 796                 my $pages_to_show = 10;
 797                 $pages_to_show = $pages if $pages<10;
 798                 for ($i=1; $i<=$pages_to_show;$i++) {
 799                     # the offset for this page
 800                     my $this_offset = (($i*$results_per_page)-$results_per_page);
 801                     # the page number for this page
 802                     my $this_page_number = $i;
 803                     # put it in the array
 804                     push @page_numbers,
 805                       { offset    => $this_offset,
 806                         pg        => $this_page_number,
 807                         highlight => $this_page_number == $current_page_number,
 808                         sort_by   => join ' ', @sort_by
 809                       };
 810
 811                 }
 812
 813             }
 814             # now, show twenty pages, with the current one smack in the middle
 815             else {
 816                 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
 817                     my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
 818                     my $this_page_number = $i-9;
 819                     if ( $this_page_number <= $pages ) {
 820                         push @page_numbers,
 821                           { offset    => $this_offset,
 822                             pg        => $this_page_number,
 823                             highlight => $this_page_number == $current_page_number,
 824                             sort_by => join ' ', @sort_by
 825                           };
 826                     }
 827                 }
 828
 829             }
 830             $template->param(   PAGE_NUMBERS => \@page_numbers,
 831                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
 832             $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
 833         }
 834         # no hits
 835         else {
 836             my $nohits = C4::Context->preference('OPACNoResultsFound');
 837             if ($nohits and $nohits=~/{QUERY_KW}/){
 838                 # extracting keywords in case of relaunching search
 839                 (my $query_kw=$query_desc)=~s/ and|or / /g;
 840                 $query_kw = Encode::decode_utf8($query_kw);
 841                 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^,:]|$)/g);
 842                 $query_kw=join('+',@query_kw);
 843                 $nohits=~s/{QUERY_KW}/$query_kw/g;
 844                 $template->param('OPACNoResultsFound' =>$nohits);
 845             }
 846             $template->param(
 847                 searchdesc => 1,
 848                 query_desc => $query_desc,
 849                 limit_desc => $limit_desc,
 850                 query_cgi  => $query_cgi,
 851                 limit_cgi  => $limit_cgi
 852             );
 853         }
 854     } # end of the if local
 855     # asynchronously search the authority server
 856     elsif ($server && $server =~/authorityserver/) { # this is the local authority server
 857         my @inner_sup_results_array;
 858         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
 859             my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
 860             my $title_field = $marc_record_object->field(100);
 861             push @inner_sup_results_array, {
 862                 'title' => $title_field->subfield('a'),
 863                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
 864             };
 865         }
 866         my $servername = $server;
 867         push @sup_results_array, {  servername => $servername,
 868                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
 869     }
 870     # FIXME: can add support for other targets as needed here
 871     $template->param(           outer_sup_results_loop => \@sup_results_array);
 872 } #/end of the for loop
 873 #$template->param(FEDERATED_RESULTS => \@results_array);
 874
 875 my @input_values = map { Encode::decode_utf8($_->{input_value}) } @limit_inputs;
 876 for my $facet ( @$facets ) {
 877     for my $entry ( @{ $facet->{facets} } ) {
 878         my $index = $entry->{type_link_value};
 879         my $value = $entry->{facet_link_value};
 880         $entry->{active} = grep { $_ eq qq{$index:$value} } @input_values;
 881     }
 882 }
 883
 884
 885 $template->param(
 886             #classlist => $classlist,
 887             total => $total,
 888             opacfacets => 1,
 889             facets_loop => $facets,
 890             displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
 891             scan => $scan,
 892             search_error => $error,
 893 );
 894
 895 if ($query_desc || $limit_desc) {
 896     $template->param(searchdesc => 1);
 897 }
 898
 899 # VI. BUILD THE TEMPLATE
 900 # Build drop-down list for 'Add To:' menu...
 901 my ($totalref, $pubshelves, $barshelves)=
 902         C4::VirtualShelves::GetSomeShelfNames($borrowernumber,'COMBO',1);
 903 $template->param(
 904         addbarshelves     => $totalref->{bartotal},
 905         addbarshelvesloop => $barshelves,
 906         addpubshelves     => $totalref->{pubtotal},
 907         addpubshelvesloop => $pubshelves,
 908         );
 909
 910 my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
 911
 912 # If GoogleIndicTransliteration system preference is On Set paramter to load Google's javascript in OPAC search screens
 913 if (C4::Context->preference('GoogleIndicTransliteration')) {
 914         $template->param('GoogleIndicTransliteration' => 1);
 915 }
 916
 917 $template->{VARS}->{DidYouMean} =
 918   ( defined C4::Context->preference('OPACdidyoumean')
 919       && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
 920 $template->{VARS}->{IDreamBooksReviews} = C4::Context->preference('IDreamBooksReviews');
 921 $template->{VARS}->{IDreamBooksReadometer} = C4::Context->preference('IDreamBooksReadometer');
 922 $template->{VARS}->{IDreamBooksResults} = C4::Context->preference('IDreamBooksResults');
 923
 924 if ($offset == 0 && IsOverDriveEnabled()) {
 925     $template->param(OverDriveEnabled => 1);
 926     $template->param(OverDriveLibraryID => C4::Context->preference('OverDriveLibraryID'));
 927 }
 928
 929     $template->param( borrowernumber    => $borrowernumber);
 930 output_with_http_headers $cgi, $cookie, $template->output, $content_type;