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