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