catalogue/search.pl

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