catalogue/search.pl

   1 #!/usr/bin/perl
   2 # Script to perform searching
   3 # For documentation try 'perldoc /path/to/search'
   4 #
   5 # Copyright 2006 LibLime
   6 # Copyright 2010 BibLibre
   7 #
   8 # This file is part of Koha
   9 #
  10 # Koha is free software; you can redistribute it and/or modify it
  11 # under the terms of the GNU General Public License as published by
  12 # the Free Software Foundation; either version 3 of the License, or
  13 # (at your option) any later version.
  14 #
  15 # Koha is distributed in the hope that it will be useful, but
  16 # WITHOUT ANY WARRANTY; without even the implied warranty of
  17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18 # GNU General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU General Public License
  21 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  22
  23 =head1 NAME
  24
  25 search - a search script for finding records in a Koha system (Version 3)
  26
  27 =head1 OVERVIEW
  28
  29 This script utilizes a new search API for Koha 3. It is designed to be
  30 simple to use and configure, yet capable of performing feats like stemming,
  31 field weighting, relevance ranking, support for multiple  query language
  32 formats (CCL, CQL, PQF), full support for the bib1 attribute set, extended
  33 attribute sets defined in Zebra profiles, access to the full range of Z39.50
  34 and SRU query options, federated searches on Z39.50/SRU targets, etc.
  35
  36 The API as represented in this script is mostly sound, even if the individual
  37 functions in Search.pm and Koha.pm need to be cleaned up. Of course, you are
  38 free to disagree :-)
  39
  40 I will attempt to describe what is happening at each part of this script.
  41 -- Joshua Ferraro <jmf AT liblime DOT com>
  42
  43 =head2 INTRO
  44
  45 This script performs two functions:
  46
  47 =over
  48
  49 =item 1. interacts with Koha to retrieve and display the results of a search
  50
  51 =item 2. loads the advanced search page
  52
  53 =back
  54
  55 These two functions share many of the same variables and modules, so the first
  56 task is to load what they have in common and determine which template to use.
  57 Once determined, proceed to only load the variables and procedures necessary
  58 for that function.
  59
  60 =head2 LOADING ADVANCED SEARCH PAGE
  61
  62 This is fairly straightforward, and I won't go into detail ;-)
  63
  64 =head2 PERFORMING A SEARCH
  65
  66 If we're performing a search, this script  performs three primary
  67 operations:
  68
  69 =over
  70
  71 =item 1. builds query strings (yes, plural)
  72
  73 =item 2. perform the search and return the results array
  74
  75 =item 3. build the HTML for output to the template
  76
  77 =back
  78
  79 There are several additional secondary functions performed that I will
  80 not cover in detail.
  81
  82 =head3 1. Building Query Strings
  83
  84 There are several types of queries needed in the process of search and retrieve:
  85
  86 =over
  87
  88 =item 1 $query - the fully-built query passed to zebra
  89
  90 This is the most complex query that needs to be built. The original design goal
  91 was to use a custom CCL2PQF query parser to translate an incoming CCL query into
  92 a multi-leaf query to pass to Zebra. It needs to be multi-leaf to allow field
  93 weighting, koha-specific relevance ranking, and stemming. When I have a chance
  94 I'll try to flesh out this section to better explain.
  95
  96 This query incorporates query profiles that aren't compatible with most non-Zebra
  97 Z39.50 targets to accomplish the field weighting and relevance ranking.
  98
  99 =item 2 $simple_query - a simple query that doesn't contain the field weighting,
 100 stemming, etc., suitable to pass off to other search targets
 101
 102 This query is just the user's query expressed in CCL CQL, or PQF for passing to a
 103 non-zebra Z39.50 target (one that doesn't support the extended profile that Zebra does).
 104
 105 =item 3 $query_cgi - passed to the template / saved for future refinements of
 106 the query (by user)
 107
 108 This is a simple string that completely expresses the query as a CGI string that
 109 can be used for future refinements of the query or as a part of a history feature.
 110
 111 =item 4 $query_desc - Human search description - what the user sees in search
 112 feedback area
 113
 114 This is a simple string that is human readable. It will contain '=', ',', etc.
 115
 116 =back
 117
 118 =head3 2. Perform the Search
 119
 120 This section takes the query strings and performs searches on the named servers,
 121 including the Koha Zebra server, stores the results in a deeply nested object,
 122 builds 'faceted results', and returns these objects.
 123
 124 =head3 3. Build HTML
 125
 126 The final major section of this script takes the objects collected thusfar and
 127 builds the HTML for output to the template and user.
 128
 129 =head3 Additional Notes
 130
 131 Not yet completed...
 132
 133 =cut
 134
 135 use Modern::Perl;
 136
 137 ## STEP 1. Load things that are used in both search page and
 138 # results page and decide which template to load, operations
 139 # to perform, etc.
 140
 141 ## load Koha modules
 142 use C4::Context;
 143 use C4::Output qw( output_html_with_http_headers pagination_bar );
 144 use C4::Auth qw( get_template_and_user );
 145 use C4::Search qw( searchResults enabled_staff_search_views z3950_search_args new_record_from_zebra );
 146 use C4::Languages qw( getlanguage getLanguages );
 147 use C4::Koha qw( getitemtypeimagelocation GetAuthorisedValues );
 148 use URI::Escape;
 149 use POSIX qw(ceil floor);
 150 use C4::Search qw( searchResults enabled_staff_search_views z3950_search_args new_record_from_zebra );
 151
 152 use Koha::ItemTypes;
 153 use Koha::Library::Groups;
 154 use Koha::Patrons;
 155 use Koha::SearchEngine::Search;
 156 use Koha::SearchEngine::QueryBuilder;
 157 use Koha::Virtualshelves;
 158 use Koha::SearchFields;
 159
 160 use URI::Escape;
 161
 162 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
 163 # create a new CGI object
 164 # FIXME: no_undef_params needs to be tested
 165 use CGI qw('-no_undef_params' -utf8 );
 166 my $cgi = CGI->new;
 167
 168 # decide which template to use
 169 my $template_name;
 170 my $template_type;
 171 # limits are used to limit to results to a pre-defined category such as branch or language
 172 my @limits = map uri_unescape($_), $cgi->multi_param("limit");
 173 my @nolimits = map uri_unescape($_), $cgi->multi_param('nolimit');
 174 my %is_nolimit = map { $_ => 1 } @nolimits;
 175 @limits = grep { not $is_nolimit{$_} } @limits;
 176 if  (
 177         !$cgi->param('edit_search') &&
 178         ( (@limits>=1) || (defined $cgi->param("q") && $cgi->param("q") ne "" ) || ($cgi->param('limit-yr')) )
 179     ) {
 180     $template_name = 'catalogue/results.tt';
 181     $template_type = 'results';
 182 }
 183 else {
 184     $template_name = 'catalogue/advsearch.tt';
 185     $template_type = 'advsearch';
 186 }
 187 # load the template
 188 my ($template, $borrowernumber, $cookie) = get_template_and_user({
 189     template_name => $template_name,
 190     query => $cgi,
 191     type => "intranet",
 192     flagsrequired   => { catalogue => 1 },
 193     }
 194 );
 195
 196 my $lang = C4::Languages::getlanguage($cgi);
 197
 198 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
 199     $template->param('UNIMARC' => 1);
 200 }
 201
 202 if($cgi->cookie("holdfor")){
 203     my $holdfor_patron = Koha::Patrons->find( $cgi->cookie("holdfor") );
 204     if ( $holdfor_patron ) { # may have been deleted in the meanwhile
 205         $template->param(
 206             holdfor        => $cgi->cookie("holdfor"),
 207             holdfor_patron => $holdfor_patron,
 208         );
 209     }
 210 }
 211
 212 if($cgi->cookie("holdforclub")){
 213     my $holdfor_club = Koha::Clubs->find( $cgi->cookie("holdforclub") );
 214     if ( $holdfor_club ) { # May have been deleted in the meanwhile
 215         $template->param(
 216             holdforclub => $cgi->cookie("holdforclub"),
 217             holdforclub_name => $holdfor_club->name,
 218         );
 219     }
 220 }
 221
 222 if($cgi->cookie("searchToOrder")){
 223     my ( $basketno, $vendorid ) = split( /\//, $cgi->cookie("searchToOrder") );
 224     $template->param(
 225         searchtoorder_basketno => $basketno,
 226         searchtoorder_vendorid => $vendorid
 227     );
 228 }
 229
 230 # get biblionumbers stored in the cart
 231 my @cart_list;
 232
 233 if($cgi->cookie("intranet_bib_list")){
 234     my $cart_list = $cgi->cookie("intranet_bib_list");
 235     @cart_list = split(/\//, $cart_list);
 236 }
 237
 238 my @search_groups =
 239   Koha::Library::Groups->get_search_groups( { interface => 'staff' } )->as_list;
 240
 241 $template->param(
 242     search_groups    => \@search_groups,
 243 );
 244
 245 # load the Type stuff
 246 my $types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 247 my $advancedsearchesloop = prepare_adv_search_types($types);
 248 $template->param(advancedsearchesloop => $advancedsearchesloop);
 249
 250 $template->param( searchid => scalar $cgi->param('searchid'), );
 251
 252 # The following should only be loaded if we're bringing up the advanced search template
 253 if ( $template_type eq 'advsearch' ) {
 254
 255     my $expanded = $cgi->param('expanded_options');
 256     if( $cgi->param('edit_search') ){
 257         my @operators = $cgi->multi_param('op');
 258         my @indexes   = $cgi->multi_param('idx');
 259         my %limit_hash;
 260         foreach my $limit (@limits){
 261             if ( $limit eq 'available' ){
 262                 $template->param( limit_available => 1 );
 263             } else {
 264                 my ($index,$value) = split(':',$limit);
 265                 $value =~ s/"//g;
 266                 if ( $index =~ /mc-/ ){
 267                     $limit_hash{$index . "_" . $value} = 1;
 268                 } else {
 269                     push @{$limit_hash{$index}}, $value;
 270                 }
 271             }
 272         };
 273         $expanded = 1 if scalar @operators || scalar @limits;
 274         $template->param( operators => \@operators );
 275         $template->param( limits => \%limit_hash );
 276         $template->param(
 277            indexes   => \@indexes,
 278            sort      => $cgi->param('sort_by'),
 279         );
 280     }
 281     # load the servers (used for searching -- to do federated searching, etc.)
 282     my $primary_servers_loop;# = displayPrimaryServers();
 283     $template->param(outer_servers_loop =>  $primary_servers_loop,);
 284
 285     my $secondary_servers_loop;
 286     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 287
 288     # set the default sorting
 289     if (   C4::Context->preference('defaultSortField')
 290         && C4::Context->preference('defaultSortOrder') ) {
 291         my $default_sort_by =
 292             C4::Context->preference('defaultSortField') . '_'
 293           . C4::Context->preference('defaultSortOrder');
 294         $template->param( sort_by => $default_sort_by  );
 295     }
 296
 297     # determine what to display next to the search boxes
 298     my @queries = $cgi->multi_param('q');
 299     while( scalar @queries < 3 ){
 300         push @queries, "";
 301     }
 302     $template->param(uc(C4::Context->preference("marcflavour")) =>1 );
 303
 304     # load the language limits (for search)
 305     my $languages_limit_loop = getLanguages($lang, 1);
 306     $template->param(search_languages_loop => $languages_limit_loop,);
 307     $template->param(       queries   => \@queries );
 308
 309     # Expanded search options in advanced search:
 310     # use the global setting by default, but let the user override it
 311     {
 312         $expanded = C4::Context->preference("expandedSearchOption") || 0
 313             if !defined($expanded) || $expanded !~ /^0|1$/;
 314         $template->param( expanded_options => $expanded );
 315     }
 316
 317     $template->param(virtualshelves => C4::Context->preference("virtualshelves"));
 318
 319     output_html_with_http_headers $cgi, $cookie, $template->output;
 320     exit;
 321 }
 322
 323 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
 324
 325 # Fetch the paramater list as a hash in scalar context:
 326 #  * returns paramater list as tied hash ref
 327 #  * we can edit the values by changing the key
 328 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 329 my $params = $cgi->Vars;
 330 # Params that can have more than one value
 331 # sort by is used to sort the query
 332 # in theory can have more than one but generally there's just one
 333 my @sort_by;
 334 my $default_sort_by;
 335 if (   C4::Context->preference('defaultSortField')
 336     && C4::Context->preference('defaultSortOrder') ) {
 337     $default_sort_by =
 338         C4::Context->preference('defaultSortField') . '_'
 339       . C4::Context->preference('defaultSortOrder');
 340 }
 341
 342 @sort_by = $cgi->multi_param('sort_by');
 343 $sort_by[0] = $default_sort_by unless $sort_by[0];
 344 foreach my $sort (@sort_by) {
 345     $template->param($sort => 1) if $sort;
 346 }
 347 $template->param('sort_by' => $sort_by[0]);
 348
 349 # Use the servers defined, or just search our local catalog(default)
 350 my @servers = $cgi->multi_param('server');
 351 unless (@servers) {
 352     #FIXME: this should be handled using Context.pm
 353     @servers = ("biblioserver");
 354     # @servers = C4::Context->config("biblioserver");
 355 }
 356 # operators include boolean and proximity operators and are used
 357 # to evaluate multiple operands
 358 my @operators = map uri_unescape($_), $cgi->multi_param('op');
 359
 360 # indexes are query qualifiers, like 'title', 'author', etc. They
 361 # can be single or multiple parameters separated by comma: kw,right-Truncation
 362 my @indexes = map uri_unescape($_), $cgi->multi_param('idx');
 363
 364 # if a simple index (only one)  display the index used in the top search box
 365 if ($indexes[0] && (!$indexes[1] || $params->{'scan'})) {
 366     my $idx = "ms_".$indexes[0];
 367     $idx =~ s/\,/comma/g;  # template toolkit doesn't like variables with a , in it
 368     $idx =~ s/-/dash/g;  # template toolkit doesn't like variables with a dash in it
 369     $template->param($idx => 1);
 370 }
 371
 372 # an operand can be a single term, a phrase, or a complete ccl query
 373 my @operands = map uri_unescape($_), $cgi->multi_param('q');
 374
 375 # if a simple search, display the value in the search box
 376 if ($operands[0] && !$operands[1]) {
 377     my $ms_query = $operands[0];
 378     $ms_query =~ s/ #\S+//;
 379     $template->param(ms_value => $ms_query);
 380 }
 381
 382 my $available;
 383 foreach my $limit(@limits) {
 384     if ($limit =~/available/) {
 385         $available = 1;
 386     }
 387 }
 388 $template->param(available => $available);
 389
 390 # append year limits if they exist
 391 my $limit_yr;
 392 my $limit_yr_value;
 393 if ($params->{'limit-yr'}) {
 394     if ($params->{'limit-yr'} =~ /\d{4}/) {
 395         $limit_yr = "yr,st-numeric:$params->{'limit-yr'}";
 396         $limit_yr_value = $params->{'limit-yr'};
 397     }
 398     push @limits,$limit_yr;
 399     #FIXME: Should return a error to the user, incorect date format specified
 400 }
 401
 402 # convert indexes and operands to corresponding parameter names for the z3950 search
 403 # $ %z3950p will be a hash ref if the indexes are present (advacned search), otherwise undef
 404 my $z3950par;
 405 my $indexes2z3950 = {
 406     kw=>'title', au=>'author', 'au,phr'=>'author', nb=>'isbn', ns=>'issn',
 407     'lcn,phr'=>'dewey', su=>'subject', 'su,phr'=>'subject',
 408     ti=>'title', 'ti,phr'=>'title', se=>'title'
 409 };
 410 for (my $ii = 0; $ii < @operands; ++$ii)
 411 {
 412     my $name = $indexes2z3950->{$indexes[$ii] || 'kw'};
 413     if (defined $name && defined $operands[$ii])
 414     {
 415         $z3950par ||= {};
 416         $z3950par->{$name} = $operands[$ii] if !exists $z3950par->{$name};
 417     }
 418 }
 419
 420
 421 # Params that can only have one value
 422 my $scan = $params->{'scan'};
 423 my $count = C4::Context->preference('numSearchResults') || 20;
 424 my $results_per_page = $params->{'count'} || $count;
 425 my $offset = $params->{'offset'} || 0;
 426 my $whole_record = $params->{'whole_record'} || 0;
 427 my $weight_search = $params->{'advsearch'} ? $params->{'weight_search'} || 0 : 1;
 428 $offset = 0 if $offset < 0;
 429 my $page = $cgi->param('page') || 1;
 430 #my $offset = ($page-1)*$results_per_page;
 431
 432 # Define some global variables
 433 my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
 434
 435 my $builder = Koha::SearchEngine::QueryBuilder->new(
 436     { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
 437 my $searcher = Koha::SearchEngine::Search->new(
 438     { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
 439
 440 ## I. BUILD THE QUERY
 441 (
 442     $error,             $query, $simple_query, $query_cgi,
 443     $query_desc,        $limit, $limit_cgi,    $limit_desc,
 444     $query_type
 445   )
 446   = $builder->build_query_compat( \@operators, \@operands, \@indexes, \@limits,
 447     \@sort_by, $scan, $lang, { weighted_fields => $weight_search, whole_record => $whole_record });
 448
 449 $template->param( search_query => $query ) if C4::Context->preference('DumpSearchQueryTemplate');
 450
 451 ## parse the query_cgi string and put it into a form suitable for <input>s
 452 my @query_inputs;
 453 my $scan_index_to_use;
 454 my $scan_search_term_to_use;
 455
 456 if ($query_cgi) {
 457     for my $this_cgi ( split('&', $query_cgi) ) {
 458         next unless $this_cgi;
 459         $this_cgi =~ m/(.*?)=(.*)/;
 460         my $input_name = $1;
 461         my $input_value = $2;
 462         push @query_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape( $input_value ) ) };
 463         if ($input_name eq 'idx') {
 464             # The form contains multiple fields, so take the first value as the scan index
 465             $scan_index_to_use = $input_value unless $scan_index_to_use;
 466         }
 467         if (!defined $scan_search_term_to_use && $input_name eq 'q') {
 468             $scan_search_term_to_use = Encode::decode_utf8( uri_unescape( $input_value ));
 469         }
 470     }
 471 }
 472
 473 $template->param ( QUERY_INPUTS => \@query_inputs,
 474                    scan_index_to_use => $scan_index_to_use,
 475                    scan_search_term_to_use => $scan_search_term_to_use );
 476
 477 ## parse the limit_cgi string and put it into a form suitable for <input>s
 478 my @limit_inputs;
 479 if ($limit_cgi) {
 480     for my $this_cgi ( split('&', $limit_cgi) ) {
 481         next unless $this_cgi;
 482         # handle special case limit-yr
 483         if ($this_cgi =~ /yr,st-numeric/) {
 484             push @limit_inputs, { input_name => 'limit-yr', input_value => $limit_yr_value };
 485             next;
 486         }
 487         $this_cgi =~ m/(.*=)(.*)/;
 488         my $input_name = $1;
 489         my $input_value = $2;
 490         $input_name =~ s/=$//;
 491         push @limit_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape($input_value) ) };
 492     }
 493 }
 494 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 495
 496 ## II. DO THE SEARCH AND GET THE RESULTS
 497 my $total = 0; # the total results for the whole set
 498 my $facets; # this object stores the faceted results that display on the left-hand of the results page
 499 my $results_hashref;
 500
 501 eval {
 502     my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
 503     ( $error, $results_hashref, $facets ) = $searcher->search_compat(
 504         $query,            $simple_query, \@sort_by,       \@servers,
 505         $results_per_page, $offset,       undef,           $itemtypes,
 506         $query_type,       $scan
 507     );
 508 };
 509
 510 if ($@ || $error) {
 511     my $query_error = q{};
 512     $query_error .= $error if $error;
 513     $query_error .= $@ if $@;
 514     $template->param(query_error => $query_error);
 515     output_html_with_http_headers $cgi, $cookie, $template->output;
 516     exit;
 517 }
 518
 519 # At this point, each server has given us a result set
 520 # now we build that set for template display
 521 my @sup_results_array;
 522 for (my $i=0;$i<@servers;$i++) {
 523     my $server = $servers[$i];
 524     if ($server =~/biblioserver/) { # this is the local bibliographic server
 525         my $hits = $results_hashref->{$server}->{"hits"} // 0;
 526         my $page = $cgi->param('page') || 0;
 527         my @newresults = searchResults({ 'interface' => 'intranet' }, $query_desc, $hits, $results_per_page, $offset, $scan,
 528                                        $results_hashref->{$server}->{"RECORDS"});
 529         $total = $total + $hits;
 530
 531         # Search history
 532         if (C4::Context->preference('EnableSearchHistory')) {
 533             unless ( $offset ) {
 534                 my $path_info = $cgi->url(-path_info=>1);
 535                 my $query_cgi_history = $cgi->url(-query=>1);
 536                 $query_cgi_history =~ s/^$path_info\?//;
 537                 $query_cgi_history =~ s/;/&/g;
 538                 my $query_desc_history = $query_desc;
 539                 $query_desc_history .= ", $limit_desc"
 540                     if $limit_desc;
 541
 542                 C4::Search::History::add({
 543                     userid => $borrowernumber,
 544                     sessionid => $cgi->cookie("CGISESSID"),
 545                     query_desc => $query_desc_history,
 546                     query_cgi => $query_cgi_history,
 547                     total => $total,
 548                     type => "biblio",
 549                 });
 550             }
 551             $template->param( EnableSearchHistory => 1 );
 552         }
 553
 554         ## If there's just one result, redirect to the detail page unless doing an index scan
 555         if ($total == 1 && !$scan) {
 556             my $biblionumber = $newresults[0]->{biblionumber};
 557             my $defaultview = C4::Context->preference('IntranetBiblioDefaultView');
 558             my $views = { C4::Search::enabled_staff_search_views };
 559             if ($defaultview eq 'isbd' && $views->{can_view_ISBD}) {
 560                 print $cgi->redirect("/cgi-bin/koha/catalogue/ISBDdetail.pl?biblionumber=$biblionumber&found1=1");
 561             } elsif  ($defaultview eq 'marc' && $views->{can_view_MARC}) {
 562                 print $cgi->redirect("/cgi-bin/koha/catalogue/MARCdetail.pl?biblionumber=$biblionumber&found1=1");
 563             } elsif  ($defaultview eq 'labeled_marc' && $views->{can_view_labeledMARC}) {
 564                 print $cgi->redirect("/cgi-bin/koha/catalogue/labeledMARCdetail.pl?biblionumber=$biblionumber&found1=1");
 565             } else {
 566                 print $cgi->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber&found1=1");
 567             }
 568             exit;
 569         }
 570
 571         # set up parameters if user wishes to re-run the search
 572         # as a Z39.50 search
 573         $template->param (z3950_search_params => C4::Search::z3950_search_args($z3950par || $query_desc));
 574         $template->param(limit_cgi => $limit_cgi);
 575         $template->param(query_cgi => $query_cgi);
 576         $template->param(query_desc => $query_desc);
 577         $template->param(limit_desc => $limit_desc);
 578         $template->param(offset     => $offset);
 579
 580         if ($hits) {
 581             $template->param(total => $hits);
 582             if ($limit_cgi) {
 583                 my $limit_cgi_not_availablity = $limit_cgi;
 584                 $limit_cgi_not_availablity =~ s/&limit=available//g;
 585                 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
 586             }
 587             $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
 588             if ($query_desc || $limit_desc) {
 589                 $template->param(searchdesc => 1);
 590             }
 591             $template->param(results_per_page =>  $results_per_page);
 592             # must define a value for size if not present in DB
 593             # in order to avoid problems generated by the default size value in TT
 594             foreach my $line (@newresults) {
 595                 if ( not exists $line->{'size'} ) { $line->{'size'} = "" }
 596                 # while we're checking each line, see if item is in the cart
 597                 if ( grep {$_ eq $line->{'biblionumber'}} @cart_list) {
 598                     $line->{'incart'} = 1;
 599                 }
 600             }
 601             my( $page_numbers, $hits_to_paginate, $pages, $current_page_number, $previous_page_offset, $next_page_offset, $last_page_offset ) =
 602                 Koha::SearchEngine::Search->pagination_bar(
 603                     {
 604                         hits              => $hits,
 605                         max_result_window => $searcher->max_result_window,
 606                         results_per_page  => $results_per_page,
 607                         offset            => $offset,
 608                         sort_by           => \@sort_by
 609                     }
 610                 );
 611             $template->param( hits_to_paginate => $hits_to_paginate );
 612             $template->param(SEARCH_RESULTS => \@newresults);
 613             # FIXME: no previous_page_offset when pages < 2
 614             $template->param(   PAGE_NUMBERS => $page_numbers,
 615                                 last_page_offset => $last_page_offset,
 616                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
 617             $template->param(   next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
 618         }
 619
 620
 621         # no hits
 622         else {
 623             $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
 624         }
 625
 626     } # end of the if local
 627
 628     # asynchronously search the authority server
 629     elsif ($server =~/authorityserver/) { # this is the local authority server
 630         my @inner_sup_results_array;
 631         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
 632             my $marc_record_object = C4::Search::new_record_from_zebra(
 633                 'authorityserver',
 634                 $sup_record
 635             );
 636             # warn "Authority Found: ".$marc_record_object->as_formatted();
 637             push @inner_sup_results_array, {
 638                 'title' => $marc_record_object->field(100)->subfield('a'),
 639                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
 640             };
 641         }
 642         push @sup_results_array, {  servername => $server,
 643                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
 644     }
 645     # FIXME: can add support for other targets as needed here
 646     $template->param(           outer_sup_results_loop => \@sup_results_array);
 647 } #/end of the for loop
 648 #$template->param(FEDERATED_RESULTS => \@results_array);
 649
 650 my $gotonumber = $cgi->param('gotoNumber');
 651 if ( $gotonumber && ( $gotonumber eq 'last' || $gotonumber eq 'first' ) ) {
 652     $template->{'VARS'}->{'gotoNumber'} = $gotonumber;
 653 }
 654 $template->{'VARS'}->{'gotoPage'}   = 'detail.pl';
 655 my $gotopage = $cgi->param('gotoPage');
 656 $template->{'VARS'}->{'gotoPage'} = $gotopage
 657   if $gotopage && $gotopage =~ m/^(ISBD|labeledMARC|MARC|more)?detail.pl$/;
 658
 659 for my $facet ( @$facets ) {
 660     for my $entry ( @{ $facet->{facets} } ) {
 661         my $index = $entry->{type_link_value};
 662         my $value = $entry->{facet_link_value};
 663         $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
 664     }
 665 }
 666
 667 $template->param(
 668             #classlist => $classlist,
 669             total => $total,
 670             opacfacets => 1,
 671             facets_loop => $facets,
 672             displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
 673             scan => $scan,
 674             search_error => $error,
 675 );
 676
 677 if ($query_desc || $limit_desc) {
 678     $template->param(searchdesc => 1);
 679 }
 680
 681 # VI. BUILD THE TEMPLATE
 682
 683 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
 684     {
 685         borrowernumber => $borrowernumber,
 686         add_allowed    => 1,
 687         public         => 0,
 688     }
 689 );
 690 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 691     {
 692         borrowernumber => $borrowernumber,
 693         add_allowed    => 1,
 694         public         => 1,
 695     }
 696 );
 697
 698
 699 $template->param(
 700     add_to_some_private_shelves => $some_private_shelves,
 701     add_to_some_public_shelves  => $some_public_shelves,
 702 );
 703
 704 output_html_with_http_headers $cgi, $cookie, $template->output;
 705
 706
 707 =head2 prepare_adv_search_types
 708
 709     my $type = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 710     my @advanced_search_types = prepare_adv_search_types($type);
 711
 712 Different types can be searched for in the advanced search. This takes the
 713 system preference that defines these types and parses it into an arrayref for
 714 the template.
 715
 716 "itemtypes" is handled specially, as itemtypes aren't an authorised value.
 717 It also accounts for the "item-level_itypes" system preference.
 718
 719 =cut
 720
 721 sub prepare_adv_search_types {
 722     my ($types) = @_;
 723
 724     my @advanced_search_types = split( /\|/, $types );
 725
 726     # the index parameter is different for item-level itemtypes
 727     my $itype_or_itemtype =
 728       ( C4::Context->preference("item-level_itypes") ) ? 'itype' : 'itemtype';
 729     my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
 730
 731     my ( $cnt, @result );
 732     foreach my $advanced_srch_type (@advanced_search_types) {
 733         $advanced_srch_type =~ s/^\s*//;
 734         $advanced_srch_type =~ s/\s*$//;
 735         if ( $advanced_srch_type eq 'itemtypes' ) {
 736
 737        # itemtype is a special case, since it's not defined in authorized values
 738             my @itypesloop;
 739             foreach my $thisitemtype (
 740                 sort {
 741                     $itemtypes->{$a}->{'translated_description'}
 742                       cmp $itemtypes->{$b}->{'translated_description'}
 743                 } keys %$itemtypes
 744               )
 745             {
 746                 my %row = (
 747                     number      => $cnt++,
 748                     ccl         => "$itype_or_itemtype,phr",
 749                     code        => $thisitemtype,
 750                     description => $itemtypes->{$thisitemtype}->{'translated_description'},
 751                     imageurl    => getitemtypeimagelocation(
 752                         'intranet', $itemtypes->{$thisitemtype}->{'imageurl'}
 753                     ),
 754                 );
 755                 push @itypesloop, \%row;
 756             }
 757             my %search_code = (
 758                 advanced_search_type => $advanced_srch_type,
 759                 code_loop            => \@itypesloop
 760             );
 761             push @result, \%search_code;
 762         }
 763         else {
 764             # covers all the other cases: non-itemtype authorized values
 765             my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
 766             my @authvalueloop;
 767             for my $thisitemtype (@$advsearchtypes) {
 768                 my %row = (
 769                     number      => $cnt++,
 770                     ccl         => $advanced_srch_type,
 771                     code        => $thisitemtype->{authorised_value},
 772                     description => $thisitemtype->{'lib'},
 773                     imageurl    => getitemtypeimagelocation(
 774                         'intranet', $thisitemtype->{'imageurl'}
 775                     ),
 776                 );
 777                 push @authvalueloop, \%row;
 778             }
 779             my %search_code = (
 780                 advanced_search_type => $advanced_srch_type,
 781                 code_loop            => \@authvalueloop
 782             );
 783             push @result, \%search_code;
 784         }
 785     }
 786     return \@result;
 787 }