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 under the
  11 # terms of the GNU General Public License as published by the Free Software
  12 # Foundation; either version 2 of the License, or (at your option) any later
  13 # version.
  14 #
  15 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  16 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  17 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License along
  20 # with Koha; if not, write to the Free Software Foundation, Inc.,
  21 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  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 C4::VirtualShelves;
 151 use URI::Escape;
 152 use POSIX qw(ceil floor);
 153 use String::Random;
 154 use C4::Branch; # GetBranches
 155 use C4::Search::History;
 156
 157 use URI::Escape;
 158
 159 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
 160 # create a new CGI object
 161 # FIXME: no_undef_params needs to be tested
 162 use CGI qw('-no_undef_params');
 163 my $cgi = new CGI;
 164
 165 my ($template,$borrowernumber,$cookie);
 166 # decide which template to use
 167 my $template_name;
 168 my $template_type;
 169 my @params = $cgi->param("limit");
 170 if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
 171     $template_name = 'catalogue/results.tmpl';
 172 }
 173 else {
 174     $template_name = 'catalogue/advsearch.tmpl';
 175     $template_type = 'advsearch';
 176 }
 177 # load the template
 178 my ($template, $borrowernumber, $cookie) = get_template_and_user({
 179     template_name => $template_name,
 180     query => $cgi,
 181     type => "intranet",
 182     authnotrequired => 0,
 183     flagsrequired   => { catalogue => 1 },
 184     }
 185 );
 186
 187 my $lang = C4::Languages::getlanguage($cgi);
 188
 189 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
 190     $template->param('UNIMARC' => 1);
 191 }
 192 if (C4::Context->preference("IntranetNumbersPreferPhrase")) {
 193     $template->param('numbersphr' => 1);
 194 }
 195
 196 if($cgi->cookie("holdfor")){
 197     my $holdfor_patron = GetMember('borrowernumber' => $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 ## URI Re-Writing
 207 # Deprecated, but preserved because it's interesting :-)
 208 # The same thing can be accomplished with mod_rewrite in
 209 # a more elegant way
 210 #
 211 #my $rewrite_flag;
 212 #my $uri = $cgi->url(-base => 1);
 213 #my $relative_url = $cgi->url(-relative=>1);
 214 #$uri.="/".$relative_url."?";
 215 #warn "URI:$uri";
 216 #my @cgi_params_list = $cgi->param();
 217 #my $url_params = $cgi->Vars;
 218 #
 219 #for my $each_param_set (@cgi_params_list) {
 220 #    $uri.= join "",  map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
 221 #}
 222 #warn "New URI:$uri";
 223 # Only re-write a URI if there are params or if it already hasn't been re-written
 224 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
 225 #    print $cgi->redirect(     -uri=>$uri."&r=1",
 226 #                            -cookie => $cookie);
 227 #    exit;
 228 #}
 229
 230 # load the branches
 231 my $branches = GetBranches();
 232
 233 # Populate branch_loop with all branches sorted by their name.  If
 234 # IndependentBranches is activated, set the default branch to the borrower
 235 # branch, except for superlibrarian who need to search all libraries.
 236 my $user = C4::Context->userenv;
 237 my @branch_loop = map {
 238      {
 239         value      => $_,
 240         branchname => $branches->{$_}->{branchname},
 241         selected   => $user->{branch} eq $_ && C4::Branch::onlymine(),
 242      }
 243 } sort {
 244     $branches->{$a}->{branchname} cmp $branches->{$b}->{branchname}
 245 } keys %$branches;
 246
 247 my $categories = GetBranchCategories('searchdomain');
 248
 249 $template->param(branchloop => \@branch_loop, searchdomainloop => $categories);
 250
 251 # load the Type stuff
 252 my $itemtypes = GetItemTypes;
 253 # the index parameter is different for item-level itemtypes
 254 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
 255 my @advancedsearchesloop;
 256 my $cnt;
 257 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 258 my @advanced_search_types = split(/\|/, $advanced_search_types);
 259
 260 foreach my $advanced_srch_type (@advanced_search_types) {
 261    if ($advanced_srch_type eq 'itemtypes') {
 262    # itemtype is a special case, since it's not defined in authorized values
 263         my @itypesloop;
 264         foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
 265             my %row =(  number=>$cnt++,
 266                 ccl => "$itype_or_itemtype,phr",
 267                 code => $thisitemtype,
 268                 description => $itemtypes->{$thisitemtype}->{'description'},
 269                 imageurl=> getitemtypeimagelocation( 'intranet', $itemtypes->{$thisitemtype}->{'imageurl'} ),
 270             );
 271             push @itypesloop, \%row;
 272         }
 273         my %search_code = (  advanced_search_type => $advanced_srch_type,
 274                              code_loop => \@itypesloop );
 275         push @advancedsearchesloop, \%search_code;
 276     } else {
 277     # covers all the other cases: non-itemtype authorized values
 278        my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
 279         my @authvalueloop;
 280         for my $thisitemtype (@$advsearchtypes) {
 281                 my %row =(
 282                                 number=>$cnt++,
 283                                 ccl => $advanced_srch_type,
 284                 code => $thisitemtype->{authorised_value},
 285                 description => $thisitemtype->{'lib'},
 286                 imageurl => getitemtypeimagelocation( 'intranet', $thisitemtype->{'imageurl'} ),
 287                 );
 288                 push @authvalueloop, \%row;
 289         }
 290         my %search_code = (  advanced_search_type => $advanced_srch_type,
 291                              code_loop => \@authvalueloop );
 292         push @advancedsearchesloop, \%search_code;
 293     }
 294 }
 295 $template->param(advancedsearchesloop => \@advancedsearchesloop);
 296
 297 # The following should only be loaded if we're bringing up the advanced search template
 298 if ( $template_type eq 'advsearch' ) {
 299
 300     # load the servers (used for searching -- to do federated searching, etc.)
 301     my $primary_servers_loop;# = displayPrimaryServers();
 302     $template->param(outer_servers_loop =>  $primary_servers_loop,);
 303
 304     my $secondary_servers_loop;
 305     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 306
 307     # set the default sorting
 308     if (   C4::Context->preference('OPACdefaultSortField')
 309         && C4::Context->preference('OPACdefaultSortOrder') ) {
 310         my $default_sort_by =
 311             C4::Context->preference('defaultSortField') . '_'
 312           . C4::Context->preference('defaultSortOrder');
 313         $template->param( sort_by => $default_sort_by  );
 314     }
 315
 316     # determine what to display next to the search boxes (ie, boolean option
 317     # shouldn't appear on the first one, scan indexes should, adding a new
 318     # box should only appear on the last, etc.
 319     my @search_boxes_array;
 320     my $search_boxes_count = 3; # begin whith 3 boxes
 321     # FIXME: all this junk can be done in TMPL using __first__ and __last__
 322     for (my $i=1;$i<=$search_boxes_count;$i++) {
 323         # if it's the first one, don't display boolean option, but show scan indexes
 324         if ($i==1) {
 325             push @search_boxes_array, {scan_index => 1};
 326         }
 327         # if it's the last one, show the 'add field' box
 328         elsif ($i==$search_boxes_count) {
 329             push @search_boxes_array,
 330                 {
 331                 boolean => 1,
 332                 add_field => 1,
 333                 };
 334         }
 335         else {
 336             push @search_boxes_array,
 337                 {
 338                 boolean => 1,
 339                 };
 340         }
 341
 342     }
 343     $template->param(uc(C4::Context->preference("marcflavour")) => 1,
 344                       search_boxes_loop => \@search_boxes_array);
 345
 346     # load the language limits (for search)
 347     my $languages_limit_loop = getLanguages($lang, 1);
 348     $template->param(search_languages_loop => $languages_limit_loop,);
 349
 350     # Expanded search options in advanced search:
 351     # use the global setting by default, but let the user override it
 352     {
 353         my $expanded = $cgi->param('expanded_options');
 354         $expanded = C4::Context->preference("expandedSearchOption") || 0
 355             if !defined($expanded) || $expanded !~ /^0|1$/;
 356         $template->param( expanded_options => $expanded );
 357     }
 358
 359     $template->param(virtualshelves => C4::Context->preference("virtualshelves"));
 360
 361     output_html_with_http_headers $cgi, $cookie, $template->output;
 362     exit;
 363 }
 364
 365 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
 366
 367 # Fetch the paramater list as a hash in scalar context:
 368 #  * returns paramater list as tied hash ref
 369 #  * we can edit the values by changing the key
 370 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 371 my $params = $cgi->Vars;
 372
 373 # Params that can have more than one value
 374 # sort by is used to sort the query
 375 # in theory can have more than one but generally there's just one
 376 my @sort_by;
 377 my $default_sort_by;
 378 if (   C4::Context->preference('defaultSortField')
 379     && C4::Context->preference('defaultSortOrder') ) {
 380     $default_sort_by =
 381         C4::Context->preference('defaultSortField') . '_'
 382       . C4::Context->preference('defaultSortOrder');
 383 }
 384
 385 @sort_by = $cgi->param('sort_by');
 386 $sort_by[0] = $default_sort_by unless $sort_by[0];
 387 foreach my $sort (@sort_by) {
 388     $template->param($sort => 1) if $sort;
 389 }
 390 $template->param('sort_by' => $sort_by[0]);
 391
 392 # Use the servers defined, or just search our local catalog(default)
 393 my @servers = $cgi->param('server');
 394 unless (@servers) {
 395     #FIXME: this should be handled using Context.pm
 396     @servers = ("biblioserver");
 397     # @servers = C4::Context->config("biblioserver");
 398 }
 399 # operators include boolean and proximity operators and are used
 400 # to evaluate multiple operands
 401 my @operators = map uri_unescape($_), $cgi->param('op');
 402
 403 # indexes are query qualifiers, like 'title', 'author', etc. They
 404 # can be single or multiple parameters separated by comma: kw,right-Truncation
 405 my @indexes = map uri_unescape($_), $cgi->param('idx');
 406
 407 # if a simple index (only one)  display the index used in the top search box
 408 if ($indexes[0] && (!$indexes[1] || $params->{'scan'})) {
 409     my $idx = "ms_".$indexes[0];
 410     $idx =~ s/\,/comma/g;  # template toolkit doesnt like variables with a , in it
 411     $template->param($idx => 1);
 412 }
 413
 414 # an operand can be a single term, a phrase, or a complete ccl query
 415 my @operands = map uri_unescape($_), $cgi->param('q');
 416
 417 # limits are use to limit to results to a pre-defined category such as branch or language
 418 my @limits = map uri_unescape($_), $cgi->param('limit');
 419 my @nolimits = map uri_unescape($_), $cgi->param('nolimit');
 420 my %is_nolimit = map { $_ => 1 } @nolimits;
 421 @limits = grep { not $is_nolimit{$_} } @limits;
 422
 423 if($params->{'multibranchlimit'}) {
 424     my $multibranch = '('.join( " or ", map { "branch: $_ " } @{ GetBranchesInCategory( $params->{'multibranchlimit'} ) } ).')';
 425     push @limits, $multibranch if ($multibranch ne  '()');
 426 }
 427
 428 my $available;
 429 foreach my $limit(@limits) {
 430     if ($limit =~/available/) {
 431         $available = 1;
 432     }
 433 }
 434 $template->param(available => $available);
 435
 436 # append year limits if they exist
 437 my $limit_yr;
 438 my $limit_yr_value;
 439 if ($params->{'limit-yr'}) {
 440     if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
 441         my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
 442         $limit_yr = "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
 443         $limit_yr_value = "$yr1-$yr2";
 444     }
 445     elsif ($params->{'limit-yr'} =~ /\d{4}/) {
 446         $limit_yr = "yr,st-numeric=$params->{'limit-yr'}";
 447         $limit_yr_value = $params->{'limit-yr'};
 448     }
 449     push @limits,$limit_yr;
 450     #FIXME: Should return a error to the user, incorect date format specified
 451 }
 452
 453 # convert indexes and operands to corresponding parameter names for the z3950 search
 454 # $ %z3950p will be a hash ref if the indexes are present (advacned search), otherwise undef
 455 my $z3950par;
 456 my $indexes2z3950 = {
 457     kw=>'title', au=>'author', 'au,phr'=>'author', nb=>'isbn', ns=>'issn',
 458     'lcn,phr'=>'dewey', su=>'subject', 'su,phr'=>'subject',
 459     ti=>'title', 'ti,phr'=>'title', se=>'title'
 460 };
 461 for (my $ii = 0; $ii < @operands; ++$ii)
 462 {
 463     my $name = $indexes2z3950->{$indexes[$ii] || 'kw'};
 464     if (defined $name && defined $operands[$ii])
 465     {
 466         $z3950par ||= {};
 467         $z3950par->{$name} = $operands[$ii] if !exists $z3950par->{$name};
 468     }
 469 }
 470
 471
 472 # Params that can only have one value
 473 my $scan = $params->{'scan'};
 474 my $count = C4::Context->preference('numSearchResults') || 20;
 475 my $results_per_page = $params->{'count'} || $count;
 476 my $offset = $params->{'offset'} || 0;
 477 my $page = $cgi->param('page') || 1;
 478 #my $offset = ($page-1)*$results_per_page;
 479 my $hits;
 480 my $expanded_facet = $params->{'expand'};
 481
 482 # Define some global variables
 483 my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
 484
 485 my @results;
 486
 487 ## I. BUILD THE QUERY
 488 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by,$scan,$lang);
 489
 490 ## parse the query_cgi string and put it into a form suitable for <input>s
 491 my @query_inputs;
 492 my $scan_index_to_use;
 493
 494 for my $this_cgi ( split('&',$query_cgi) ) {
 495     next unless $this_cgi;
 496     $this_cgi =~ m/(.*?)=(.*)/;
 497     my $input_name = $1;
 498     my $input_value = $2;
 499     push @query_inputs, { input_name => $input_name, input_value => $input_value };
 500     if ($input_name eq 'idx') {
 501         $scan_index_to_use = $input_value; # unless $scan_index_to_use;
 502     }
 503 }
 504 $template->param ( QUERY_INPUTS => \@query_inputs,
 505                    scan_index_to_use => $scan_index_to_use );
 506
 507 ## parse the limit_cgi string and put it into a form suitable for <input>s
 508 my @limit_inputs;
 509 for my $this_cgi ( split('&',$limit_cgi) ) {
 510     next unless $this_cgi;
 511     # handle special case limit-yr
 512     if ($this_cgi =~ /yr,st-numeric/) {
 513         push @limit_inputs, { input_name => 'limit-yr', input_value => $limit_yr_value };
 514         next;
 515     }
 516     $this_cgi =~ m/(.*=)(.*)/;
 517     my $input_name = $1;
 518     my $input_value = $2;
 519     $input_name =~ s/=$//;
 520     push @limit_inputs, { input_name => $input_name, input_value => uri_unescape($input_value) };
 521 }
 522 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 523
 524 ## II. DO THE SEARCH AND GET THE RESULTS
 525 my $total; # the total results for the whole set
 526 my $facets; # this object stores the faceted results that display on the left-hand of the results page
 527 my @results_array;
 528 my $results_hashref;
 529
 530 eval {
 531     ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$itemtypes,$query_type,$scan);
 532 };
 533
 534 # This sorts the facets into alphabetical order
 535 if ($facets) {
 536     foreach my $f (@$facets) {
 537         $f->{facets} = [ sort { uc($a->{facet_title_value}) cmp uc($b->{facet_title_value}) } @{ $f->{facets} } ];
 538     }
 539 }
 540 if ($@ || $error) {
 541     $template->param(query_error => $error.$@);
 542     output_html_with_http_headers $cgi, $cookie, $template->output;
 543     exit;
 544 }
 545
 546 # At this point, each server has given us a result set
 547 # now we build that set for template display
 548 my @sup_results_array;
 549 for (my $i=0;$i<@servers;$i++) {
 550     my $server = $servers[$i];
 551     if ($server =~/biblioserver/) { # this is the local bibliographic server
 552         $hits = $results_hashref->{$server}->{"hits"};
 553         my $page = $cgi->param('page') || 0;
 554         my @newresults = searchResults('intranet', $query_desc, $hits, $results_per_page, $offset, $scan,
 555                                        $results_hashref->{$server}->{"RECORDS"});
 556         $total = $total + $results_hashref->{$server}->{"hits"};
 557
 558         # Search history
 559         if (C4::Context->preference('EnableSearchHistory')) {
 560             unless ( $offset ) {
 561                 my $path_info = $cgi->url(-path_info=>1);
 562                 my $query_cgi_history = $cgi->url(-query=>1);
 563                 $query_cgi_history =~ s/^$path_info\?//;
 564                 $query_cgi_history =~ s/;/&/g;
 565                 my $query_desc_history = $query_desc;
 566                 $query_desc_history .= ", $limit_desc"
 567                     if $limit_desc;
 568
 569                 C4::Search::History::add({
 570                     userid => $borrowernumber,
 571                     sessionid => $cgi->cookie("CGISESSID"),
 572                     query_desc => $query_desc_history,
 573                     query_cgi => $query_cgi_history,
 574                     total => $total,
 575                     type => "biblio",
 576                 });
 577             }
 578             $template->param( EnableSearchHistory => 1 );
 579         }
 580
 581         ## If there's just one result, redirect to the detail page
 582         if ($total == 1) {
 583             my $biblionumber = $newresults[0]->{biblionumber};
 584             my $defaultview = C4::Context->preference('IntranetBiblioDefaultView');
 585             my $views = { C4::Search::enabled_staff_search_views };
 586             if ($defaultview eq 'isbd' && $views->{can_view_ISBD}) {
 587                 print $cgi->redirect("/cgi-bin/koha/catalogue/ISBDdetail.pl?biblionumber=$biblionumber");
 588             } elsif  ($defaultview eq 'marc' && $views->{can_view_MARC}) {
 589                 print $cgi->redirect("/cgi-bin/koha/catalogue/MARCdetail.pl?biblionumber=$biblionumber");
 590             } elsif  ($defaultview eq 'labeled_marc' && $views->{can_view_labeledMARC}) {
 591                 print $cgi->redirect("/cgi-bin/koha/catalogue/labeledMARCdetail.pl?biblionumber=$biblionumber");
 592             } else {
 593                 print $cgi->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber");
 594             }
 595             exit;
 596         }
 597
 598         # set up parameters if user wishes to re-run the search
 599         # as a Z39.50 search
 600         $template->param (z3950_search_params => C4::Search::z3950_search_args($z3950par || $query_desc));
 601
 602         if ($hits) {
 603             $template->param(total => $hits);
 604             my $limit_cgi_not_availablity = $limit_cgi;
 605             $limit_cgi_not_availablity =~ s/&limit=available//g;
 606             $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
 607             $template->param(limit_cgi => $limit_cgi);
 608             $template->param(query_cgi => $query_cgi);
 609             $template->param(query_desc => $query_desc);
 610             $template->param(limit_desc => $limit_desc);
 611             $template->param(offset     => $offset);
 612             $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
 613             if ($query_desc || $limit_desc) {
 614                 $template->param(searchdesc => 1);
 615             }
 616             $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
 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             }
 623             $template->param(SEARCH_RESULTS => \@newresults);
 624             ## FIXME: add a global function for this, it's better than the current global one
 625             ## Build the page numbers on the bottom of the page
 626             my @page_numbers;
 627             # total number of pages there will be
 628             my $pages = ceil($hits / $results_per_page);
 629             # default page number
 630             my $current_page_number = 1;
 631             $current_page_number = ($offset / $results_per_page + 1) if $offset;
 632             my $previous_page_offset;
 633             if ( $offset >= $results_per_page ) {
 634                 $previous_page_offset = $offset - $results_per_page;
 635             }
 636             my $next_page_offset = $offset + $results_per_page;
 637             # If we're within the first 10 pages, keep it simple
 638             #warn "current page:".$current_page_number;
 639             if ($current_page_number < 10) {
 640                 # just show the first 10 pages
 641                 # Loop through the pages
 642                 my $pages_to_show = 10;
 643                 $pages_to_show = $pages if $pages<10;
 644                 for (my $i=1; $i<=$pages_to_show;$i++) {
 645                     # the offset for this page
 646                     my $this_offset = (($i*$results_per_page)-$results_per_page);
 647                     # the page number for this page
 648                     my $this_page_number = $i;
 649                     # put it in the array
 650                     push @page_numbers,
 651                       { offset    => $this_offset,
 652                         pg        => $this_page_number,
 653                         # it should only be highlighted if it's the current page
 654                         highlight => $this_page_number == $current_page_number,
 655                         sort_by   => join ' ', @sort_by
 656                       };
 657
 658                 }
 659
 660             }
 661
 662             # now, show twenty pages, with the current one smack in the middle
 663             else {
 664                 for (my $i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
 665                     my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
 666                     my $this_page_number = $i-9;
 667                     if ( $this_page_number <= $pages ) {
 668                         push @page_numbers,
 669                           { offset    => $this_offset,
 670                             pg        => $this_page_number,
 671                             highlight => $this_page_number == $current_page_number,
 672                             sort_by   => join ' ', @sort_by
 673                           };
 674                     }
 675                 }
 676             }
 677             # FIXME: no previous_page_offset when pages < 2
 678             $template->param(   PAGE_NUMBERS => \@page_numbers,
 679                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
 680             $template->param(   next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
 681         }
 682
 683
 684         # no hits
 685         else {
 686             $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
 687         }
 688
 689     } # end of the if local
 690
 691     # asynchronously search the authority server
 692     elsif ($server =~/authorityserver/) { # this is the local authority server
 693         my @inner_sup_results_array;
 694         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
 695             my $marc_record_object = C4::Search::new_record_from_zebra(
 696                 'authorityserver',
 697                 $sup_record
 698             );
 699             # warn "Authority Found: ".$marc_record_object->as_formatted();
 700             push @inner_sup_results_array, {
 701                 'title' => $marc_record_object->field(100)->subfield('a'),
 702                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
 703             };
 704         }
 705         push @sup_results_array, {  servername => $server,
 706                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
 707     }
 708     # FIXME: can add support for other targets as needed here
 709     $template->param(           outer_sup_results_loop => \@sup_results_array);
 710 } #/end of the for loop
 711 #$template->param(FEDERATED_RESULTS => \@results_array);
 712
 713 $template->{'VARS'}->{'searchid'} = $cgi->param('searchid');
 714
 715 my $gotonumber = $cgi->param('gotoNumber');
 716 if ($gotonumber eq 'last' || $gotonumber eq 'first') {
 717     $template->{'VARS'}->{'gotoNumber'} = $gotonumber;
 718 }
 719 $template->{'VARS'}->{'gotoPage'}   = 'detail.pl';
 720 my $gotopage = $cgi->param('gotoPage');
 721 $template->{'VARS'}->{'gotoPage'} = $gotopage
 722   if $gotopage =~ m/^(ISBD|labeledMARC|MARC|more)?detail.pl$/;
 723
 724 my @input_values = map { Encode::decode_utf8($_->{input_value}) } @limit_inputs;
 725 for my $facet ( @$facets ) {
 726     for my $entry ( @{ $facet->{facets} } ) {
 727         my $index = $entry->{type_link_value};
 728         my $value = $entry->{facet_link_value};
 729         $entry->{active} = grep { $_ eq qq{$index:$value} } @input_values;
 730     }
 731 }
 732
 733 $template->param(
 734             #classlist => $classlist,
 735             total => $total,
 736             opacfacets => 1,
 737             facets_loop => $facets,
 738             displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
 739             scan => $scan,
 740             search_error => $error,
 741 );
 742
 743 if ($query_desc || $limit_desc) {
 744     $template->param(searchdesc => 1);
 745 }
 746
 747 # VI. BUILD THE TEMPLATE
 748
 749 # Build drop-down list for 'Add To:' menu...
 750 my ($totalref, $pubshelves, $barshelves)=
 751         C4::VirtualShelves::GetSomeShelfNames($borrowernumber,'COMBO',1);
 752 $template->param(
 753         addbarshelves     => $totalref->{bartotal},
 754         addbarshelvesloop => $barshelves,
 755         addpubshelves     => $totalref->{pubtotal},
 756         addpubshelvesloop => $pubshelves,
 757         );
 758
 759 output_html_with_http_headers $cgi, $cookie, $template->output;