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