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