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