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;
 144 use C4::Auth qw(:DEFAULT get_session);
 145 use C4::Search;
 146 use C4::Languages qw(getLanguages);
 147 use C4::Koha;
 148 use URI::Escape;
 149 use POSIX qw(ceil floor);
 150 use C4::Search::History;
 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 = new CGI;
 167
 168 # decide which template to use
 169 my $template_name;
 170 my $template_type;
 171 my @params = $cgi->multi_param("limit");
 172 if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
 173     $template_name = 'catalogue/results.tt';
 174     $template_type = 'results';
 175 }
 176 else {
 177     $template_name = 'catalogue/advsearch.tt';
 178     $template_type = 'advsearch';
 179 }
 180 # load the template
 181 my ($template, $borrowernumber, $cookie) = get_template_and_user({
 182     template_name => $template_name,
 183     query => $cgi,
 184     type => "intranet",
 185     authnotrequired => 0,
 186     flagsrequired   => { catalogue => 1 },
 187     }
 188 );
 189
 190 my $lang = C4::Languages::getlanguage($cgi);
 191
 192 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
 193     $template->param('UNIMARC' => 1);
 194 }
 195
 196 if($cgi->cookie("holdfor")){
 197     my $holdfor_patron = Koha::Patrons->find( $cgi->cookie("holdfor") );
 198     $template->param(
 199         holdfor => $cgi->cookie("holdfor"),
 200         holdfor_surname => $holdfor_patron->surname,
 201         holdfor_firstname => $holdfor_patron->firstname,
 202         holdfor_cardnumber => $holdfor_patron->cardnumber,
 203     );
 204 }
 205
 206 if($cgi->cookie("holdforclub")){
 207     my $holdfor_club = Koha::Clubs->find( $cgi->cookie("holdforclub") );
 208     $template->param(
 209         holdforclub => $cgi->cookie("holdforclub"),
 210         holdforclub_name => $holdfor_club->name,
 211     );
 212 }
 213
 214 if($cgi->cookie("searchToOrder")){
 215     my ( $basketno, $vendorid ) = split( /\//, $cgi->cookie("searchToOrder") );
 216     $template->param(
 217         searchtoorder_basketno => $basketno,
 218         searchtoorder_vendorid => $vendorid
 219     );
 220 }
 221
 222 # get biblionumbers stored in the cart
 223 my @cart_list;
 224
 225 if($cgi->cookie("intranet_bib_list")){
 226     my $cart_list = $cgi->cookie("intranet_bib_list");
 227     @cart_list = split(/\//, $cart_list);
 228 }
 229
 230 my @search_groups =
 231   Koha::Library::Groups->get_search_groups( { interface => 'staff' } );
 232 @search_groups = sort { $a->title cmp $b->title } @search_groups;
 233
 234 $template->param(
 235     selected_branchcode => ( C4::Context->IsSuperLibrarian ? C4::Context->userenv : '' ),
 236     search_groups    => \@search_groups,
 237 );
 238
 239 # load the Type stuff
 240 my $types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 241 my $advancedsearchesloop = prepare_adv_search_types($types);
 242 $template->param(advancedsearchesloop => $advancedsearchesloop);
 243
 244 # The following should only be loaded if we're bringing up the advanced search template
 245 if ( $template_type eq 'advsearch' ) {
 246
 247     # load the servers (used for searching -- to do federated searching, etc.)
 248     my $primary_servers_loop;# = displayPrimaryServers();
 249     $template->param(outer_servers_loop =>  $primary_servers_loop,);
 250
 251     my $secondary_servers_loop;
 252     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 253
 254     # set the default sorting
 255     if (   C4::Context->preference('defaultSortField')
 256         && C4::Context->preference('defaultSortOrder') ) {
 257         my $default_sort_by =
 258             C4::Context->preference('defaultSortField') . '_'
 259           . C4::Context->preference('defaultSortOrder');
 260         $template->param( sort_by => $default_sort_by  );
 261     }
 262
 263     # determine what to display next to the search boxes (ie, boolean option
 264     # shouldn't appear on the first one, scan indexes should, adding a new
 265     # box should only appear on the last, etc.
 266     my @search_boxes_array;
 267     my $search_boxes_count = 3; # begin with 3 boxes
 268     # FIXME: all this junk can be done in TMPL using __first__ and __last__
 269     for (my $i=1;$i<=$search_boxes_count;$i++) {
 270         # if it's the first one, don't display boolean option, but show scan indexes
 271         if ($i==1) {
 272             push @search_boxes_array, {scan_index => 1};
 273         }
 274         # if it's the last one, show the 'add field' box
 275         elsif ($i==$search_boxes_count) {
 276             push @search_boxes_array,
 277                 {
 278                 boolean => 1,
 279                 add_field => 1,
 280                 };
 281         }
 282         else {
 283             push @search_boxes_array,
 284                 {
 285                 boolean => 1,
 286                 };
 287         }
 288
 289     }
 290     $template->param(uc(C4::Context->preference("marcflavour")) => 1,
 291                       search_boxes_loop => \@search_boxes_array);
 292
 293     # load the language limits (for search)
 294     my $languages_limit_loop = getLanguages($lang, 1);
 295     $template->param(search_languages_loop => $languages_limit_loop,);
 296
 297     # Expanded search options in advanced search:
 298     # use the global setting by default, but let the user override it
 299     {
 300         my $expanded = $cgi->param('expanded_options');
 301         $expanded = C4::Context->preference("expandedSearchOption") || 0
 302             if !defined($expanded) || $expanded !~ /^0|1$/;
 303         $template->param( expanded_options => $expanded );
 304     }
 305
 306     $template->param(virtualshelves => C4::Context->preference("virtualshelves"));
 307
 308     output_html_with_http_headers $cgi, $cookie, $template->output;
 309     exit;
 310 }
 311
 312 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
 313
 314 # Fetch the paramater list as a hash in scalar context:
 315 #  * returns paramater list as tied hash ref
 316 #  * we can edit the values by changing the key
 317 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 318 my $params = $cgi->Vars;
 319 # Params that can have more than one value
 320 # sort by is used to sort the query
 321 # in theory can have more than one but generally there's just one
 322 my @sort_by;
 323 my $default_sort_by;
 324 if (   C4::Context->preference('defaultSortField')
 325     && C4::Context->preference('defaultSortOrder') ) {
 326     $default_sort_by =
 327         C4::Context->preference('defaultSortField') . '_'
 328       . C4::Context->preference('defaultSortOrder');
 329 }
 330
 331 @sort_by = $cgi->multi_param('sort_by');
 332 $sort_by[0] = $default_sort_by unless $sort_by[0];
 333 foreach my $sort (@sort_by) {
 334     $template->param($sort => 1) if $sort;
 335 }
 336 $template->param('sort_by' => $sort_by[0]);
 337
 338 # Use the servers defined, or just search our local catalog(default)
 339 my @servers = $cgi->multi_param('server');
 340 unless (@servers) {
 341     #FIXME: this should be handled using Context.pm
 342     @servers = ("biblioserver");
 343     # @servers = C4::Context->config("biblioserver");
 344 }
 345 # operators include boolean and proximity operators and are used
 346 # to evaluate multiple operands
 347 my @operators = map uri_unescape($_), $cgi->multi_param('op');
 348
 349 # indexes are query qualifiers, like 'title', 'author', etc. They
 350 # can be single or multiple parameters separated by comma: kw,right-Truncation
 351 my @indexes = map uri_unescape($_), $cgi->multi_param('idx');
 352
 353 # if a simple index (only one)  display the index used in the top search box
 354 if ($indexes[0] && (!$indexes[1] || $params->{'scan'})) {
 355     my $idx = "ms_".$indexes[0];
 356     $idx =~ s/\,/comma/g;  # template toolkit doesn't like variables with a , in it
 357     $idx =~ s/-/dash/g;  # template toolkit doesn't like variables with a dash in it
 358     $template->param($idx => 1);
 359 }
 360
 361 # an operand can be a single term, a phrase, or a complete ccl query
 362 my @operands = map uri_unescape($_), $cgi->multi_param('q');
 363
 364 # if a simple search, display the value in the search box
 365 if ($operands[0] && !$operands[1]) {
 366     my $ms_query = $operands[0];
 367     $ms_query =~ s/ #\S+//;
 368     $template->param(ms_value => $ms_query);
 369 }
 370
 371 # limits are use to limit to results to a pre-defined category such as branch or language
 372 my @limits = map uri_unescape($_), $cgi->multi_param('limit');
 373 my @nolimits = map uri_unescape($_), $cgi->multi_param('nolimit');
 374 my %is_nolimit = map { $_ => 1 } @nolimits;
 375 @limits = grep { not $is_nolimit{$_} } @limits;
 376
 377 if($params->{'multibranchlimit'}) {
 378     my $search_group = Koha::Library::Groups->find( $params->{multibranchlimit} );
 379     my @libraries = $search_group->all_libraries;
 380     my $multibranch = '('.join( " OR ", map { '(homebranch: ' . $_->branchcode .')' } @libraries ) .')';
 381     push @limits, $multibranch if ($multibranch ne  '()');
 382 }
 383
 384 my $available;
 385 foreach my $limit(@limits) {
 386     if ($limit =~/available/) {
 387         $available = 1;
 388     }
 389 }
 390 $template->param(available => $available);
 391
 392 # append year limits if they exist
 393 my $limit_yr;
 394 my $limit_yr_value;
 395 if ($params->{'limit-yr'}) {
 396     if ($params->{'limit-yr'} =~ /\d{4}/) {
 397         $limit_yr = "yr,st-numeric=$params->{'limit-yr'}";
 398         $limit_yr_value = $params->{'limit-yr'};
 399     }
 400     push @limits,$limit_yr;
 401     #FIXME: Should return a error to the user, incorect date format specified
 402 }
 403
 404 # convert indexes and operands to corresponding parameter names for the z3950 search
 405 # $ %z3950p will be a hash ref if the indexes are present (advacned search), otherwise undef
 406 my $z3950par;
 407 my $indexes2z3950 = {
 408     kw=>'title', au=>'author', 'au,phr'=>'author', nb=>'isbn', ns=>'issn',
 409     'lcn,phr'=>'dewey', su=>'subject', 'su,phr'=>'subject',
 410     ti=>'title', 'ti,phr'=>'title', se=>'title'
 411 };
 412 for (my $ii = 0; $ii < @operands; ++$ii)
 413 {
 414     my $name = $indexes2z3950->{$indexes[$ii] || 'kw'};
 415     if (defined $name && defined $operands[$ii])
 416     {
 417         $z3950par ||= {};
 418         $z3950par->{$name} = $operands[$ii] if !exists $z3950par->{$name};
 419     }
 420 }
 421
 422
 423 # Params that can only have one value
 424 my $scan = $params->{'scan'};
 425 my $count = C4::Context->preference('numSearchResults') || 20;
 426 my $results_per_page = $params->{'count'} || $count;
 427 my $offset = $params->{'offset'} || 0;
 428 my $whole_record = $params->{'whole_record'} || 0;
 429 $offset = 0 if $offset < 0;
 430 my $page = $cgi->param('page') || 1;
 431 #my $offset = ($page-1)*$results_per_page;
 432
 433 # Define some global variables
 434 my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
 435
 436 my $builder = Koha::SearchEngine::QueryBuilder->new(
 437     { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
 438 my $searcher = Koha::SearchEngine::Search->new(
 439     { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
 440
 441 ## I. BUILD THE QUERY
 442 (
 443     $error,             $query, $simple_query, $query_cgi,
 444     $query_desc,        $limit, $limit_cgi,    $limit_desc,
 445     $query_type
 446   )
 447   = $builder->build_query_compat( \@operators, \@operands, \@indexes, \@limits,
 448     \@sort_by, $scan, $lang, { weighted_fields => !$cgi->param('advsearch'), whole_record => $whole_record });
 449
 450 $template->param( search_query => $query ) if C4::Context->preference('DumpSearchQueryTemplate');
 451
 452 ## parse the query_cgi string and put it into a form suitable for <input>s
 453 my @query_inputs;
 454 my $scan_index_to_use;
 455 my $scan_search_term_to_use;
 456
 457 if ($query_cgi) {
 458     for my $this_cgi ( split('&', $query_cgi) ) {
 459         next unless $this_cgi;
 460         $this_cgi =~ m/(.*?)=(.*)/;
 461         my $input_name = $1;
 462         my $input_value = $2;
 463         push @query_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape( $input_value ) ) };
 464         if ($input_name eq 'idx') {
 465             # The form contains multiple fields, so take the first value as the scan index
 466             $scan_index_to_use = $input_value unless $scan_index_to_use;
 467         }
 468         if (!defined $scan_search_term_to_use && $input_name eq 'q') {
 469             $scan_search_term_to_use = Encode::decode_utf8( uri_unescape( $input_value ));
 470         }
 471     }
 472 }
 473
 474 $template->param ( QUERY_INPUTS => \@query_inputs,
 475                    scan_index_to_use => $scan_index_to_use,
 476                    scan_search_term_to_use => $scan_search_term_to_use );
 477
 478 ## parse the limit_cgi string and put it into a form suitable for <input>s
 479 my @limit_inputs;
 480 if ($limit_cgi) {
 481     for my $this_cgi ( split('&', $limit_cgi) ) {
 482         next unless $this_cgi;
 483         # handle special case limit-yr
 484         if ($this_cgi =~ /yr,st-numeric/) {
 485             push @limit_inputs, { input_name => 'limit-yr', input_value => $limit_yr_value };
 486             next;
 487         }
 488         $this_cgi =~ m/(.*=)(.*)/;
 489         my $input_name = $1;
 490         my $input_value = $2;
 491         $input_name =~ s/=$//;
 492         push @limit_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape($input_value) ) };
 493     }
 494 }
 495 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 496
 497 ## II. DO THE SEARCH AND GET THE RESULTS
 498 my $total = 0; # the total results for the whole set
 499 my $facets; # this object stores the faceted results that display on the left-hand of the results page
 500 my $results_hashref;
 501
 502 eval {
 503     my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
 504     ( $error, $results_hashref, $facets ) = $searcher->search_compat(
 505         $query,            $simple_query, \@sort_by,       \@servers,
 506         $results_per_page, $offset,       undef,           $itemtypes,
 507         $query_type,       $scan
 508     );
 509 };
 510
 511 if ($@ || $error) {
 512     $template->param(query_error => $error.$@);
 513     output_html_with_http_headers $cgi, $cookie, $template->output;
 514     exit;
 515 }
 516
 517 # At this point, each server has given us a result set
 518 # now we build that set for template display
 519 my @sup_results_array;
 520 for (my $i=0;$i<@servers;$i++) {
 521     my $server = $servers[$i];
 522     if ($server =~/biblioserver/) { # this is the local bibliographic server
 523         my $hits = $results_hashref->{$server}->{"hits"} // 0;
 524         my $page = $cgi->param('page') || 0;
 525         my @newresults = searchResults({ 'interface' => 'intranet' }, $query_desc, $hits, $results_per_page, $offset, $scan,
 526                                        $results_hashref->{$server}->{"RECORDS"});
 527         $total = $total + $hits;
 528
 529         # Search history
 530         if (C4::Context->preference('EnableSearchHistory')) {
 531             unless ( $offset ) {
 532                 my $path_info = $cgi->url(-path_info=>1);
 533                 my $query_cgi_history = $cgi->url(-query=>1);
 534                 $query_cgi_history =~ s/^$path_info\?//;
 535                 $query_cgi_history =~ s/;/&/g;
 536                 my $query_desc_history = $query_desc;
 537                 $query_desc_history .= ", $limit_desc"
 538                     if $limit_desc;
 539
 540                 C4::Search::History::add({
 541                     userid => $borrowernumber,
 542                     sessionid => $cgi->cookie("CGISESSID"),
 543                     query_desc => $query_desc_history,
 544                     query_cgi => $query_cgi_history,
 545                     total => $total,
 546                     type => "biblio",
 547                 });
 548             }
 549             $template->param( EnableSearchHistory => 1 );
 550         }
 551
 552         ## If there's just one result, redirect to the detail page unless doing an index scan
 553         if ($total == 1 && !$scan) {
 554             my $biblionumber = $newresults[0]->{biblionumber};
 555             my $defaultview = C4::Context->preference('IntranetBiblioDefaultView');
 556             my $views = { C4::Search::enabled_staff_search_views };
 557             if ($defaultview eq 'isbd' && $views->{can_view_ISBD}) {
 558                 print $cgi->redirect("/cgi-bin/koha/catalogue/ISBDdetail.pl?biblionumber=$biblionumber");
 559             } elsif  ($defaultview eq 'marc' && $views->{can_view_MARC}) {
 560                 print $cgi->redirect("/cgi-bin/koha/catalogue/MARCdetail.pl?biblionumber=$biblionumber");
 561             } elsif  ($defaultview eq 'labeled_marc' && $views->{can_view_labeledMARC}) {
 562                 print $cgi->redirect("/cgi-bin/koha/catalogue/labeledMARCdetail.pl?biblionumber=$biblionumber");
 563             } else {
 564                 print $cgi->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber");
 565             }
 566             exit;
 567         }
 568
 569         # set up parameters if user wishes to re-run the search
 570         # as a Z39.50 search
 571         $template->param (z3950_search_params => C4::Search::z3950_search_args($z3950par || $query_desc));
 572
 573         if ($hits) {
 574             $template->param(total => $hits);
 575             if ($limit_cgi) {
 576                 my $limit_cgi_not_availablity = $limit_cgi;
 577                 $limit_cgi_not_availablity =~ s/&limit=available//g;
 578                 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
 579             }
 580             $template->param(limit_cgi => $limit_cgi);
 581             $template->param(query_cgi => $query_cgi);
 582             $template->param(query_desc => $query_desc);
 583             $template->param(limit_desc => $limit_desc);
 584             $template->param(offset     => $offset);
 585             $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
 586             if ($query_desc || $limit_desc) {
 587                 $template->param(searchdesc => 1);
 588             }
 589             $template->param(results_per_page =>  $results_per_page);
 590             # must define a value for size if not present in DB
 591             # in order to avoid problems generated by the default size value in TT
 592             foreach my $line (@newresults) {
 593                 if ( not exists $line->{'size'} ) { $line->{'size'} = "" }
 594                 # while we're checking each line, see if item is in the cart
 595                 if ( grep {$_ eq $line->{'biblionumber'}} @cart_list) {
 596                     $line->{'incart'} = 1;
 597                 }
 598             }
 599             $template->param(SEARCH_RESULTS => \@newresults);
 600             ## FIXME: add a global function for this, it's better than the current global one
 601             ## Build the page numbers on the bottom of the page
 602             my @page_numbers;
 603             my $max_result_window = $searcher->max_result_window;
 604             my $hits_to_paginate = ($max_result_window && $max_result_window < $hits) ? $max_result_window : $hits;
 605             $template->param( hits_to_paginate => $hits_to_paginate );
 606             # total number of pages there will be
 607             my $pages = ceil($hits_to_paginate / $results_per_page);
 608             my $last_page_offset = ( $pages -1 ) * $results_per_page;
 609             # default page number
 610             my $current_page_number = 1;
 611             $current_page_number = ($offset / $results_per_page + 1) if $offset;
 612             my $previous_page_offset;
 613             if ( $offset >= $results_per_page ) {
 614                 $previous_page_offset = $offset - $results_per_page;
 615             }
 616             my $next_page_offset = $offset + $results_per_page;
 617             # If we're within the first 10 pages, keep it simple
 618             #warn "current page:".$current_page_number;
 619             if ($current_page_number < 10) {
 620                 # just show the first 10 pages
 621                 # Loop through the pages
 622                 my $pages_to_show = 10;
 623                 $pages_to_show = $pages if $pages<10;
 624                 for (my $i=1; $i<=$pages_to_show;$i++) {
 625                     # the offset for this page
 626                     my $this_offset = (($i*$results_per_page)-$results_per_page);
 627                     # the page number for this page
 628                     my $this_page_number = $i;
 629                     # put it in the array
 630                     push @page_numbers,
 631                       { offset    => $this_offset,
 632                         pg        => $this_page_number,
 633                         # it should only be highlighted if it's the current page
 634                         highlight => $this_page_number == $current_page_number,
 635                         sort_by   => join ' ', @sort_by
 636                       };
 637
 638                 }
 639
 640             }
 641
 642             # now, show twenty pages, with the current one smack in the middle
 643             else {
 644                 for (my $i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
 645                     my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
 646                     my $this_page_number = $i-9;
 647                     if ( $this_page_number <= $pages ) {
 648                         push @page_numbers,
 649                           { offset    => $this_offset,
 650                             pg        => $this_page_number,
 651                             highlight => $this_page_number == $current_page_number,
 652                             sort_by   => join ' ', @sort_by
 653                           };
 654                     }
 655                 }
 656             }
 657             # FIXME: no previous_page_offset when pages < 2
 658             $template->param(   PAGE_NUMBERS => \@page_numbers,
 659                                 last_page_offset => $last_page_offset,
 660                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
 661             $template->param(   next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
 662         }
 663
 664
 665         # no hits
 666         else {
 667             $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
 668         }
 669
 670     } # end of the if local
 671
 672     # asynchronously search the authority server
 673     elsif ($server =~/authorityserver/) { # this is the local authority server
 674         my @inner_sup_results_array;
 675         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
 676             my $marc_record_object = C4::Search::new_record_from_zebra(
 677                 'authorityserver',
 678                 $sup_record
 679             );
 680             # warn "Authority Found: ".$marc_record_object->as_formatted();
 681             push @inner_sup_results_array, {
 682                 'title' => $marc_record_object->field(100)->subfield('a'),
 683                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
 684             };
 685         }
 686         push @sup_results_array, {  servername => $server,
 687                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
 688     }
 689     # FIXME: can add support for other targets as needed here
 690     $template->param(           outer_sup_results_loop => \@sup_results_array);
 691 } #/end of the for loop
 692 #$template->param(FEDERATED_RESULTS => \@results_array);
 693
 694 $template->{'VARS'}->{'searchid'} = $cgi->param('searchid');
 695
 696 my $gotonumber = $cgi->param('gotoNumber');
 697 if ( $gotonumber && ( $gotonumber eq 'last' || $gotonumber eq 'first' ) ) {
 698     $template->{'VARS'}->{'gotoNumber'} = $gotonumber;
 699 }
 700 $template->{'VARS'}->{'gotoPage'}   = 'detail.pl';
 701 my $gotopage = $cgi->param('gotoPage');
 702 $template->{'VARS'}->{'gotoPage'} = $gotopage
 703   if $gotopage && $gotopage =~ m/^(ISBD|labeledMARC|MARC|more)?detail.pl$/;
 704
 705 for my $facet ( @$facets ) {
 706     for my $entry ( @{ $facet->{facets} } ) {
 707         my $index = $entry->{type_link_value};
 708         my $value = $entry->{facet_link_value};
 709         $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
 710     }
 711 }
 712
 713 $template->param(
 714             #classlist => $classlist,
 715             total => $total,
 716             opacfacets => 1,
 717             facets_loop => $facets,
 718             displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
 719             scan => $scan,
 720             search_error => $error,
 721 );
 722
 723 if ($query_desc || $limit_desc) {
 724     $template->param(searchdesc => 1);
 725 }
 726
 727 # VI. BUILD THE TEMPLATE
 728
 729 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
 730     {
 731         borrowernumber => $borrowernumber,
 732         add_allowed    => 1,
 733         category       => 1,
 734     }
 735 );
 736 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 737     {
 738         borrowernumber => $borrowernumber,
 739         add_allowed    => 1,
 740         category       => 2,
 741     }
 742 );
 743
 744
 745 $template->param(
 746     add_to_some_private_shelves => $some_private_shelves,
 747     add_to_some_public_shelves  => $some_public_shelves,
 748 );
 749
 750 output_html_with_http_headers $cgi, $cookie, $template->output;
 751
 752
 753 =head2 prepare_adv_search_types
 754
 755     my $type = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 756     my @advanced_search_types = prepare_adv_search_types($type);
 757
 758 Different types can be searched for in the advanced search. This takes the
 759 system preference that defines these types and parses it into an arrayref for
 760 the template.
 761
 762 "itemtypes" is handled specially, as itemtypes aren't an authorised value.
 763 It also accounts for the "item-level_itypes" system preference.
 764
 765 =cut
 766
 767 sub prepare_adv_search_types {
 768     my ($types) = @_;
 769
 770     my @advanced_search_types = split( /\|/, $types );
 771
 772     # the index parameter is different for item-level itemtypes
 773     my $itype_or_itemtype =
 774       ( C4::Context->preference("item-level_itypes") ) ? 'itype' : 'itemtype';
 775     my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
 776
 777     my ( $cnt, @result );
 778     foreach my $advanced_srch_type (@advanced_search_types) {
 779         $advanced_srch_type =~ s/^\s*//;
 780         $advanced_srch_type =~ s/\s*$//;
 781         if ( $advanced_srch_type eq 'itemtypes' ) {
 782
 783        # itemtype is a special case, since it's not defined in authorized values
 784             my @itypesloop;
 785             foreach my $thisitemtype (
 786                 sort {
 787                     $itemtypes->{$a}->{'translated_description'}
 788                       cmp $itemtypes->{$b}->{'translated_description'}
 789                 } keys %$itemtypes
 790               )
 791             {
 792                 my %row = (
 793                     number      => $cnt++,
 794                     ccl         => "$itype_or_itemtype,phr",
 795                     code        => $thisitemtype,
 796                     description => $itemtypes->{$thisitemtype}->{'translated_description'},
 797                     imageurl    => getitemtypeimagelocation(
 798                         'intranet', $itemtypes->{$thisitemtype}->{'imageurl'}
 799                     ),
 800                 );
 801                 push @itypesloop, \%row;
 802             }
 803             my %search_code = (
 804                 advanced_search_type => $advanced_srch_type,
 805                 code_loop            => \@itypesloop
 806             );
 807             push @result, \%search_code;
 808         }
 809         else {
 810             # covers all the other cases: non-itemtype authorized values
 811             my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
 812             my @authvalueloop;
 813             for my $thisitemtype (@$advsearchtypes) {
 814                 my %row = (
 815                     number      => $cnt++,
 816                     ccl         => $advanced_srch_type,
 817                     code        => $thisitemtype->{authorised_value},
 818                     description => $thisitemtype->{'lib'},
 819                     imageurl    => getitemtypeimagelocation(
 820                         'intranet', $thisitemtype->{'imageurl'}
 821                     ),
 822                 );
 823                 push @authvalueloop, \%row;
 824             }
 825             my %search_code = (
 826                 advanced_search_type => $advanced_srch_type,
 827                 code_loop            => \@authvalueloop
 828             );
 829             push @result, \%search_code;
 830         }
 831     }
 832     return \@result;
 833 }