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