opac/opac-search.pl

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