opac/opac-search.pl

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