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