opac/opac-search.pl

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