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