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