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 my $default_sort_by = C4::Context->default_catalog_sort_by;
 308
 309 # The following should only be loaded if we're bringing up the advanced search template
 310 if ( $template_type && $template_type eq 'advsearch' ) {
 311     # load the servers (used for searching -- to do federated searching, etc.)
 312     my $primary_servers_loop;# = displayPrimaryServers();
 313     $template->param(outer_servers_loop =>  $primary_servers_loop,);
 314
 315     my $secondary_servers_loop;
 316     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 317
 318     # set the default sorting
 319     if ($default_sort_by) {
 320         $template->param( sort_by => $default_sort_by );
 321     }
 322
 323     my @advsearch_limits = split /,/, C4::Context->preference('OpacAdvSearchOptions');
 324     my @advsearch_more_limits = split /,/,
 325       C4::Context->preference('OpacAdvSearchMoreOptions');
 326     $template->param(
 327         uc( C4::Context->preference("marcflavour") ) => 1,    # we already did this for UNIMARC
 328         advsearch         => 1,
 329         OpacAdvSearchOptions     => \@advsearch_limits,
 330         OpacAdvSearchMoreOptions => \@advsearch_more_limits,
 331     );
 332
 333     # use the global setting by default
 334     if ( C4::Context->preference("expandedSearchOption") == 1 ) {
 335         $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
 336     }
 337     # but let the user override it
 338     if (defined $cgi->param('expanded_options')) {
 339         if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
 340             $template->param( expanded_options => scalar $cgi->param('expanded_options'));
 341         }
 342     }
 343
 344
 345     output_html_with_http_headers $cgi, $cookie, $template->output;
 346     exit;
 347 }
 348
 349 ### OK, if we're this far, we're performing an actual search
 350
 351 # Fetch the paramater list as a hash in scalar context:
 352 #  * returns paramater list as tied hash ref
 353 #  * we can edit the values by changing the key
 354 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 355 my $params = $cgi->Vars;
 356 my $tag;
 357 if ( $params->{tag} ) {
 358     $tag = $params->{tag};
 359     $template->param( tag => $tag );
 360 }
 361
 362 # String with params with the search criteria for the paging in opac-detail
 363 # param value is URI encoded and params separator is HTML encode (&amp;)
 364 my $pasarParams = '';
 365 my $j = 0;
 366 for (keys %$params) {
 367     my @pasarParam = $cgi->multi_param($_);
 368     for my $paramValue(@pasarParam) {
 369         $pasarParams .= '&amp;' if ($j > 0);
 370         $pasarParams .= uri_escape_utf8($_) . '=' . uri_escape_utf8($paramValue);
 371         $j++;
 372     }
 373 }
 374
 375 # Params that can have more than one value
 376 # sort by is used to sort the query
 377 # in theory can have more than one but generally there's just one
 378 my @sort_by;
 379 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/;
 380 @sort_by = $cgi->multi_param('sort_by');
 381 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
 382 foreach my $sort (@sort_by) {
 383     if ( grep { $_ eq $sort } @allowed_sortby ) {
 384         $template->param($sort => 1);
 385     }
 386 }
 387 $template->param('sort_by' => $sort_by[0]);
 388
 389 # Use the servers defined, or just search our local catalog(default)
 390 my @servers = $cgi->multi_param('server');
 391 unless (@servers) {
 392     #FIXME: this should be handled using Context.pm
 393     @servers = ("biblioserver");
 394     # @servers = C4::Context->config("biblioserver");
 395 }
 396
 397 # operators include boolean and proximity operators and are used
 398 # to evaluate multiple operands
 399 my @operators = $cgi->multi_param('op');
 400 @operators = map { uri_unescape($_) } @operators;
 401
 402 # indexes are query qualifiers, like 'title', 'author', etc. They
 403 # can be single or multiple parameters separated by comma: kw,right-Truncation
 404 my @indexes = $cgi->multi_param('idx');
 405 @indexes = map { uri_unescape($_) } @indexes;
 406
 407 # if a simple index (only one)  display the index used in the top search box
 408 if ($indexes[0] && !$indexes[1]) {
 409     my $idx = "ms_".$indexes[0];
 410     $idx =~ s/\,/comma/g;  # template toolkit doesn't like variables with a , in it
 411     $idx =~ s/-/dash/g;  # template toolkit doesn't like variables with a dash in it
 412     $template->param($idx => 1);
 413 }
 414 # an operand can be a single term, a phrase, or a complete ccl query
 415 my @operands = $cgi->multi_param('q');
 416 @operands = map { uri_unescape($_) } @operands;
 417
 418 $template->{VARS}->{querystring} = join(' ', @operands);
 419
 420 # if a simple search, display the value in the search box
 421 my $basic_search = 0;
 422 if ($operands[0] && !$operands[1]) {
 423     my $ms_query = $operands[0];
 424     $ms_query =~ s/ #\S+//;
 425     $template->param(ms_value => $ms_query);
 426     $basic_search=1;
 427 }
 428
 429 # limits are use to limit to results to a pre-defined category such as branch or language
 430 my @limits = $cgi->multi_param('limit');
 431 @limits = map { uri_unescape($_) } @limits;
 432 my @nolimits = $cgi->multi_param('nolimit');
 433 @nolimits = map { uri_unescape($_) } @nolimits;
 434 my %is_nolimit = map { $_ => 1 } @nolimits;
 435 @limits = grep { not $is_nolimit{$_} } @limits;
 436
 437 if (@searchCategories > 0) {
 438     my @tabcat;
 439     foreach my $typecategory (@searchCategories) {
 440         push @tabcat, Koha::ItemTypes->search({ searchcategory => $typecategory })->get_column('itemtype');
 441     }
 442
 443     foreach my $itemtypeInCategory (@tabcat) {
 444         push (@limits, "mc-$itype_or_itemtype,phr:".$itemtypeInCategory);
 445     }
 446 }
 447
 448 @limits = map { uri_unescape($_) } @limits;
 449
 450
 451 my $available;
 452 foreach my $limit(@limits) {
 453     if ($limit =~/available/) {
 454         $available = 1;
 455     }
 456 }
 457 $template->param(available => $available);
 458
 459 # append year limits if they exist
 460 if ($params->{'limit-yr'}) {
 461     if ($params->{'limit-yr'} =~ /\d{4}/) {
 462         push @limits, "yr,st-numeric=$params->{'limit-yr'}";
 463     }
 464     else {
 465         #FIXME: Should return a error to the user, incorect date format specified
 466     }
 467 }
 468
 469 # Params that can only have one value
 470 my $scan = $params->{'scan'};
 471 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
 472 my $countRSS         = C4::Context->preference('numSearchRSSResults') || 50;
 473 my $results_per_page = $params->{'count'} || $count;
 474 my $offset = $params->{'offset'} || 0;
 475 $offset = 0 if $offset < 0;
 476 my $page = $cgi->param('page') || 1;
 477 $offset = ($page-1)*$results_per_page if $page>1;
 478 my $hits;
 479 my $weight_search = $cgi->param('advsearch') ? $cgi->param('weight_search') || 0 : 1;
 480
 481 # Define some global variables
 482 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
 483
 484 my $suppress = 0;
 485 if (C4::Context->preference('OpacSuppression')) {
 486     # OPAC suppression by IP address
 487     if (C4::Context->preference('OpacSuppressionByIPRange')) {
 488         my $IPAddress = $ENV{'REMOTE_ADDR'};
 489         my $IPRange = C4::Context->preference('OpacSuppressionByIPRange');
 490         $suppress = ($IPAddress !~ /^$IPRange/);
 491     }
 492     else {
 493         $suppress = 1;
 494     }
 495 }
 496
 497 ## I. BUILD THE QUERY
 498 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type)
 499   = $builder->build_query_compat(
 500     \@operators,
 501     \@operands,
 502     \@indexes,
 503     \@limits,
 504     \@sort_by,
 505     0,
 506     $lang,
 507     {
 508         suppress => $suppress,
 509         is_opac => 1,
 510         weighted_fields => $weight_search
 511     }
 512 );
 513
 514 $template->param( search_query => $query ) if C4::Context->preference('DumpSearchQueryTemplate');
 515
 516 sub _input_cgi_parse {
 517     my @elements;
 518     my $query_cgi = shift or return @elements;
 519     for my $this_cgi ( split('&',$query_cgi) ) {
 520         next unless $this_cgi;
 521         $this_cgi =~ /(.*?)=(.*)/;
 522         push @elements, { input_name => $1, input_value => Encode::decode_utf8( uri_unescape($2) ) };
 523     }
 524     return @elements;
 525 }
 526
 527 ## parse the query_cgi string and put it into a form suitable for <input>s
 528 my @query_inputs = _input_cgi_parse($query_cgi);
 529 $template->param ( QUERY_INPUTS => \@query_inputs );
 530
 531 ## parse the limit_cgi string and put it into a form suitable for <input>s
 532 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
 533
 534 # OpenURL
 535 my @OpenURL_itypes;
 536 if (C4::Context->preference('OPACShowOpenURL')) {
 537     @OpenURL_itypes = split( /\s/, C4::Context->preference('OPACOpenURLItemTypes') );
 538     $template->param(
 539         OPACShowOpenURL => 1,
 540         OpenURLResolverURL => C4::Context->preference('OpenURLResolverURL'),
 541         OpenURLText => C4::Context->preference('OpenURLText'),
 542         OpenURLImageLocation => C4::Context->preference('OpenURLImageLocation')
 543     );
 544 }
 545
 546 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 547 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
 548
 549 ## II. DO THE SEARCH AND GET THE RESULTS
 550 my $total = 0; # the total results for the whole set
 551 my $facets; # this object stores the faceted results that display on the left-hand of the results page
 552 my $results_hashref;
 553
 554 if ($tag) {
 555     $query_cgi = "tag=" .  uri_escape_utf8( $tag ) . "&" . $query_cgi;
 556     my $taglist = get_tags({term=>$tag, approved=>1});
 557     $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
 558     my @marclist = map { C4::Biblio::GetXmlBiblio( $_->{biblionumber} ) } @$taglist;
 559     $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
 560     # FIXME: tag search and standard search should work together, not exclusively
 561     # FIXME: Because search and standard search don't work together OpacHiddenItems
 562     #        displays search results which should be hidden.
 563     # FIXME: No facets for tags search.
 564 } else {
 565     my $json = JSON->new->utf8->allow_nonref(1);
 566     $pasarParams .= '&amp;query=' . uri_escape_utf8($json->encode($query));
 567     $pasarParams .= '&amp;count=' . uri_escape_utf8($results_per_page);
 568     $pasarParams .= '&amp;simple_query=' . uri_escape_utf8($simple_query);
 569     $pasarParams .= '&amp;query_type=' . uri_escape_utf8($query_type) if ($query_type);
 570     my $itemtypes_nocategory = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
 571     eval {
 572         ($error, $results_hashref, $facets) = $searcher->search_compat($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,undef,$itemtypes_nocategory,$query_type,$scan,1);
 573 };
 574 }
 575
 576 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
 577 if (not $tag and ( $@ || $error)) {
 578     my $query_error = q{};
 579     $query_error .= $error if $error;
 580     $query_error .= $@ if $@;
 581     $template->param(query_error => $query_error);
 582     output_html_with_http_headers $cgi, $cookie, $template->output;
 583     exit;
 584 }
 585
 586 # At this point, each server has given us a result set
 587 # now we build that set for template display
 588 my @sup_results_array;
 589 my $search_context = {};
 590 $search_context->{'interface'} = 'opac';
 591 if (C4::Context->preference('OpacHiddenItemsExceptions')){
 592     $search_context->{patron} = $patron;
 593 }
 594
 595 my $variables = { anonymous_session => ($borrowernumber) ? 0 : 1 };
 596
 597 my @plugin_responses = Koha::Plugins->call(
 598     'opac_results_xslt_variables',
 599     {
 600         lang       => $lang,
 601         patron_id  => $borrowernumber
 602     }
 603 );
 604 for my $plugin_variables ( @plugin_responses ) {
 605     $variables = { %$variables, %$plugin_variables };
 606 }
 607
 608 for (my $i=0;$i<@servers;$i++) {
 609     my $server = $servers[$i];
 610     if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
 611         $hits = $results_hashref->{$server}->{"hits"};
 612         if ( $hits == 0 && $basic_search ){
 613             $operands[0] = '"'.$operands[0].'"'; #quote it
 614             ## I. BUILD THE QUERY
 615             ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type)
 616               = $builder->build_query_compat(
 617                 \@operators,
 618                 \@operands,
 619                 \@indexes,
 620                 \@limits,
 621                 \@sort_by,
 622                 0,
 623                 $lang,
 624                 {
 625                     suppress => $suppress,
 626                     is_opac => 1,
 627                     weighted_fields => $weight_search
 628                 }
 629             );
 630             my $quoted_results_hashref;
 631             my $itemtypes_nocategory = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
 632             eval {
 633                 ($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);
 634             };
 635             my $quoted_hits = $quoted_results_hashref->{$server}->{"hits"} // 0;
 636             if ( $quoted_hits ){
 637                 $results_hashref->{'biblioserver'} = $quoted_results_hashref->{'biblioserver'};
 638                 $hits = $quoted_hits;
 639             }
 640         }
 641         my $page = $cgi->param('page') || 0;
 642         my @newresults = searchResults( $search_context, $query_desc, $hits, $results_per_page, $offset, $scan,
 643                                         $results_hashref->{$server}->{"RECORDS"}, $variables);
 644         $hits = 0 unless @newresults;
 645
 646         my $art_req_itypes;
 647         if( C4::Context->preference('ArticleRequests') ) {
 648             $art_req_itypes = Koha::CirculationRules->guess_article_requestable_itemtypes({ $patron ? ( categorycode => $patron->categorycode ) : () });
 649         }
 650
 651         foreach my $res (@newresults) {
 652
 653             # must define a value for size if not present in DB
 654             # in order to avoid problems generated by the default size value in TT
 655             if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
 656             # while we're checking each line, see if item is in the cart
 657             if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
 658                 $res->{'incart'} = 1;
 659             }
 660
 661             if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
 662                 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
 663                     $isbn = $isbn->as_isbn13->as_string;
 664                     $isbn =~ s/-//g;
 665                     my $social_datas = C4::SocialData::get_data( $isbn );
 666                     if ( $social_datas ) {
 667                         for my $key ( keys %$social_datas ) {
 668                             $res->{$key} = $$social_datas{$key};
 669                             if ( $key eq 'score_avg' ){
 670                                 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
 671                             }
 672                         }
 673                     }
 674                 }
 675             }
 676
 677             if (C4::Context->preference('TagsEnabled') and
 678                 C4::Context->preference('TagsShowOnList')) {
 679                 if ( my $bibnum = $res->{biblionumber} ) {
 680                     $res->{itemsissued} = CountItemsIssued( $bibnum );
 681                     $res->{'TagLoop'} = get_tags({
 682                         biblionumber => $bibnum,
 683                         approved => 1,
 684                         sort => '-weight',
 685                         limit => C4::Context->preference('TagsShowOnList')
 686                     });
 687                 }
 688             }
 689
 690             $res->{shelves} = Koha::Virtualshelves->get_shelves_containing_record(
 691                 {
 692                     biblionumber   => $res->{biblionumber},
 693                     borrowernumber => $borrowernumber
 694                 }
 695             );
 696
 697             if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
 698                 my $ratings = Koha::Ratings->search({ biblionumber => $res->{biblionumber} });
 699                 $res->{ratings} = $ratings;
 700                 $res->{my_rating} = $borrowernumber ? $ratings->search({ borrowernumber => $borrowernumber })->next : undef;
 701             }
 702
 703             # BZ17530: 'Intelligent' guess if result can be article requested
 704             $res->{artreqpossible} = ( $art_req_itypes->{ $res->{itemtype} // q{} } || $art_req_itypes->{ '*' } ) ? 1 : q{};
 705         }
 706
 707         if ($results_hashref->{$server}->{"hits"}){
 708             $total = $total + $hits;
 709         }
 710
 711         # Opac search history
 712         if (C4::Context->preference('EnableOpacSearchHistory')) {
 713             unless ( $offset ) {
 714                 my $path_info = $cgi->url(-path_info=>1);
 715                 my $query_cgi_history = $cgi->url(-query=>1);
 716                 $query_cgi_history =~ s/^$path_info\?//;
 717                 $query_cgi_history =~ s/;/&/g;
 718                 my $query_desc_history = join ", ", grep { defined $_ } $query_desc, $limit_desc;
 719
 720                 if ( $borrowernumber and $cgi->cookie("CGISESSID") ) {
 721
 722                     # To the session (the user is logged in)
 723                     C4::Search::History::add(
 724                         {
 725                             userid     => $borrowernumber,
 726                             sessionid  => $cgi->cookie("CGISESSID"),
 727                             query_desc => $query_desc_history,
 728                             query_cgi  => $query_cgi_history,
 729                             total      => $total,
 730                             type       => "biblio",
 731                         }
 732                     );
 733                 } else {
 734                     my $new_searches = C4::Search::History::add_to_session(
 735                         {
 736                             cgi        => $cgi,
 737                             query_desc => $query_desc_history,
 738                             query_cgi  => $query_cgi_history,
 739                             total      => $total,
 740                             type       => "biblio",
 741                         }
 742                     );
 743                 }
 744             }
 745             $template->param( EnableOpacSearchHistory => 1 );
 746         }
 747
 748         ## If there's just one result, redirect to the detail page
 749         if ($total == 1 && $format ne 'rss'
 750         && $format ne 'opensearchdescription' && $format ne 'atom') {
 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             $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
 788             if ($query_desc || $limit_desc) {
 789                 $template->param(searchdesc => 1);
 790             }
 791             $template->param(results_per_page =>  $results_per_page);
 792             my $hide = keys %$hidingrules ? 1 : 0;
 793
 794             $template->param(
 795                 SEARCH_RESULTS => \@newresults,
 796                 suppress_result_number => $hide,
 797                             );
 798             if (C4::Context->preference("OPACLocalCoverImages")){
 799             $template->param(OPACLocalCoverImages => 1);
 800             $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
 801             }
 802             ## Build the page numbers on the bottom of the page
 803             my ( $page_numbers, $hits_to_paginate, $pages, $current_page_number, $previous_page_offset, $next_page_offset, $last_page_offset ) =
 804                 Koha::SearchEngine::Search->pagination_bar(
 805                     {
 806                         hits              => $hits,
 807                         max_result_window => $searcher->max_result_window,
 808                         results_per_page  => $results_per_page,
 809                         offset            => $offset,
 810                         sort_by           => \@sort_by
 811                     }
 812                 );
 813             $template->param(
 814                 hits_to_paginate    => $hits_to_paginate,
 815                 current_page_number => $current_page_number,
 816                 pages               => $pages
 817             );
 818             $template->param(   PAGE_NUMBERS => $page_numbers,
 819                                 last_page_offset => $last_page_offset,
 820                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
 821             $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
 822         }
 823         # no hits
 824         else {
 825             my $nohits = C4::Context->preference('OPACNoResultsFound');
 826             if ($nohits and $nohits=~/{QUERY_KW}/){
 827                 # extracting keywords in case of relaunching search
 828                 (my $query_kw=$query_desc)=~s/ and|or / /g;
 829                 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^:]|$)/g);
 830                 $query_kw=join('+',@query_kw);
 831                 $nohits=~s/{QUERY_KW}/$query_kw/g;
 832                 $template->param('OPACNoResultsFound' =>$nohits);
 833             }
 834             $template->param(
 835                 searchdesc => 1,
 836                 query_desc => $query_desc,
 837                 limit_desc => $limit_desc,
 838                 query_cgi  => $query_cgi,
 839                 limit_cgi  => $limit_cgi
 840             );
 841         }
 842     } # end of the if local
 843     # asynchronously search the authority server
 844     elsif ($server && $server =~/authorityserver/) { # this is the local authority server
 845         my @inner_sup_results_array;
 846         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
 847             my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
 848             my $title_field = $marc_record_object->field(100);
 849             push @inner_sup_results_array, {
 850                 'title' => $title_field->subfield('a'),
 851                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
 852             };
 853         }
 854         my $servername = $server;
 855         push @sup_results_array, {  servername => $servername,
 856                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
 857     }
 858     # FIXME: can add support for other targets as needed here
 859     $template->param(           outer_sup_results_loop => \@sup_results_array);
 860 } #/end of the for loop
 861
 862 for my $facet ( @$facets ) {
 863     for my $entry ( @{ $facet->{facets} } ) {
 864         my $index = $entry->{type_link_value};
 865         my $value = $entry->{facet_link_value};
 866         $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
 867     }
 868 }
 869
 870 my @search_filters = Koha::SearchFilters->search({ opac => 1 }, { order_by => "name" })->as_list;
 871 my %active_filters;
 872 foreach my $sf (@search_filters){
 873     $active_filters{$sf->id} = 1 if grep { "search_filter:".$sf->id eq $_->{input_value} } @limit_inputs;
 874 }
 875 $template->param(
 876     search_filters => \@search_filters,
 877     active_filters => \%active_filters,
 878 ) if C4::Context->preference('SavedSearchFilters');
 879
 880
 881 $template->param(
 882             #classlist => $classlist,
 883             total => $total,
 884             opacfacets => 1,
 885             facets_loop => $facets,
 886             displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
 887             scan => $scan,
 888             search_error => $error,
 889 );
 890
 891 if ($query_desc || $limit_desc) {
 892     $template->param(searchdesc => 1);
 893 }
 894
 895 # VI. BUILD THE TEMPLATE
 896 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
 897     {
 898         borrowernumber => $borrowernumber,
 899         add_allowed    => 1,
 900         public         => 0,
 901     }
 902 );
 903 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 904     {
 905         borrowernumber => $borrowernumber,
 906         add_allowed    => 1,
 907         public         => 1,
 908     }
 909 );
 910
 911 $template->param(
 912     add_to_some_private_shelves => $some_private_shelves,
 913     add_to_some_public_shelves  => $some_public_shelves,
 914 );
 915
 916 my $content_type = ($format eq 'rss' or $format eq 'atom' or $format eq 'opensearchdescription') ? $format : 'html';
 917
 918 $template->{VARS}->{DidYouMean} =
 919   ( defined C4::Context->preference('OPACdidyoumean')
 920       && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
 921
 922 if ($offset == 0) {
 923     $template->param(firstPage => 1);
 924 }
 925
 926     $template->param( borrowernumber    => $borrowernumber);
 927 output_with_http_headers $cgi, $cookie, $template->output, $content_type;