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