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 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 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 @advancedsearchesloop;
 246 my $cnt;
 247 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
 248 my @advanced_search_types = split(/\|/, $advanced_search_types);
 249
 250 foreach my $advanced_srch_type (@advanced_search_types) {
 251    if ($advanced_srch_type eq 'itemtypes') {
 252    # itemtype is a special case, since it's not defined in authorized values
 253         my @itypesloop;
 254         foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
 255             my %row =(  number=>$cnt++,
 256                 ccl => "$itype_or_itemtype,phr",
 257                 code => $thisitemtype,
 258                 description => $itemtypes->{$thisitemtype}->{'description'},
 259                 imageurl=> getitemtypeimagelocation( 'intranet', $itemtypes->{$thisitemtype}->{'imageurl'} ),
 260             );
 261             push @itypesloop, \%row;
 262         }
 263         my %search_code = (  advanced_search_type => $advanced_srch_type,
 264                              code_loop => \@itypesloop );
 265         push @advancedsearchesloop, \%search_code;
 266     } else {
 267     # covers all the other cases: non-itemtype authorized values
 268        my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
 269         my @authvalueloop;
 270         for my $thisitemtype (@$advsearchtypes) {
 271                 my %row =(
 272                                 number=>$cnt++,
 273                                 ccl => $advanced_srch_type,
 274                 code => $thisitemtype->{authorised_value},
 275                 description => $thisitemtype->{'lib'},
 276                 imageurl => getitemtypeimagelocation( 'intranet', $thisitemtype->{'imageurl'} ),
 277                 );
 278                 push @authvalueloop, \%row;
 279         }
 280         my %search_code = (  advanced_search_type => $advanced_srch_type,
 281                              code_loop => \@authvalueloop );
 282         push @advancedsearchesloop, \%search_code;
 283     }
 284 }
 285 $template->param(advancedsearchesloop => \@advancedsearchesloop);
 286
 287 # The following should only be loaded if we're bringing up the advanced search template
 288 if ( $template_type eq 'advsearch' ) {
 289
 290     # load the servers (used for searching -- to do federated searching, etc.)
 291     my $primary_servers_loop;# = displayPrimaryServers();
 292     $template->param(outer_servers_loop =>  $primary_servers_loop,);
 293
 294     my $secondary_servers_loop;
 295     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 296
 297     # set the default sorting
 298     if (   C4::Context->preference('OPACdefaultSortField')
 299         && C4::Context->preference('OPACdefaultSortOrder') ) {
 300         my $default_sort_by =
 301             C4::Context->preference('defaultSortField') . '_'
 302           . C4::Context->preference('defaultSortOrder');
 303         $template->param( sort_by => $default_sort_by  );
 304     }
 305
 306     # determine what to display next to the search boxes (ie, boolean option
 307     # shouldn't appear on the first one, scan indexes should, adding a new
 308     # box should only appear on the last, etc.
 309     my @search_boxes_array;
 310     my $search_boxes_count = 3; # begin whith 3 boxes
 311     # FIXME: all this junk can be done in TMPL using __first__ and __last__
 312     for (my $i=1;$i<=$search_boxes_count;$i++) {
 313         # if it's the first one, don't display boolean option, but show scan indexes
 314         if ($i==1) {
 315             push @search_boxes_array, {scan_index => 1};
 316         }
 317         # if it's the last one, show the 'add field' box
 318         elsif ($i==$search_boxes_count) {
 319             push @search_boxes_array,
 320                 {
 321                 boolean => 1,
 322                 add_field => 1,
 323                 };
 324         }
 325         else {
 326             push @search_boxes_array,
 327                 {
 328                 boolean => 1,
 329                 };
 330         }
 331
 332     }
 333     $template->param(uc(C4::Context->preference("marcflavour")) => 1,
 334                       search_boxes_loop => \@search_boxes_array);
 335
 336     # load the language limits (for search)
 337     my $languages_limit_loop = getAllLanguages();
 338     $template->param(search_languages_loop => $languages_limit_loop,);
 339
 340     # Expanded search options in advanced search:
 341     # use the global setting by default, but let the user override it
 342     {
 343         my $expanded = $cgi->param('expanded_options');
 344         $expanded = C4::Context->preference("expandedSearchOption") || 0
 345             if !defined($expanded) || $expanded !~ /^0|1$/;
 346         $template->param( expanded_options => $expanded );
 347     }
 348
 349     $template->param(virtualshelves => C4::Context->preference("virtualshelves"));
 350
 351     output_html_with_http_headers $cgi, $cookie, $template->output;
 352     exit;
 353 }
 354
 355 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
 356
 357 # Fetch the paramater list as a hash in scalar context:
 358 #  * returns paramater list as tied hash ref
 359 #  * we can edit the values by changing the key
 360 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 361 my $params = $cgi->Vars;
 362
 363 # Params that can have more than one value
 364 # sort by is used to sort the query
 365 # in theory can have more than one but generally there's just one
 366 my @sort_by;
 367 my $default_sort_by;
 368 if (   C4::Context->preference('defaultSortField')
 369     && C4::Context->preference('defaultSortOrder') ) {
 370     $default_sort_by =
 371         C4::Context->preference('defaultSortField') . '_'
 372       . C4::Context->preference('defaultSortOrder');
 373 }
 374
 375 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
 376 $sort_by[0] = $default_sort_by unless $sort_by[0];
 377 foreach my $sort (@sort_by) {
 378     $template->param($sort => 1) if $sort;
 379 }
 380 $template->param('sort_by' => $sort_by[0]);
 381
 382 # Use the servers defined, or just search our local catalog(default)
 383 my @servers;
 384 @servers = split("\0",$params->{'server'}) if $params->{'server'};
 385 unless (@servers) {
 386     #FIXME: this should be handled using Context.pm
 387     @servers = ("biblioserver");
 388     # @servers = C4::Context->config("biblioserver");
 389 }
 390 # operators include boolean and proximity operators and are used
 391 # to evaluate multiple operands
 392 my @operators;
 393 @operators = split("\0",$params->{'op'}) if $params->{'op'};
 394
 395 # indexes are query qualifiers, like 'title', 'author', etc. They
 396 # can be single or multiple parameters separated by comma: kw,right-Truncation
 397 my @indexes;
 398 @indexes = split("\0",$params->{'idx'});
 399
 400 # if a simple index (only one)  display the index used in the top search box
 401 if ($indexes[0] && (!$indexes[1] || $params->{'scan'})) {
 402     my $idx = "ms_".$indexes[0];
 403     $idx =~ s/\,/comma/g;  # template toolkit doesnt like variables with a , in it
 404     $template->param($idx => 1);
 405 }
 406
 407
 408 # an operand can be a single term, a phrase, or a complete ccl query
 409 my @operands;
 410 @operands = split("\0",$params->{'q'}) if $params->{'q'};
 411
 412 # limits are use to limit to results to a pre-defined category such as branch or language
 413 my @limits;
 414 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
 415
 416 if($params->{'multibranchlimit'}) {
 417     push @limits, '('.join( " or ", map { "branch: $_ " } @{ GetBranchesInCategory( $params->{'multibranchlimit'} ) } ).')';
 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]};
 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 my $lang = C4::Templates::getlanguage($cgi, 'intranet');
 481 ( $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);
 482
 483 ## parse the query_cgi string and put it into a form suitable for <input>s
 484 my @query_inputs;
 485 my $scan_index_to_use;
 486
 487 for my $this_cgi ( split('&',$query_cgi) ) {
 488     next unless $this_cgi;
 489     $this_cgi =~ m/(.*?)=(.*)/;
 490     my $input_name = $1;
 491     my $input_value = $2;
 492     push @query_inputs, { input_name => $input_name, input_value => $input_value };
 493     if ($input_name eq 'idx') {
 494         $scan_index_to_use = $input_value; # unless $scan_index_to_use;
 495     }
 496 }
 497 $template->param ( QUERY_INPUTS => \@query_inputs,
 498                    scan_index_to_use => $scan_index_to_use );
 499
 500 ## parse the limit_cgi string and put it into a form suitable for <input>s
 501 my @limit_inputs;
 502 for my $this_cgi ( split('&',$limit_cgi) ) {
 503     next unless $this_cgi;
 504     # handle special case limit-yr
 505     if ($this_cgi =~ /yr,st-numeric/) {
 506         push @limit_inputs, { input_name => 'limit-yr', input_value => $limit_yr_value };
 507         next;
 508     }
 509     $this_cgi =~ m/(.*=)(.*)/;
 510     my $input_name = $1;
 511     my $input_value = $2;
 512     $input_name =~ s/=$//;
 513     push @limit_inputs, { input_name => $input_name, input_value => $input_value };
 514 }
 515 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 516
 517 ## II. DO THE SEARCH AND GET THE RESULTS
 518 my $total; # the total results for the whole set
 519 my $facets; # this object stores the faceted results that display on the left-hand of the results page
 520 my @results_array;
 521 my $results_hashref;
 522
 523 if (C4::Context->preference('NoZebra')) {
 524     $query=~s/yr(:|=)\s*([\d]{1,4})-([\d]{1,4})/(yr>=$2 and yr<=$3)/g;
 525     $simple_query=~s/yr\s*(:|=)([\d]{1,4})-([\d]{1,4})/(yr>=$2 and yr<=$3)/g;
 526     # warn $query;
 527     eval {
 528         ($error, $results_hashref, $facets) = NZgetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
 529     };
 530 } else {
 531     eval {
 532         ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
 533     };
 534 }
 535 # This sorts the facets into alphabetical order
 536 if ($facets) {
 537     foreach my $f (@$facets) {
 538         $f->{facets} = [ sort { uc($a->{facet_title_value}) cmp uc($b->{facet_title_value}) } @{ $f->{facets} } ];
 539     }
 540 }
 541 if ($@ || $error) {
 542     $template->param(query_error => $error.$@);
 543     output_html_with_http_headers $cgi, $cookie, $template->output;
 544     exit;
 545 }
 546
 547 # At this point, each server has given us a result set
 548 # now we build that set for template display
 549 my @sup_results_array;
 550 for (my $i=0;$i<@servers;$i++) {
 551     my $server = $servers[$i];
 552     if ($server =~/biblioserver/) { # this is the local bibliographic server
 553         $hits = $results_hashref->{$server}->{"hits"};
 554         my $page = $cgi->param('page') || 0;
 555         my @newresults = searchResults('intranet', $query_desc, $hits, $results_per_page, $offset, $scan,
 556                                        $results_hashref->{$server}->{"RECORDS"});
 557         $total = $total + $results_hashref->{$server}->{"hits"};
 558         ## If there's just one result, redirect to the detail page
 559         if ($total == 1) {
 560             my $biblionumber = $newresults[0]->{biblionumber};
 561             my $defaultview = C4::Context->preference('IntranetBiblioDefaultView');
 562             my $views = { C4::Search::enabled_staff_search_views };
 563             if ($defaultview eq 'isbd' && $views->{can_view_ISBD}) {
 564                 print $cgi->redirect("/cgi-bin/koha/catalogue/ISBDdetail.pl?biblionumber=$biblionumber");
 565             } elsif  ($defaultview eq 'marc' && $views->{can_view_MARC}) {
 566                 print $cgi->redirect("/cgi-bin/koha/catalogue/MARCdetail.pl?biblionumber=$biblionumber");
 567             } elsif  ($defaultview eq 'labeled_marc' && $views->{can_view_labeledMARC}) {
 568                 print $cgi->redirect("/cgi-bin/koha/catalogue/labeledMARCdetail.pl?biblionumber=$biblionumber");
 569             } else {
 570                 print $cgi->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber");
 571             }
 572             exit;
 573         }
 574
 575
 576         if ($hits) {
 577             $template->param(total => $hits);
 578             my $limit_cgi_not_availablity = $limit_cgi;
 579             $limit_cgi_not_availablity =~ s/&limit=available//g;
 580             $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
 581             $template->param(limit_cgi => $limit_cgi);
 582             $template->param(query_cgi => $query_cgi);
 583             $template->param(query_desc => $query_desc);
 584             $template->param(limit_desc => $limit_desc);
 585             $template->param(offset     => $offset);
 586             $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
 587             $template->param (z3950_search_params => C4::Search::z3950_search_args($query_desc));
 588             if ($query_desc || $limit_desc) {
 589                 $template->param(searchdesc => 1);
 590             }
 591             $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
 592             $template->param(results_per_page =>  $results_per_page);
 593             # must define a value for size if not present in DB
 594             # in order to avoid problems generated by the default size value in TT
 595             foreach my $line (@newresults) {
 596                 if ( not exists $line->{'size'} ) { $line->{'size'} = "" }
 597             }
 598             $template->param(SEARCH_RESULTS => \@newresults);
 599             ## FIXME: add a global function for this, it's better than the current global one
 600             ## Build the page numbers on the bottom of the page
 601             my @page_numbers;
 602             # total number of pages there will be
 603             my $pages = ceil($hits / $results_per_page);
 604             # default page number
 605             my $current_page_number = 1;
 606             $current_page_number = ($offset / $results_per_page + 1) if $offset;
 607             my $previous_page_offset;
 608             if ( $offset >= $results_per_page ) {
 609                 $previous_page_offset = $offset - $results_per_page;
 610             }
 611             my $next_page_offset = $offset + $results_per_page;
 612             # If we're within the first 10 pages, keep it simple
 613             #warn "current page:".$current_page_number;
 614             if ($current_page_number < 10) {
 615                 # just show the first 10 pages
 616                 # Loop through the pages
 617                 my $pages_to_show = 10;
 618                 $pages_to_show = $pages if $pages<10;
 619                 for (my $i=1; $i<=$pages_to_show;$i++) {
 620                     # the offset for this page
 621                     my $this_offset = (($i*$results_per_page)-$results_per_page);
 622                     # the page number for this page
 623                     my $this_page_number = $i;
 624                     # put it in the array
 625                     push @page_numbers,
 626                       { offset    => $this_offset,
 627                         pg        => $this_page_number,
 628                         # it should only be highlighted if it's the current page
 629                         highlight => $this_page_number == $current_page_number,
 630                         sort_by   => join ' ', @sort_by
 631                       };
 632
 633                 }
 634
 635             }
 636
 637             # now, show twenty pages, with the current one smack in the middle
 638             else {
 639                 for (my $i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
 640                     my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
 641                     my $this_page_number = $i-9;
 642                     if ( $this_page_number <= $pages ) {
 643                         push @page_numbers,
 644                           { offset    => $this_offset,
 645                             pg        => $this_page_number,
 646                             highlight => $this_page_number == $current_page_number,
 647                             sort_by   => join ' ', @sort_by
 648                           };
 649                     }
 650                 }
 651             }
 652             # FIXME: no previous_page_offset when pages < 2
 653             $template->param(   PAGE_NUMBERS => \@page_numbers,
 654                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
 655             $template->param(   next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
 656         }
 657
 658
 659         # no hits
 660         else {
 661             $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
 662             $template->param (z3950_search_params => C4::Search::z3950_search_args($z3950par || $query_desc));
 663         }
 664
 665     } # end of the if local
 666
 667     # asynchronously search the authority server
 668     elsif ($server =~/authorityserver/) { # this is the local authority server
 669         my @inner_sup_results_array;
 670         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
 671             my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
 672             # warn "Authority Found: ".$marc_record_object->as_formatted();
 673             push @inner_sup_results_array, {
 674                 'title' => $marc_record_object->field(100)->subfield('a'),
 675                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
 676             };
 677         }
 678         push @sup_results_array, {  servername => $server,
 679                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
 680     }
 681     # FIXME: can add support for other targets as needed here
 682     $template->param(           outer_sup_results_loop => \@sup_results_array);
 683 } #/end of the for loop
 684 #$template->param(FEDERATED_RESULTS => \@results_array);
 685
 686
 687 $template->param(
 688             #classlist => $classlist,
 689             total => $total,
 690             opacfacets => 1,
 691             facets_loop => $facets,
 692             displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
 693             scan => $scan,
 694             search_error => $error,
 695 );
 696
 697 if ($query_desc || $limit_desc) {
 698     $template->param(searchdesc => 1);
 699 }
 700
 701 # VI. BUILD THE TEMPLATE
 702
 703 # Build drop-down list for 'Add To:' menu...
 704 my ($totalref, $pubshelves, $barshelves)=
 705         C4::VirtualShelves::GetSomeShelfNames($borrowernumber,'COMBO',1);
 706 $template->param(
 707         addbarshelves     => $totalref->{bartotal},
 708         addbarshelvesloop => $barshelves,
 709         addpubshelves     => $totalref->{pubtotal},
 710         addpubshelvesloop => $pubshelves,
 711         );
 712
 713 output_html_with_http_headers $cgi, $cookie, $template->output;