opac/opac-search.pl

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