Bug 19046: Make seach pulldown to retain index selection
[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
11 # under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 3 of the License, or
13 # (at your option) any later version.
14 #
15 # Koha is distributed in the hope that it will be useful, but
16 # WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
19 #
20 # You should have received a copy of the GNU General Public License
21 # along with Koha; if not, see <http://www.gnu.org/licenses>.
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 accomplish 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 Modern::Perl;
136
137 ## STEP 1. Load things that are used in both search page and
138 # results page and decide which template to load, operations 
139 # to perform, etc.
140
141 ## load Koha modules
142 use C4::Context;
143 use C4::Output;
144 use C4::Auth qw(:DEFAULT get_session);
145 use C4::Search;
146 use C4::Languages qw(getLanguages);
147 use C4::Koha;
148 use URI::Escape;
149 use POSIX qw(ceil floor);
150 use C4::Search::History;
151
152 use Koha::ItemTypes;
153 use Koha::Library::Groups;
154 use Koha::Patrons;
155 use Koha::SearchEngine::Search;
156 use Koha::SearchEngine::QueryBuilder;
157 use Koha::Virtualshelves;
158
159 use URI::Escape;
160
161 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
162 # create a new CGI object
163 # FIXME: no_undef_params needs to be tested
164 use CGI qw('-no_undef_params' -utf8 );
165 my $cgi = new CGI;
166
167 # decide which template to use
168 my $template_name;
169 my $template_type;
170 my @params = $cgi->multi_param("limit");
171 if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
172     $template_name = 'catalogue/results.tt';
173     $template_type = 'results';
174 }
175 else {
176     $template_name = 'catalogue/advsearch.tt';
177     $template_type = 'advsearch';
178 }
179 # load the template
180 my ($template, $borrowernumber, $cookie) = get_template_and_user({
181     template_name => $template_name,
182     query => $cgi,
183     type => "intranet",
184     authnotrequired => 0,
185     flagsrequired   => { catalogue => 1 },
186     }
187 );
188
189 my $lang = C4::Languages::getlanguage($cgi);
190
191 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
192     $template->param('UNIMARC' => 1);
193 }
194
195 if($cgi->cookie("holdfor")){ 
196     my $holdfor_patron = Koha::Patrons->find( $cgi->cookie("holdfor") );
197     $template->param(
198         holdfor => $cgi->cookie("holdfor"),
199         holdfor_surname => $holdfor_patron->surname,
200         holdfor_firstname => $holdfor_patron->firstname,
201         holdfor_cardnumber => $holdfor_patron->cardnumber,
202     );
203 }
204
205 # get biblionumbers stored in the cart
206 my @cart_list;
207
208 if($cgi->cookie("intranet_bib_list")){
209     my $cart_list = $cgi->cookie("intranet_bib_list");
210     @cart_list = split(/\//, $cart_list);
211 }
212
213 my @search_groups =
214   Koha::Library::Groups->get_search_groups( { interface => 'staff' } );
215 @search_groups = sort { $a->title cmp $b->title } @search_groups;
216
217 $template->param(
218     selected_branchcode => ( C4::Context->IsSuperLibrarian ? C4::Context->userenv : '' ),
219     search_groups    => \@search_groups,
220 );
221
222 # load the Type stuff
223 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
224 # the index parameter is different for item-level itemtypes
225 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
226 my @advancedsearchesloop;
227 my $cnt;
228 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
229 my @advanced_search_types = split(/\|/, $advanced_search_types);
230
231 foreach my $advanced_srch_type (@advanced_search_types) {
232     $advanced_srch_type =~ s/^\s*//;
233     $advanced_srch_type =~ s/\s*$//;
234    if ($advanced_srch_type eq 'itemtypes') {
235    # itemtype is a special case, since it's not defined in authorized values
236         my @itypesloop;
237         foreach my $thisitemtype ( sort {$itemtypes->{$a}->{translated_description} cmp $itemtypes->{$b}->{translated_description} } keys %$itemtypes ) {
238             my %row =(  number=>$cnt++,
239                 ccl => "$itype_or_itemtype,phr",
240                 code => $thisitemtype,
241                 description => $itemtypes->{$thisitemtype}->{translated_description},
242                 imageurl=> getitemtypeimagelocation( 'intranet', $itemtypes->{$thisitemtype}->{'imageurl'} ),
243             );
244             push @itypesloop, \%row;
245         }
246         my %search_code = (  advanced_search_type => $advanced_srch_type,
247                              code_loop => \@itypesloop );
248         push @advancedsearchesloop, \%search_code;
249     } else {
250     # covers all the other cases: non-itemtype authorized values
251        my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
252         my @authvalueloop;
253         for my $thisitemtype (@$advsearchtypes) {
254                 my %row =(
255                                 number=>$cnt++,
256                                 ccl => $advanced_srch_type,
257                 code => $thisitemtype->{authorised_value},
258                 description => $thisitemtype->{'lib'},
259                 imageurl => getitemtypeimagelocation( 'intranet', $thisitemtype->{'imageurl'} ),
260                 );
261                 push @authvalueloop, \%row;
262         }
263         my %search_code = (  advanced_search_type => $advanced_srch_type,
264                              code_loop => \@authvalueloop );
265         push @advancedsearchesloop, \%search_code;
266     }
267 }
268 $template->param(advancedsearchesloop => \@advancedsearchesloop);
269 my $types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
270 my $advancedsearchesloop = prepare_adv_search_types($types);
271 $template->param(advancedsearchesloop => $advancedsearchesloop);
272
273 # The following should only be loaded if we're bringing up the advanced search template
274 if ( $template_type eq 'advsearch' ) {
275
276     # load the servers (used for searching -- to do federated searching, etc.)
277     my $primary_servers_loop;# = displayPrimaryServers();
278     $template->param(outer_servers_loop =>  $primary_servers_loop,);
279     
280     my $secondary_servers_loop;
281     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
282
283     # set the default sorting
284     if (   C4::Context->preference('OPACdefaultSortField')
285         && C4::Context->preference('OPACdefaultSortOrder') ) {
286         my $default_sort_by =
287             C4::Context->preference('defaultSortField') . '_'
288           . C4::Context->preference('defaultSortOrder');
289         $template->param( sort_by => $default_sort_by  );
290     }
291
292     # determine what to display next to the search boxes (ie, boolean option
293     # shouldn't appear on the first one, scan indexes should, adding a new
294     # box should only appear on the last, etc.
295     my @search_boxes_array;
296     my $search_boxes_count = 3; # begin with 3 boxes
297     # FIXME: all this junk can be done in TMPL using __first__ and __last__
298     for (my $i=1;$i<=$search_boxes_count;$i++) {
299         # if it's the first one, don't display boolean option, but show scan indexes
300         if ($i==1) {
301             push @search_boxes_array, {scan_index => 1};
302         }
303         # if it's the last one, show the 'add field' box
304         elsif ($i==$search_boxes_count) {
305             push @search_boxes_array,
306                 {
307                 boolean => 1,
308                 add_field => 1,
309                 };
310         }
311         else {
312             push @search_boxes_array,
313                 {
314                 boolean => 1,
315                 };
316         }
317
318     }
319     $template->param(uc(C4::Context->preference("marcflavour")) => 1,
320                       search_boxes_loop => \@search_boxes_array);
321
322     # load the language limits (for search)
323     my $languages_limit_loop = getLanguages($lang, 1);
324     $template->param(search_languages_loop => $languages_limit_loop,);
325
326     # Expanded search options in advanced search:
327     # use the global setting by default, but let the user override it
328     {
329         my $expanded = $cgi->param('expanded_options');
330         $expanded = C4::Context->preference("expandedSearchOption") || 0
331             if !defined($expanded) || $expanded !~ /^0|1$/;
332         $template->param( expanded_options => $expanded );
333     }
334
335     $template->param(virtualshelves => C4::Context->preference("virtualshelves"));
336
337     output_html_with_http_headers $cgi, $cookie, $template->output;
338     exit;
339 }
340
341 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
342
343 # Fetch the paramater list as a hash in scalar context:
344 #  * returns paramater list as tied hash ref
345 #  * we can edit the values by changing the key
346 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
347 my $params = $cgi->Vars;
348
349 # Params that can have more than one value
350 # sort by is used to sort the query
351 # in theory can have more than one but generally there's just one
352 my @sort_by;
353 my $default_sort_by;
354 if (   C4::Context->preference('defaultSortField')
355     && C4::Context->preference('defaultSortOrder') ) {
356     $default_sort_by =
357         C4::Context->preference('defaultSortField') . '_'
358       . C4::Context->preference('defaultSortOrder');
359 }
360
361 @sort_by = $cgi->multi_param('sort_by');
362 $sort_by[0] = $default_sort_by unless $sort_by[0];
363 foreach my $sort (@sort_by) {
364     $template->param($sort => 1) if $sort;
365 }
366 $template->param('sort_by' => $sort_by[0]);
367
368 # Use the servers defined, or just search our local catalog(default)
369 my @servers = $cgi->multi_param('server');
370 unless (@servers) {
371     #FIXME: this should be handled using Context.pm
372     @servers = ("biblioserver");
373     # @servers = C4::Context->config("biblioserver");
374 }
375 # operators include boolean and proximity operators and are used
376 # to evaluate multiple operands
377 my @operators = map uri_unescape($_), $cgi->multi_param('op');
378
379 # indexes are query qualifiers, like 'title', 'author', etc. They
380 # can be single or multiple parameters separated by comma: kw,right-Truncation 
381 my @indexes = map uri_unescape($_), $cgi->multi_param('idx');
382
383 # if a simple index (only one)  display the index used in the top search box
384 if ($indexes[0] && (!$indexes[1] || $params->{'scan'})) {
385     my $idx = "ms_".$indexes[0];
386     $idx =~ s/\,/comma/g;  # template toolkit doesn't like variables with a , in it
387     $idx =~ s/-/dash/g;  # template toolkit doesn't like variables with a dash in it
388     $template->param($idx => 1);
389 }
390
391 # an operand can be a single term, a phrase, or a complete ccl query
392 my @operands = map uri_unescape($_), $cgi->multi_param('q');
393
394 # if a simple search, display the value in the search box
395 if ($operands[0] && !$operands[1]) {
396     my $ms_query = $operands[0];
397     $ms_query =~ s/ #\S+//;
398     $template->param(ms_value => $ms_query);
399 }
400
401 # limits are use to limit to results to a pre-defined category such as branch or language
402 my @limits = map uri_unescape($_), $cgi->multi_param('limit');
403 my @nolimits = map uri_unescape($_), $cgi->multi_param('nolimit');
404 my %is_nolimit = map { $_ => 1 } @nolimits;
405 @limits = grep { not $is_nolimit{$_} } @limits;
406
407 if($params->{'multibranchlimit'}) {
408     my $search_group = Koha::Library::Groups->find( $params->{multibranchlimit} );
409     my @libraries = $search_group->all_libraries;
410     my $multibranch = '('.join( " or ", map { 'branch: ' . $_->branchcode } @libraries ) .')';
411     push @limits, $multibranch if ($multibranch ne  '()');
412 }
413
414 my $available;
415 foreach my $limit(@limits) {
416     if ($limit =~/available/) {
417         $available = 1;
418     }
419 }
420 $template->param(available => $available);
421
422 # append year limits if they exist
423 my $limit_yr;
424 my $limit_yr_value;
425 if ($params->{'limit-yr'}) {
426     if ($params->{'limit-yr'} =~ /\d{4}/) {
427         $limit_yr = "yr,st-numeric=$params->{'limit-yr'}";
428         $limit_yr_value = $params->{'limit-yr'};
429     }
430     push @limits,$limit_yr;
431     #FIXME: Should return a error to the user, incorect date format specified
432 }
433
434 # convert indexes and operands to corresponding parameter names for the z3950 search
435 # $ %z3950p will be a hash ref if the indexes are present (advacned search), otherwise undef
436 my $z3950par;
437 my $indexes2z3950 = {
438     kw=>'title', au=>'author', 'au,phr'=>'author', nb=>'isbn', ns=>'issn',
439     'lcn,phr'=>'dewey', su=>'subject', 'su,phr'=>'subject',
440     ti=>'title', 'ti,phr'=>'title', se=>'title'
441 };
442 for (my $ii = 0; $ii < @operands; ++$ii)
443 {
444     my $name = $indexes2z3950->{$indexes[$ii] || 'kw'};
445     if (defined $name && defined $operands[$ii])
446     {
447         $z3950par ||= {};
448         $z3950par->{$name} = $operands[$ii] if !exists $z3950par->{$name};
449     }
450 }
451
452
453 # Params that can only have one value
454 my $scan = $params->{'scan'};
455 my $count = C4::Context->preference('numSearchResults') || 20;
456 my $results_per_page = $params->{'count'} || $count;
457 my $offset = $params->{'offset'} || 0;
458 $offset = 0 if $offset < 0;
459 my $page = $cgi->param('page') || 1;
460 #my $offset = ($page-1)*$results_per_page;
461 my $expanded_facet = $params->{'expand'};
462
463 # Define some global variables
464 my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
465
466 my $builder = Koha::SearchEngine::QueryBuilder->new(
467     { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
468 my $searcher = Koha::SearchEngine::Search->new(
469     { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
470
471 ## I. BUILD THE QUERY
472 (
473     $error,             $query, $simple_query, $query_cgi,
474     $query_desc,        $limit, $limit_cgi,    $limit_desc,
475     $query_type
476   )
477   = $builder->build_query_compat( \@operators, \@operands, \@indexes, \@limits,
478     \@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 my $scan_search_term_to_use;
484
485 if ($query_cgi) {
486     for my $this_cgi ( split('&', $query_cgi) ) {
487         next unless $this_cgi;
488         $this_cgi =~ m/(.*?)=(.*)/;
489         my $input_name = $1;
490         my $input_value = $2;
491         push @query_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape( $input_value ) ) };
492         if ($input_name eq 'idx') {
493             $scan_index_to_use = $input_value; # unless $scan_index_to_use;
494         }
495         if ($input_name eq 'q') {
496             $scan_search_term_to_use = Encode::decode_utf8( uri_unescape( $input_value ));
497         }
498     }
499 }
500
501 $template->param ( QUERY_INPUTS => \@query_inputs,
502                    scan_index_to_use => $scan_index_to_use,
503                    scan_search_term_to_use => $scan_search_term_to_use );
504
505 ## parse the limit_cgi string and put it into a form suitable for <input>s
506 my @limit_inputs;
507 if ($limit_cgi) {
508     for my $this_cgi ( split('&', $limit_cgi) ) {
509         next unless $this_cgi;
510         # handle special case limit-yr
511         if ($this_cgi =~ /yr,st-numeric/) {
512             push @limit_inputs, { input_name => 'limit-yr', input_value => $limit_yr_value };
513             next;
514         }
515         $this_cgi =~ m/(.*=)(.*)/;
516         my $input_name = $1;
517         my $input_value = $2;
518         $input_name =~ s/=$//;
519         push @limit_inputs, { input_name => $input_name, input_value => Encode::decode_utf8( uri_unescape($input_value) ) };
520     }
521 }
522 $template->param ( LIMIT_INPUTS => \@limit_inputs );
523
524 ## II. DO THE SEARCH AND GET THE RESULTS
525 my $total = 0; # the total results for the whole set
526 my $facets; # this object stores the faceted results that display on the left-hand of the results page
527 my $results_hashref;
528
529 eval {
530     my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
531     ( $error, $results_hashref, $facets ) = $searcher->search_compat(
532         $query,            $simple_query, \@sort_by,       \@servers,
533         $results_per_page, $offset,       $expanded_facet, undef,
534         $itemtypes,        $query_type,   $scan
535     );
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         my $hits = $results_hashref->{$server}->{"hits"} // 0;
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 + $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             if ($limit_cgi) {
603                 my $limit_cgi_not_availablity = $limit_cgi;
604                 $limit_cgi_not_availablity =~ s/&limit=available//g;
605                 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
606             }
607             $template->param(limit_cgi => $limit_cgi);
608             $template->param(query_cgi => $query_cgi);
609             $template->param(query_desc => $query_desc);
610             $template->param(limit_desc => $limit_desc);
611             $template->param(offset     => $offset);
612             $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
613             if ($query_desc || $limit_desc) {
614                 $template->param(searchdesc => 1);
615             }
616             $template->param(results_per_page =>  $results_per_page);
617             # must define a value for size if not present in DB
618             # in order to avoid problems generated by the default size value in TT
619             foreach my $line (@newresults) {
620                 if ( not exists $line->{'size'} ) { $line->{'size'} = "" }
621                 # while we're checking each line, see if item is in the cart
622                 if ( grep {$_ eq $line->{'biblionumber'}} @cart_list) {
623                     $line->{'incart'} = 1;
624                 }
625             }
626             $template->param(SEARCH_RESULTS => \@newresults);
627             ## FIXME: add a global function for this, it's better than the current global one
628             ## Build the page numbers on the bottom of the page
629             my @page_numbers;
630             my $max_result_window = $searcher->max_result_window;
631             my $hits_to_paginate = ($max_result_window && $max_result_window < $hits) ? $max_result_window : $hits;
632             $template->param( hits_to_paginate => $hits_to_paginate );
633             # total number of pages there will be
634             my $pages = ceil($hits_to_paginate / $results_per_page);
635             my $last_page_offset = ( $pages -1 ) * $results_per_page;
636             # default page number
637             my $current_page_number = 1;
638             $current_page_number = ($offset / $results_per_page + 1) if $offset;
639             my $previous_page_offset;
640             if ( $offset >= $results_per_page ) {
641                 $previous_page_offset = $offset - $results_per_page;
642             }
643             my $next_page_offset = $offset + $results_per_page;
644             # If we're within the first 10 pages, keep it simple
645             #warn "current page:".$current_page_number;
646             if ($current_page_number < 10) {
647                 # just show the first 10 pages
648                 # Loop through the pages
649                 my $pages_to_show = 10;
650                 $pages_to_show = $pages if $pages<10;
651                 for (my $i=1; $i<=$pages_to_show;$i++) {
652                     # the offset for this page
653                     my $this_offset = (($i*$results_per_page)-$results_per_page);
654                     # the page number for this page
655                     my $this_page_number = $i;
656                     # put it in the array
657                     push @page_numbers,
658                       { offset    => $this_offset,
659                         pg        => $this_page_number,
660                         # it should only be highlighted if it's the current page
661                         highlight => $this_page_number == $current_page_number,
662                         sort_by   => join ' ', @sort_by
663                       };
664                                 
665                 }
666                         
667             }
668
669             # now, show twenty pages, with the current one smack in the middle
670             else {
671                 for (my $i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
672                     my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
673                     my $this_page_number = $i-9;
674                     if ( $this_page_number <= $pages ) {
675                         push @page_numbers,
676                           { offset    => $this_offset,
677                             pg        => $this_page_number,
678                             highlight => $this_page_number == $current_page_number,
679                             sort_by   => join ' ', @sort_by
680                           };
681                     }
682                 }
683             }
684             # FIXME: no previous_page_offset when pages < 2
685             $template->param(   PAGE_NUMBERS => \@page_numbers,
686                                 last_page_offset => $last_page_offset,
687                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
688             $template->param(   next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
689         }
690
691
692         # no hits
693         else {
694             $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
695         }
696
697     } # end of the if local
698
699     # asynchronously search the authority server
700     elsif ($server =~/authorityserver/) { # this is the local authority server
701         my @inner_sup_results_array;
702         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
703             my $marc_record_object = C4::Search::new_record_from_zebra(
704                 'authorityserver',
705                 $sup_record
706             );
707             # warn "Authority Found: ".$marc_record_object->as_formatted();
708             push @inner_sup_results_array, {
709                 'title' => $marc_record_object->field(100)->subfield('a'),
710                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
711             };
712         }
713         push @sup_results_array, {  servername => $server, 
714                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
715     }
716     # FIXME: can add support for other targets as needed here
717     $template->param(           outer_sup_results_loop => \@sup_results_array);
718 } #/end of the for loop
719 #$template->param(FEDERATED_RESULTS => \@results_array);
720
721 $template->{'VARS'}->{'searchid'} = $cgi->param('searchid');
722
723 my $gotonumber = $cgi->param('gotoNumber');
724 if ( $gotonumber && ( $gotonumber eq 'last' || $gotonumber eq 'first' ) ) {
725     $template->{'VARS'}->{'gotoNumber'} = $gotonumber;
726 }
727 $template->{'VARS'}->{'gotoPage'}   = 'detail.pl';
728 my $gotopage = $cgi->param('gotoPage');
729 $template->{'VARS'}->{'gotoPage'} = $gotopage
730   if $gotopage && $gotopage =~ m/^(ISBD|labeledMARC|MARC|more)?detail.pl$/;
731
732 for my $facet ( @$facets ) {
733     for my $entry ( @{ $facet->{facets} } ) {
734         my $index = $entry->{type_link_value};
735         my $value = $entry->{facet_link_value};
736         $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
737     }
738 }
739
740 $template->param(
741             #classlist => $classlist,
742             total => $total,
743             opacfacets => 1,
744             facets_loop => $facets,
745             displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
746             scan => $scan,
747             search_error => $error,
748 );
749
750 if ($query_desc || $limit_desc) {
751     $template->param(searchdesc => 1);
752 }
753
754 # VI. BUILD THE TEMPLATE
755
756 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
757     {
758         borrowernumber => $borrowernumber,
759         add_allowed    => 1,
760         category       => 1,
761     }
762 );
763 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
764     {
765         borrowernumber => $borrowernumber,
766         add_allowed    => 1,
767         category       => 2,
768     }
769 );
770
771
772 $template->param(
773     add_to_some_private_shelves => $some_private_shelves,
774     add_to_some_public_shelves  => $some_public_shelves,
775 );
776
777 output_html_with_http_headers $cgi, $cookie, $template->output;
778
779
780 =head2 prepare_adv_search_types
781
782     my $type = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
783     my @advanced_search_types = prepare_adv_search_types($type);
784
785 Different types can be searched for in the advanced search. This takes the
786 system preference that defines these types and parses it into an arrayref for
787 the template.
788
789 "itemtypes" is handled specially, as itemtypes aren't an authorised value.
790 It also accounts for the "item-level_itypes" system preference.
791
792 =cut
793
794 sub prepare_adv_search_types {
795     my ($types) = @_;
796
797     my @advanced_search_types = split( /\|/, $types );
798
799     # the index parameter is different for item-level itemtypes
800     my $itype_or_itemtype =
801       ( C4::Context->preference("item-level_itypes") ) ? 'itype' : 'itemtype';
802     my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
803
804     my ( $cnt, @result );
805     foreach my $advanced_srch_type (@advanced_search_types) {
806         $advanced_srch_type =~ s/^\s*//;
807         $advanced_srch_type =~ s/\s*$//;
808         if ( $advanced_srch_type eq 'itemtypes' ) {
809
810        # itemtype is a special case, since it's not defined in authorized values
811             my @itypesloop;
812             foreach my $thisitemtype (
813                 sort {
814                     $itemtypes->{$a}->{'translated_description'}
815                       cmp $itemtypes->{$b}->{'translated_description'}
816                 } keys %$itemtypes
817               )
818             {
819                 my %row = (
820                     number      => $cnt++,
821                     ccl         => "$itype_or_itemtype,phr",
822                     code        => $thisitemtype,
823                     description => $itemtypes->{$thisitemtype}->{'translated_description'},
824                     imageurl    => getitemtypeimagelocation(
825                         'intranet', $itemtypes->{$thisitemtype}->{'imageurl'}
826                     ),
827                 );
828                 push @itypesloop, \%row;
829             }
830             my %search_code = (
831                 advanced_search_type => $advanced_srch_type,
832                 code_loop            => \@itypesloop
833             );
834             push @result, \%search_code;
835         }
836         else {
837             # covers all the other cases: non-itemtype authorized values
838             my $advsearchtypes = GetAuthorisedValues($advanced_srch_type);
839             my @authvalueloop;
840             for my $thisitemtype (@$advsearchtypes) {
841                 my %row = (
842                     number      => $cnt++,
843                     ccl         => $advanced_srch_type,
844                     code        => $thisitemtype->{authorised_value},
845                     description => $thisitemtype->{'lib'},
846                     imageurl    => getitemtypeimagelocation(
847                         'intranet', $thisitemtype->{'imageurl'}
848                     ),
849                 );
850                 push @authvalueloop, \%row;
851             }
852             my %search_code = (
853                 advanced_search_type => $advanced_srch_type,
854                 code_loop            => \@authvalueloop
855             );
856             push @result, \%search_code;
857         }
858     }
859     return \@result;
860 }