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