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