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 #
   7 # This file is part of Koha
   8 #
   9 # Koha is free software; you can redistribute it and/or modify it under the
  10 # terms of the GNU General Public License as published by the Free Software
  11 # Foundation; either version 2 of the License, or (at your option) any later
  12 # version.
  13 #
  14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License along with
  19 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  20 # Suite 330, Boston, MA  02111-1307 USA
  21
  22 =head1 NAME
  23
  24 search - a search script for finding records in a Koha system (Version 3)
  25
  26 =head1 OVERVIEW
  27
  28 This script utilizes a new search API for Koha 3. It is designed to be
  29 simple to use and configure, yet capable of performing feats like stemming,
  30 field weighting, relevance ranking, support for multiple  query language
  31 formats (CCL, CQL, PQF), full support for the bib1 attribute set, extended
  32 attribute sets defined in Zebra profiles, access to the full range of Z39.50
  33 and SRU query options, federated searches on Z39.50/SRU targets, etc.
  34
  35 The API as represented in this script is mostly sound, even if the individual
  36 functions in Search.pm and Koha.pm need to be cleaned up. Of course, you are
  37 free to disagree :-)
  38
  39 I will attempt to describe what is happening at each part of this script.
  40 -- Joshua Ferraro <jmf AT liblime DOT com>
  41
  42 =head2 INTRO
  43
  44 This script performs two functions:
  45
  46 =over
  47
  48 =item 1. interacts with Koha to retrieve and display the results of a search
  49
  50 =item 2. loads the advanced search page
  51
  52 =back
  53
  54 These two functions share many of the same variables and modules, so the first
  55 task is to load what they have in common and determine which template to use.
  56 Once determined, proceed to only load the variables and procedures necessary
  57 for that function.
  58
  59 =head2 LOADING ADVANCED SEARCH PAGE
  60
  61 This is fairly straightforward, and I won't go into detail ;-)
  62
  63 =head2 PERFORMING A SEARCH
  64
  65 If we're performing a search, this script  performs three primary
  66 operations:
  67
  68 =over
  69
  70 =item 1. builds query strings (yes, plural)
  71
  72 =item 2. perform the search and return the results array
  73
  74 =item 3. build the HTML for output to the template
  75
  76 =back
  77
  78 There are several additional secondary functions performed that I will
  79 not cover in detail.
  80
  81 =head3 1. Building Query Strings
  82
  83 There are several types of queries needed in the process of search and retrieve:
  84
  85 =over
  86
  87 =item 1 $query - the fully-built query passed to zebra
  88
  89 This is the most complex query that needs to be built. The original design goal
  90 was to use a custom CCL2PQF query parser to translate an incoming CCL query into
  91 a multi-leaf query to pass to Zebra. It needs to be multi-leaf to allow field
  92 weighting, koha-specific relevance ranking, and stemming. When I have a chance
  93 I'll try to flesh out this section to better explain.
  94
  95 This query incorporates query profiles that aren't compatible with most non-Zebra
  96 Z39.50 targets to acomplish the field weighting and relevance ranking.
  97
  98 =item 2 $simple_query - a simple query that doesn't contain the field weighting,
  99 stemming, etc., suitable to pass off to other search targets
 100
 101 This query is just the user's query expressed in CCL CQL, or PQF for passing to a
 102 non-zebra Z39.50 target (one that doesn't support the extended profile that Zebra does).
 103
 104 =item 3 $query_cgi - passed to the template / saved for future refinements of
 105 the query (by user)
 106
 107 This is a simple string that completely expresses the query as a CGI string that
 108 can be used for future refinements of the query or as a part of a history feature.
 109
 110 =item 4 $query_desc - Human search description - what the user sees in search
 111 feedback area
 112
 113 This is a simple string that is human readable. It will contain '=', ',', etc.
 114
 115 =back
 116
 117 =head3 2. Perform the Search
 118
 119 This section takes the query strings and performs searches on the named servers,
 120 including the Koha Zebra server, stores the results in a deeply nested object,
 121 builds 'faceted results', and returns these objects.
 122
 123 =head3 3. Build HTML
 124
 125 The final major section of this script takes the objects collected thusfar and
 126 builds the HTML for output to the template and user.
 127
 128 =head3 Additional Notes
 129
 130 Not yet completed...
 131
 132 =cut
 133
 134 use strict;            # always use
 135
 136 ## STEP 1. Load things that are used in both search page and
 137 # results page and decide which template to load, operations
 138 # to perform, etc.
 139
 140 ## load Koha modules
 141 use C4::Context;
 142 use C4::Output;
 143 use C4::Auth;
 144 use C4::Search;
 145 use C4::Languages qw(getAllLanguages);
 146 use C4::Koha;
 147 use POSIX qw(ceil floor);
 148 use C4::Branch; # GetBranches
 149
 150 # create a new CGI object
 151 # FIXME: no_undef_params needs to be tested
 152 use CGI qw('-no_undef_params');
 153 my $cgi = new CGI;
 154
 155 my ($template,$borrowernumber,$cookie);
 156
 157 # decide which template to use
 158 my $template_name;
 159 my $template_type;
 160 my @params = $cgi->param("limit");
 161 if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
 162     $template_name = 'catalogue/results.tmpl';
 163 }
 164 else {
 165     $template_name = 'catalogue/advsearch.tmpl';
 166     $template_type = 'advsearch';
 167 }
 168 # load the template
 169 ($template, $borrowernumber, $cookie) = get_template_and_user({
 170     template_name => $template_name,
 171     query => $cgi,
 172     type => "intranet",
 173     authnotrequired => 0,
 174     flagsrequired   => { catalogue => 1 },
 175     }
 176 );
 177 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
 178     $template->param('UNIMARC' => 1);
 179 }
 180
 181 ## URI Re-Writing
 182 # Deprecated, but preserved because it's interesting :-)
 183 # The same thing can be accomplished with mod_rewrite in
 184 # a more elegant way
 185 #
 186 #my $rewrite_flag;
 187 #my $uri = $cgi->url(-base => 1);
 188 #my $relative_url = $cgi->url(-relative=>1);
 189 #$uri.="/".$relative_url."?";
 190 #warn "URI:$uri";
 191 #my @cgi_params_list = $cgi->param();
 192 #my $url_params = $cgi->Vars;
 193 #
 194 #for my $each_param_set (@cgi_params_list) {
 195 #    $uri.= join "",  map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
 196 #}
 197 #warn "New URI:$uri";
 198 # Only re-write a URI if there are params or if it already hasn't been re-written
 199 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
 200 #    print $cgi->redirect(     -uri=>$uri."&r=1",
 201 #                            -cookie => $cookie);
 202 #    exit;
 203 #}
 204
 205 # load the branches
 206 my $branches = GetBranches();
 207 my @branch_loop;
 208
 209 for my $branch_hash (sort { $branches->{$a}->{branchname} cmp $branches->{$b}->{branchname} } keys %$branches) {
 210     push @branch_loop, {value => "$branch_hash" , branchname => $branches->{$branch_hash}->{'branchname'}, };
 211 }
 212
 213 my $categories = GetBranchCategories(undef,'searchdomain');
 214
 215 $template->param(branchloop => \@branch_loop, searchdomainloop => $categories);
 216
 217 # load the Type stuff
 218 # load the Type stuff
 219 my $itemtypes = GetItemTypes;
 220 # the index parameter is different for item-level itemtypes
 221 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
 222 my @itemtypesloop;
 223 my $selected=1;
 224 my $cnt;
 225 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes");
 226
 227 if (!$advanced_search_types or $advanced_search_types eq 'itemtypes') {                                                                 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
 228     my %row =(  number=>$cnt++,
 229                 ccl => $itype_or_itemtype,
 230                 code => $thisitemtype,
 231                 selected => $selected,
 232                 description => $itemtypes->{$thisitemtype}->{'description'},
 233                 count5 => $cnt % 4,
 234                 imageurl=> getitemtypeimagelocation( 'intranet', $itemtypes->{$thisitemtype}->{'imageurl'} ),
 235             );
 236         $selected = 0 if ($selected) ;
 237         push @itemtypesloop, \%row;
 238     }
 239     $template->param(itemtypeloop => \@itemtypesloop);
 240 } else {
 241     my $advsearchtypes = GetAuthorisedValues($advanced_search_types);
 242     for my $thisitemtype (sort {$a->{'lib'} cmp $b->{'lib'}} @$advsearchtypes) {
 243         my %row =(
 244                 number=>$cnt++,
 245                 ccl => $advanced_search_types,
 246                 code => $thisitemtype->{authorised_value},
 247                 selected => $selected,
 248                 description => $thisitemtype->{'lib'},
 249                 count5 => $cnt % 4,
 250                 imageurl=> getitemtypeimagelocation( 'intranet', $thisitemtype->{'imageurl'} ),
 251             );
 252         push @itemtypesloop, \%row;
 253     }
 254     $template->param(itemtypeloop => \@itemtypesloop);
 255 }
 256
 257 # The following should only be loaded if we're bringing up the advanced search template
 258 if ( $template_type eq 'advsearch' ) {
 259
 260     # load the servers (used for searching -- to do federated searching, etc.)
 261     my $primary_servers_loop;# = displayPrimaryServers();
 262     $template->param(outer_servers_loop =>  $primary_servers_loop,);
 263
 264     my $secondary_servers_loop;
 265     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 266
 267     # set the default sorting
 268     my $default_sort_by = C4::Context->preference('defaultSortField')."_".C4::Context->preference('defaultSortOrder')
 269         if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
 270     $template->param($default_sort_by => 1);
 271
 272     # determine what to display next to the search boxes (ie, boolean option
 273     # shouldn't appear on the first one, scan indexes should, adding a new
 274     # box should only appear on the last, etc.
 275     my @search_boxes_array;
 276     my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") || 3; # FIXME: using OPAC sysprefs?
 277     # FIXME: all this junk can be done in TMPL using __first__ and __last__
 278     for (my $i=1;$i<=$search_boxes_count;$i++) {
 279         # if it's the first one, don't display boolean option, but show scan indexes
 280         if ($i==1) {
 281             push @search_boxes_array, {scan_index => 1};
 282         }
 283         # if it's the last one, show the 'add field' box
 284         elsif ($i==$search_boxes_count) {
 285             push @search_boxes_array,
 286                 {
 287                 boolean => 1,
 288                 add_field => 1,
 289                 };
 290         }
 291         else {
 292             push @search_boxes_array,
 293                 {
 294                 boolean => 1,
 295                 };
 296         }
 297
 298     }
 299     $template->param(uc(C4::Context->preference("marcflavour")) => 1,
 300                       search_boxes_loop => \@search_boxes_array);
 301
 302     # load the language limits (for search)
 303     my $languages_limit_loop = getAllLanguages();
 304     $template->param(search_languages_loop => $languages_limit_loop,);
 305
 306     # use the global setting by default
 307     if ( C4::Context->preference("expandedSearchOption") == 1) {
 308         $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
 309     }
 310     # but let the user override it
 311     if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
 312         $template->param( expanded_options => $cgi->param('expanded_options'));
 313     }
 314
 315     output_html_with_http_headers $cgi, $cookie, $template->output;
 316     exit;
 317 }
 318
 319 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
 320
 321 # Fetch the paramater list as a hash in scalar context:
 322 #  * returns paramater list as tied hash ref
 323 #  * we can edit the values by changing the key
 324 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 325 my $params = $cgi->Vars;
 326
 327 # Params that can have more than one value
 328 # sort by is used to sort the query
 329 # in theory can have more than one but generally there's just one
 330 my @sort_by;
 331 my $default_sort_by = C4::Context->preference('defaultSortField')."_".C4::Context->preference('defaultSortOrder')
 332     if (C4::Context->preference('defaultSortField') && C4::Context->preference('defaultSortOrder'));
 333
 334 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
 335 $sort_by[0] = $default_sort_by unless $sort_by[0];
 336 foreach my $sort (@sort_by) {
 337     $template->param($sort => 1);
 338 }
 339 $template->param('sort_by' => $sort_by[0]);
 340
 341 # Use the servers defined, or just search our local catalog(default)
 342 my @servers;
 343 @servers = split("\0",$params->{'server'}) if $params->{'server'};
 344 unless (@servers) {
 345     #FIXME: this should be handled using Context.pm
 346     @servers = ("biblioserver");
 347     # @servers = C4::Context->config("biblioserver");
 348 }
 349 # operators include boolean and proximity operators and are used
 350 # to evaluate multiple operands
 351 my @operators;
 352 @operators = split("\0",$params->{'op'}) if $params->{'op'};
 353
 354 # indexes are query qualifiers, like 'title', 'author', etc. They
 355 # can be single or multiple parameters separated by comma: kw,right-Truncation
 356 my @indexes;
 357 @indexes = split("\0",$params->{'idx'});
 358
 359 # if a simple index (only one)  display the index used in the top search box
 360 if ($indexes[0] && !$indexes[1]) {
 361     $template->param("ms_".$indexes[0] => 1);}
 362
 363
 364 # an operand can be a single term, a phrase, or a complete ccl query
 365 my @operands;
 366 @operands = split("\0",$params->{'q'}) if $params->{'q'};
 367
 368 # limits are use to limit to results to a pre-defined category such as branch or language
 369 my @limits;
 370 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
 371
 372 if($params->{'multibranchlimit'}) {
 373 push @limits, join(" or ", map { "branch: $_ "}  @{GetBranchesInCategory($params->{'multibranchlimit'})}) ;
 374 }
 375
 376 my $available;
 377 foreach my $limit(@limits) {
 378     if ($limit =~/available/) {
 379         $available = 1;
 380     }
 381 }
 382 $template->param(available => $available);
 383
 384 # append year limits if they exist
 385 my $limit_yr;
 386 my $limit_yr_value;
 387 if ($params->{'limit-yr'}) {
 388     if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
 389         my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
 390         $limit_yr = "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
 391         $limit_yr_value = "$yr1-$yr2";
 392     }
 393     elsif ($params->{'limit-yr'} =~ /\d{4}/) {
 394         $limit_yr = "yr,st-numeric=$params->{'limit-yr'}";
 395         $limit_yr_value = $params->{'limit-yr'};
 396     }
 397     push @limits,$limit_yr;
 398     #FIXME: Should return a error to the user, incorect date format specified
 399 }
 400
 401 # convert indexes and operands to corresponding parameter names for the z3950 search
 402 # $ %z3950p will be a hash ref if the indexes are present (advacned search), otherwise undef
 403 my $z3950par;
 404 my $indexes2z3950 = {
 405         kw=>'title', au=>'author', 'au,phr'=>'author', nb=>'isbn', ns=>'issn',
 406         'lcn,phr'=>'dewey', su=>'subject', 'su,phr'=>'subject',
 407         ti=>'title', 'ti,phr'=>'title', se=>'title'
 408 };
 409 for (my $ii = 0; $ii < @operands; ++$ii)
 410 {
 411         my $name = $indexes2z3950->{$indexes[$ii]};
 412         if (defined $name && defined $operands[$ii])
 413         {
 414                 $z3950par ||= {};
 415                 $z3950par->{$name} = $operands[$ii] if !exists $z3950par->{$name};
 416         }
 417 }
 418
 419
 420 # Params that can only have one value
 421 my $scan = $params->{'scan'};
 422 my $count = C4::Context->preference('numSearchResults') || 20;
 423 my $results_per_page = $params->{'count'} || $count;
 424 my $offset = $params->{'offset'} || 0;
 425 my $page = $cgi->param('page') || 1;
 426 #my $offset = ($page-1)*$results_per_page;
 427 my $hits;
 428 my $expanded_facet = $params->{'expand'};
 429
 430 # Define some global variables
 431 my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
 432
 433 my @results;
 434
 435 ## I. BUILD THE QUERY
 436 my $lang = C4::Output::getlanguagecookie($cgi);
 437 ( $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);
 438
 439 ## parse the query_cgi string and put it into a form suitable for <input>s
 440 my @query_inputs;
 441 my $scan_index_to_use;
 442
 443 for my $this_cgi ( split('&',$query_cgi) ) {
 444     next unless $this_cgi;
 445     $this_cgi =~ m/(.*=)(.*)/;
 446     my $input_name = $1;
 447     my $input_value = $2;
 448     $input_name =~ s/=$//;
 449     push @query_inputs, { input_name => $input_name, input_value => $input_value };
 450         if ($input_name eq 'idx') {
 451         $scan_index_to_use = $input_value; # unless $scan_index_to_use;
 452         }
 453 }
 454 $template->param ( QUERY_INPUTS => \@query_inputs,
 455                    scan_index_to_use => $scan_index_to_use );
 456
 457 ## parse the limit_cgi string and put it into a form suitable for <input>s
 458 my @limit_inputs;
 459 for my $this_cgi ( split('&',$limit_cgi) ) {
 460     next unless $this_cgi;
 461     # handle special case limit-yr
 462     if ($this_cgi =~ /yr,st-numeric/) {
 463         push @limit_inputs, { input_name => 'limit-yr', input_value => $limit_yr_value };
 464         next;
 465     }
 466     $this_cgi =~ m/(.*=)(.*)/;
 467     my $input_name = $1;
 468     my $input_value = $2;
 469     $input_name =~ s/=$//;
 470     push @limit_inputs, { input_name => $input_name, input_value => $input_value };
 471 }
 472 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 473
 474 ## II. DO THE SEARCH AND GET THE RESULTS
 475 my $total; # the total results for the whole set
 476 my $facets; # this object stores the faceted results that display on the left-hand of the results page
 477 my @results_array;
 478 my $results_hashref;
 479
 480 if (C4::Context->preference('NoZebra')) {
 481     $query=~s/yr(:|=)\s*([\d]{1,4})-([\d]{1,4})/(yr>=$2 and yr<=$3)/g;
 482     $simple_query=~s/yr\s*(:|=)([\d]{1,4})-([\d]{1,4})/(yr>=$2 and yr<=$3)/g;
 483     # warn $query;
 484     eval {
 485         ($error, $results_hashref, $facets) = NZgetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
 486     };
 487 } else {
 488     eval {
 489         ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
 490     };
 491 }
 492 if ($@ || $error) {
 493     $template->param(query_error => $error.$@);
 494     output_html_with_http_headers $cgi, $cookie, $template->output;
 495     exit;
 496 }
 497
 498 # At this point, each server has given us a result set
 499 # now we build that set for template display
 500 my @sup_results_array;
 501 for (my $i=0;$i<@servers;$i++) {
 502     my $server = $servers[$i];
 503     if ($server =~/biblioserver/) { # this is the local bibliographic server
 504         $hits = $results_hashref->{$server}->{"hits"};
 505         my $page = $cgi->param('page') || 0;
 506         my @newresults = searchResults( $query_desc,$hits,$results_per_page,$offset,$scan,@{$results_hashref->{$server}->{"RECORDS"}});
 507         $total = $total + $results_hashref->{$server}->{"hits"};
 508         ## If there's just one result, redirect to the detail page
 509         if ($total == 1) {
 510             my $biblionumber = $newresults[0]->{biblionumber};
 511                         my $defaultview = C4::Context->preference('IntranetBiblioDefaultView');
 512                         my $views = { C4::Search::enabled_staff_search_views };
 513             if ($defaultview eq 'isbd' && $views->{can_view_ISBD}) {
 514                 print $cgi->redirect("/cgi-bin/koha/catalogue/ISBDdetail.pl?biblionumber=$biblionumber");
 515             } elsif  ($defaultview eq 'marc' && $views->{can_view_MARC}) {
 516                 print $cgi->redirect("/cgi-bin/koha/catalogue/MARCdetail.pl?biblionumber=$biblionumber");
 517             } elsif  ($defaultview eq 'labeled_marc' && $views->{can_view_labeledMARC}) {
 518                 print $cgi->redirect("/cgi-bin/koha/catalogue/labeledMARCdetail.pl?biblionumber=$biblionumber");
 519             } else {
 520                 print $cgi->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber");
 521             }
 522             exit;
 523         }
 524
 525
 526         if ($hits) {
 527             $template->param(total => $hits);
 528             my $limit_cgi_not_availablity = $limit_cgi;
 529             $limit_cgi_not_availablity =~ s/&limit=available//g;
 530             $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
 531             $template->param(limit_cgi => $limit_cgi);
 532             $template->param(query_cgi => $query_cgi);
 533             $template->param(query_desc => $query_desc);
 534             $template->param(limit_desc => $limit_desc);
 535                         $template->param (z3950_search_params => C4::Search::z3950_search_args($query_desc));
 536             if ($query_desc || $limit_desc) {
 537                 $template->param(searchdesc => 1);
 538             }
 539             $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
 540             $template->param(results_per_page =>  $results_per_page);
 541             $template->param(SEARCH_RESULTS => \@newresults);
 542
 543             ## FIXME: add a global function for this, it's better than the current global one
 544             ## Build the page numbers on the bottom of the page
 545             my @page_numbers;
 546             # total number of pages there will be
 547             my $pages = ceil($hits / $results_per_page);
 548             # default page number
 549             my $current_page_number = 1;
 550             $current_page_number = ($offset / $results_per_page + 1) if $offset;
 551             my $previous_page_offset = $offset - $results_per_page unless ($offset - $results_per_page <0);
 552             my $next_page_offset = $offset + $results_per_page;
 553             # If we're within the first 10 pages, keep it simple
 554             #warn "current page:".$current_page_number;
 555             if ($current_page_number < 10) {
 556                 # just show the first 10 pages
 557                 # Loop through the pages
 558                 my $pages_to_show = 10;
 559                 $pages_to_show = $pages if $pages<10;
 560                 for (my $i=1; $i<=$pages_to_show;$i++) {
 561                     # the offset for this page
 562                     my $this_offset = (($i*$results_per_page)-$results_per_page);
 563                     # the page number for this page
 564                     my $this_page_number = $i;
 565                     # it should only be highlighted if it's the current page
 566                     my $highlight = 1 if ($this_page_number == $current_page_number);
 567                     # put it in the array
 568                     push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
 569
 570                 }
 571
 572             }
 573
 574             # now, show twenty pages, with the current one smack in the middle
 575             else {
 576                 for (my $i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
 577                     my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
 578                     my $this_page_number = $i-9;
 579                     my $highlight = 1 if ($this_page_number == $current_page_number);
 580                     if ($this_page_number <= $pages) {
 581                         push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
 582                     }
 583                 }
 584             }
 585             # FIXME: no previous_page_offset when pages < 2
 586             $template->param(   PAGE_NUMBERS => \@page_numbers,
 587                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
 588             $template->param(   next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
 589         }
 590
 591
 592         # no hits
 593         else {
 594             $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
 595                         $template->param (z3950_search_params => C4::Search::z3950_search_args($z3950par || $query_desc));
 596         }
 597
 598     } # end of the if local
 599
 600     # asynchronously search the authority server
 601     elsif ($server =~/authorityserver/) { # this is the local authority server
 602         my @inner_sup_results_array;
 603         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
 604             my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
 605             # warn "Authority Found: ".$marc_record_object->as_formatted();
 606             push @inner_sup_results_array, {
 607                 'title' => $marc_record_object->field(100)->subfield('a'),
 608                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
 609             };
 610         }
 611         push @sup_results_array, {  servername => $server,
 612                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
 613     }
 614     # FIXME: can add support for other targets as needed here
 615     $template->param(           outer_sup_results_loop => \@sup_results_array);
 616 } #/end of the for loop
 617 #$template->param(FEDERATED_RESULTS => \@results_array);
 618
 619
 620 $template->param(
 621             #classlist => $classlist,
 622             total => $total,
 623             opacfacets => 1,
 624             facets_loop => $facets,
 625             scan => $scan,
 626             search_error => $error,
 627 );
 628
 629 if ($query_desc || $limit_desc) {
 630     $template->param(searchdesc => 1);
 631 }
 632
 633 # VI. BUILD THE TEMPLATE
 634 output_html_with_http_headers $cgi, $cookie, $template->output;