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
  19 # with Koha; if not, write to the Free Software Foundation, Inc.,
  20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 #use warnings; FIXME - Bug 2505
 136
 137 ## STEP 1. Load things that are used in both search page and
 138 # results page and decide which template to load, operations
 139 # to perform, etc.
 140
 141 ## load Koha modules
 142 use C4::Context;
 143 use C4::Output;
 144 use C4::Auth qw(:DEFAULT get_session);
 145 use C4::Search;
 146 use C4::Languages qw(getAllLanguages);
 147 use C4::Koha;
 148 use C4::Members qw(GetMember);
 149 use C4::VirtualShelves qw(GetRecentShelves);
 150 use POSIX qw(ceil floor);
 151 use C4::Branch; # GetBranches
 152
 153 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
 154 # create a new CGI object
 155 # FIXME: no_undef_params needs to be tested
 156 use CGI qw('-no_undef_params');
 157 my $cgi = new CGI;
 158
 159 my ($template,$borrowernumber,$cookie);
 160
 161 # decide which template to use
 162 my $template_name;
 163 my $template_type;
 164 my @params = $cgi->param("limit");
 165 if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
 166     $template_name = 'catalogue/results.tmpl';
 167 }
 168 else {
 169     $template_name = 'catalogue/advsearch.tmpl';
 170     $template_type = 'advsearch';
 171 }
 172 # load the template
 173 ($template, $borrowernumber, $cookie) = get_template_and_user({
 174     template_name => $template_name,
 175     query => $cgi,
 176     type => "intranet",
 177     authnotrequired => 0,
 178     flagsrequired   => { catalogue => 1 },
 179     }
 180 );
 181 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
 182     $template->param('UNIMARC' => 1);
 183 }
 184
 185 if($cgi->cookie("holdfor")){
 186     my $holdfor_patron = GetMember('borrowernumber' => $cgi->cookie("holdfor"));
 187     $template->param(
 188         holdfor => $cgi->cookie("holdfor"),
 189         holdfor_surname => $holdfor_patron->{'surname'},
 190         holdfor_firstname => $holdfor_patron->{'firstname'},
 191         holdfor_cardnumber => $holdfor_patron->{'cardnumber'},
 192     );
 193 }
 194
 195 ## URI Re-Writing
 196 # Deprecated, but preserved because it's interesting :-)
 197 # The same thing can be accomplished with mod_rewrite in
 198 # a more elegant way
 199 #
 200 #my $rewrite_flag;
 201 #my $uri = $cgi->url(-base => 1);
 202 #my $relative_url = $cgi->url(-relative=>1);
 203 #$uri.="/".$relative_url."?";
 204 #warn "URI:$uri";
 205 #my @cgi_params_list = $cgi->param();
 206 #my $url_params = $cgi->Vars;
 207 #
 208 #for my $each_param_set (@cgi_params_list) {
 209 #    $uri.= join "",  map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
 210 #}
 211 #warn "New URI:$uri";
 212 # Only re-write a URI if there are params or if it already hasn't been re-written
 213 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
 214 #    print $cgi->redirect(     -uri=>$uri."&r=1",
 215 #                            -cookie => $cookie);
 216 #    exit;
 217 #}
 218
 219 # load the branches
 220 my $branches = GetBranches();
 221
 222 # Populate branch_loop with all branches sorted by their name.  If
 223 # independantbranches is activated, set the default branch to the borrower
 224 # branch, except for superlibrarian who need to search all libraries.
 225 my $user = C4::Context->userenv;
 226 my @branch_loop = map {
 227      {
 228         value      => $_,
 229         branchname => $branches->{$_}->{branchname},
 230         selected   => $user->{branch} eq $_ && C4::Branch::onlymine(),
 231      }
 232 } sort {
 233     $branches->{$a}->{branchname} cmp $branches->{$b}->{branchname}
 234 } keys %$branches;
 235
 236 my $categories = GetBranchCategories(undef,'searchdomain');
 237
 238 $template->param(branchloop => \@branch_loop, searchdomainloop => $categories);
 239
 240 # load the Type stuff
 241 # load the Type stuff
 242 my $itemtypes = GetItemTypes;
 243 # the index parameter is different for item-level itemtypes
 244 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
 245 my @itemtypesloop;
 246 my $selected=1;
 247 my $cnt;
 248 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes");
 249
 250 if (!$advanced_search_types or $advanced_search_types eq 'itemtypes') {                                                                 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
 251     my %row =(  number=>$cnt++,
 252                 ccl => $itype_or_itemtype,
 253                 code => $thisitemtype,
 254                 selected => $selected,
 255                 description => $itemtypes->{$thisitemtype}->{'description'},
 256                 count5 => $cnt % 4,
 257                 imageurl=> getitemtypeimagelocation( 'intranet', $itemtypes->{$thisitemtype}->{'imageurl'} ),
 258             );
 259         $selected = 0 if ($selected) ;
 260         push @itemtypesloop, \%row;
 261     }
 262     $template->param(itemtypeloop => \@itemtypesloop);
 263 } else {
 264     my $advsearchtypes = GetAuthorisedValues($advanced_search_types);
 265     for my $thisitemtype (sort {$a->{'lib'} cmp $b->{'lib'}} @$advsearchtypes) {
 266         my %row =(
 267                 number=>$cnt++,
 268                 ccl => $advanced_search_types,
 269                 code => $thisitemtype->{authorised_value},
 270                 selected => $selected,
 271                 description => $thisitemtype->{'lib'},
 272                 count5 => $cnt % 4,
 273                 imageurl=> getitemtypeimagelocation( 'intranet', $thisitemtype->{'imageurl'} ),
 274             );
 275         push @itemtypesloop, \%row;
 276     }
 277     $template->param(itemtypeloop => \@itemtypesloop);
 278 }
 279
 280 # The following should only be loaded if we're bringing up the advanced search template
 281 if ( $template_type eq 'advsearch' ) {
 282
 283     # load the servers (used for searching -- to do federated searching, etc.)
 284     my $primary_servers_loop;# = displayPrimaryServers();
 285     $template->param(outer_servers_loop =>  $primary_servers_loop,);
 286
 287     my $secondary_servers_loop;
 288     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 289
 290     # set the default sorting
 291     my $default_sort_by = C4::Context->preference('defaultSortField')."_".C4::Context->preference('defaultSortOrder')
 292         if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
 293     $template->param($default_sort_by => 1);
 294
 295     # determine what to display next to the search boxes (ie, boolean option
 296     # shouldn't appear on the first one, scan indexes should, adding a new
 297     # box should only appear on the last, etc.
 298     my @search_boxes_array;
 299     my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") || 3; # FIXME: using OPAC sysprefs?
 300     # FIXME: all this junk can be done in TMPL using __first__ and __last__
 301     for (my $i=1;$i<=$search_boxes_count;$i++) {
 302         # if it's the first one, don't display boolean option, but show scan indexes
 303         if ($i==1) {
 304             push @search_boxes_array, {scan_index => 1};
 305         }
 306         # if it's the last one, show the 'add field' box
 307         elsif ($i==$search_boxes_count) {
 308             push @search_boxes_array,
 309                 {
 310                 boolean => 1,
 311                 add_field => 1,
 312                 };
 313         }
 314         else {
 315             push @search_boxes_array,
 316                 {
 317                 boolean => 1,
 318                 };
 319         }
 320
 321     }
 322     $template->param(uc(C4::Context->preference("marcflavour")) => 1,
 323                       search_boxes_loop => \@search_boxes_array);
 324
 325     # load the language limits (for search)
 326     my $languages_limit_loop = getAllLanguages();
 327     $template->param(search_languages_loop => $languages_limit_loop,);
 328
 329     # use the global setting by default
 330     if ( C4::Context->preference("expandedSearchOption") == 1) {
 331         $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
 332     }
 333     # but let the user override it
 334     if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
 335         $template->param( expanded_options => $cgi->param('expanded_options'));
 336     }
 337
 338     $template->param(virtualshelves => C4::Context->preference("virtualshelves"));
 339
 340     output_html_with_http_headers $cgi, $cookie, $template->output;
 341     exit;
 342 }
 343
 344 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
 345
 346 # Fetch the paramater list as a hash in scalar context:
 347 #  * returns paramater list as tied hash ref
 348 #  * we can edit the values by changing the key
 349 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 350 my $params = $cgi->Vars;
 351
 352 # Params that can have more than one value
 353 # sort by is used to sort the query
 354 # in theory can have more than one but generally there's just one
 355 my @sort_by;
 356 my $default_sort_by = C4::Context->preference('defaultSortField')."_".C4::Context->preference('defaultSortOrder')
 357     if (C4::Context->preference('defaultSortField') && C4::Context->preference('defaultSortOrder'));
 358
 359 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
 360 $sort_by[0] = $default_sort_by unless $sort_by[0];
 361 foreach my $sort (@sort_by) {
 362     $template->param($sort => 1);
 363 }
 364 $template->param('sort_by' => $sort_by[0]);
 365
 366 # Use the servers defined, or just search our local catalog(default)
 367 my @servers;
 368 @servers = split("\0",$params->{'server'}) if $params->{'server'};
 369 unless (@servers) {
 370     #FIXME: this should be handled using Context.pm
 371     @servers = ("biblioserver");
 372     # @servers = C4::Context->config("biblioserver");
 373 }
 374 # operators include boolean and proximity operators and are used
 375 # to evaluate multiple operands
 376 my @operators;
 377 @operators = split("\0",$params->{'op'}) if $params->{'op'};
 378
 379 # indexes are query qualifiers, like 'title', 'author', etc. They
 380 # can be single or multiple parameters separated by comma: kw,right-Truncation
 381 my @indexes;
 382 @indexes = split("\0",$params->{'idx'});
 383
 384 # if a simple index (only one)  display the index used in the top search box
 385 if ($indexes[0] && !$indexes[1]) {
 386     $template->param("ms_".$indexes[0] => 1);}
 387
 388
 389 # an operand can be a single term, a phrase, or a complete ccl query
 390 my @operands;
 391 @operands = split("\0",$params->{'q'}) if $params->{'q'};
 392
 393 # limits are use to limit to results to a pre-defined category such as branch or language
 394 my @limits;
 395 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
 396
 397 if($params->{'multibranchlimit'}) {
 398 push @limits, join(" or ", map { "branch: $_ "}  @{GetBranchesInCategory($params->{'multibranchlimit'})}) ;
 399 }
 400
 401 my $available;
 402 foreach my $limit(@limits) {
 403     if ($limit =~/available/) {
 404         $available = 1;
 405     }
 406 }
 407 $template->param(available => $available);
 408
 409 # append year limits if they exist
 410 my $limit_yr;
 411 my $limit_yr_value;
 412 if ($params->{'limit-yr'}) {
 413     if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
 414         my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
 415         $limit_yr = "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
 416         $limit_yr_value = "$yr1-$yr2";
 417     }
 418     elsif ($params->{'limit-yr'} =~ /\d{4}/) {
 419         $limit_yr = "yr,st-numeric=$params->{'limit-yr'}";
 420         $limit_yr_value = $params->{'limit-yr'};
 421     }
 422     push @limits,$limit_yr;
 423     #FIXME: Should return a error to the user, incorect date format specified
 424 }
 425
 426 # convert indexes and operands to corresponding parameter names for the z3950 search
 427 # $ %z3950p will be a hash ref if the indexes are present (advacned search), otherwise undef
 428 my $z3950par;
 429 my $indexes2z3950 = {
 430         kw=>'title', au=>'author', 'au,phr'=>'author', nb=>'isbn', ns=>'issn',
 431         'lcn,phr'=>'dewey', su=>'subject', 'su,phr'=>'subject',
 432         ti=>'title', 'ti,phr'=>'title', se=>'title'
 433 };
 434 for (my $ii = 0; $ii < @operands; ++$ii)
 435 {
 436         my $name = $indexes2z3950->{$indexes[$ii]};
 437         if (defined $name && defined $operands[$ii])
 438         {
 439                 $z3950par ||= {};
 440                 $z3950par->{$name} = $operands[$ii] if !exists $z3950par->{$name};
 441         }
 442 }
 443
 444
 445 # Params that can only have one value
 446 my $scan = $params->{'scan'};
 447 my $count = C4::Context->preference('numSearchResults') || 20;
 448 my $results_per_page = $params->{'count'} || $count;
 449 my $offset = $params->{'offset'} || 0;
 450 my $page = $cgi->param('page') || 1;
 451 #my $offset = ($page-1)*$results_per_page;
 452 my $hits;
 453 my $expanded_facet = $params->{'expand'};
 454
 455 # Define some global variables
 456 my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
 457
 458 my @results;
 459
 460 ## I. BUILD THE QUERY
 461 my $lang = C4::Output::getlanguagecookie($cgi);
 462 ( $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);
 463
 464 ## parse the query_cgi string and put it into a form suitable for <input>s
 465 my @query_inputs;
 466 my $scan_index_to_use;
 467
 468 for my $this_cgi ( split('&',$query_cgi) ) {
 469     next unless $this_cgi;
 470     $this_cgi =~ m/(.*=)(.*)/;
 471     my $input_name = $1;
 472     my $input_value = $2;
 473     $input_name =~ s/=$//;
 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             scan => $scan,
 660             search_error => $error,
 661 );
 662
 663 if ($query_desc || $limit_desc) {
 664     $template->param(searchdesc => 1);
 665 }
 666
 667 # VI. BUILD THE TEMPLATE
 668
 669 # Build drop-down list for 'Add To:' menu...
 670
 671 my $row_count = 10; # FIXME:This probably should be a syspref
 672 my ($pubshelves, $total) = GetRecentShelves(2, $row_count, undef);
 673 my ($barshelves, $total) = GetRecentShelves(1, $row_count, $borrowernumber);
 674
 675 my @pubshelves = @{$pubshelves};
 676 my @barshelves = @{$barshelves};
 677
 678 if (@pubshelves) {
 679         $template->param( addpubshelves     => scalar (@pubshelves));
 680         $template->param( addpubshelvesloop => @pubshelves);
 681 }
 682
 683 if (@barshelves) {
 684         $template->param( addbarshelves     => scalar (@barshelves));
 685         $template->param( addbarshelvesloop => @barshelves);
 686 }
 687
 688
 689
 690 output_html_with_http_headers $cgi, $cookie, $template->output;