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