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