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