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