opac/opac-search.pl

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