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