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