Bug 10426: Remove unused sub GetCcodes from Koha.pm
[koha.git] / opac / opac-search.pl
blob76f4fda16df80a514c5ff9a4d2afa8bc66e13750
1 #!/usr/bin/perl
3 # Copyright 2008 Garry Collum and the Koha Development team
4 # Copyright 2010 BibLibre
5 # Copyright 2011 KohaAloha, NZ
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it under the
10 # terms of the GNU General Public License as published by the Free Software
11 # Foundation; either version 2 of the License, or (at your option) any later
12 # version.
14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License along
19 # with Koha; if not, write to the Free Software Foundation, Inc.,
20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 # Script to perform searching
23 # Mostly copied from search.pl, see POD there
24 use Modern::Perl;
26 ## STEP 1. Load things that are used in both search page and
27 # results page and decide which template to load, operations
28 # to perform, etc.
29 ## load Koha modules
30 use C4::Context;
32 my $searchengine = C4::Context->preference("SearchEngine");
33 for ( $searchengine ) {
34 when ( /^Solr$/ ) {
35 warn "We use Solr";
36 require 'opac/search.pl';
37 exit;
39 when ( /^Zebra$/ ) {
44 use C4::Output;
45 use C4::Auth qw(:DEFAULT get_session ParseSearchHistoryCookie);
46 use C4::Languages qw(getAllLanguages);
47 use C4::Search;
48 use C4::Biblio; # GetBiblioData
49 use C4::Koha;
50 use C4::Tags qw(get_tags);
51 use C4::Branch; # GetBranches
52 use C4::SocialData;
53 use C4::Ratings;
55 use POSIX qw(ceil floor strftime);
56 use URI::Escape;
57 use JSON qw/decode_json encode_json/;
58 use Business::ISBN;
60 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
61 # create a new CGI object
62 # FIXME: no_undef_params needs to be tested
63 use CGI qw('-no_undef_params');
64 my $cgi = new CGI;
66 my $branch_group_limit = $cgi->param("branch_group_limit");
67 if ( $branch_group_limit ) {
68 if ( $branch_group_limit =~ /^multibranchlimit-/ ) {
69 # For search groups we are going to convert this branch_group_limit CGI
70 # parameter into a multibranchlimit CGI parameter for the purposes of
71 # actually performing the query
72 $cgi->param(
73 -name => 'multibranchlimit',
74 -values => substr($branch_group_limit, 17)
76 } else {
77 $cgi->append(
78 -name => 'limit',
79 -values => [ $branch_group_limit ]
84 BEGIN {
85 if (C4::Context->preference('BakerTaylorEnabled')) {
86 require C4::External::BakerTaylor;
87 import C4::External::BakerTaylor qw(&image_url &link_url);
91 my ($template,$borrowernumber,$cookie);
92 my $lang = C4::Templates::getlanguage($cgi, 'opac');
93 # decide which template to use
94 my $template_name;
95 my $template_type = 'basic';
96 my @params = $cgi->param("limit");
99 my $format = $cgi->param("format") || '';
100 my $build_grouped_results = C4::Context->preference('OPACGroupResults');
101 if ($format =~ /(rss|atom|opensearchdescription)/) {
102 $template_name = 'opac-opensearch.tmpl';
104 elsif (@params && $build_grouped_results) {
105 $template_name = 'opac-results-grouped.tmpl';
107 elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
108 $template_name = 'opac-results.tmpl';
110 else {
111 $template_name = 'opac-advsearch.tmpl';
112 $template_type = 'advsearch';
114 # load the template
115 ($template, $borrowernumber, $cookie) = get_template_and_user({
116 template_name => $template_name,
117 query => $cgi,
118 type => "opac",
119 authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
122 if ($template_name eq 'opac-results.tmpl') {
123 $template->param('COinSinOPACResults' => C4::Context->preference('COinSinOPACResults'));
126 # get biblionumbers stored in the cart
127 my @cart_list;
129 if($cgi->cookie("bib_list")){
130 my $cart_list = $cgi->cookie("bib_list");
131 @cart_list = split(/\//, $cart_list);
134 if ($format eq 'rss2' or $format eq 'opensearchdescription' or $format eq 'atom') {
135 $template->param($format => 1);
136 $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime)) if ($format eq 'atom');
137 # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
138 # entry, but not sure if that's worth an extra database query for each bib
140 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
141 $template->param('UNIMARC' => 1);
143 elsif (C4::Context->preference("marcflavour") eq "MARC21" ) {
144 $template->param('usmarc' => 1);
146 $template->param( 'AllowOnShelfHolds' => C4::Context->preference('AllowOnShelfHolds') );
147 $template->param( 'OPACNoResultsFound' => C4::Context->preference('OPACNoResultsFound') );
149 $template->param(
150 OpacStarRatings => C4::Context->preference("OpacStarRatings") );
152 if (C4::Context->preference('BakerTaylorEnabled')) {
153 $template->param(
154 BakerTaylorEnabled => 1,
155 BakerTaylorImageURL => &image_url(),
156 BakerTaylorLinkURL => &link_url(),
157 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
161 if (C4::Context->preference('TagsEnabled')) {
162 $template->param(TagsEnabled => 1);
163 foreach (qw(TagsShowOnList TagsInputOnList)) {
164 C4::Context->preference($_) and $template->param($_ => 1);
168 ## URI Re-Writing
169 # Deprecated, but preserved because it's interesting :-)
170 # The same thing can be accomplished with mod_rewrite in
171 # a more elegant way
173 #my $rewrite_flag;
174 #my $uri = $cgi->url(-base => 1);
175 #my $relative_url = $cgi->url(-relative=>1);
176 #$uri.="/".$relative_url."?";
177 #warn "URI:$uri";
178 #my @cgi_params_list = $cgi->param();
179 #my $url_params = $cgi->Vars;
181 #for my $each_param_set (@cgi_params_list) {
182 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
184 #warn "New URI:$uri";
185 # Only re-write a URI if there are params or if it already hasn't been re-written
186 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
187 # print $cgi->redirect( -uri=>$uri."&r=1",
188 # -cookie => $cookie);
189 # exit;
192 # load the branches
194 my $branches = GetBranches(); # used later in *getRecords, probably should be internalized by those functions after caching in C4::Branch is established
195 $template->param(
196 searchdomainloop => GetBranchCategories('searchdomain'),
199 # load the language limits (for search)
200 my $languages_limit_loop = getAllLanguages($lang);
201 $template->param(search_languages_loop => $languages_limit_loop,);
203 # load the Type stuff
204 my $itemtypes = GetItemTypes;
205 # the index parameter is different for item-level itemtypes
206 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
207 my @advancedsearchesloop;
208 my $cnt;
209 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
210 my @advanced_search_types = split(/\|/, $advanced_search_types);
212 foreach my $advanced_srch_type (@advanced_search_types) {
213 if ($advanced_srch_type eq 'itemtypes') {
214 # itemtype is a special case, since it's not defined in authorized values
215 my @itypesloop;
216 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
217 my %row =( number=>$cnt++,
218 ccl => "$itype_or_itemtype,phr",
219 code => $thisitemtype,
220 description => $itemtypes->{$thisitemtype}->{'description'},
221 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
223 push @itypesloop, \%row;
225 my %search_code = ( advanced_search_type => $advanced_srch_type,
226 code_loop => \@itypesloop );
227 push @advancedsearchesloop, \%search_code;
228 } else {
229 # covers all the other cases: non-itemtype authorized values
230 my $advsearchtypes = GetAuthorisedValues($advanced_srch_type, '', 'opac');
231 my @authvalueloop;
232 for my $thisitemtype (@$advsearchtypes) {
233 my %row =(
234 number=>$cnt++,
235 ccl => $advanced_srch_type,
236 code => $thisitemtype->{authorised_value},
237 description => $thisitemtype->{'lib_opac'} || $thisitemtype->{'lib'},
238 imageurl => getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
240 push @authvalueloop, \%row;
242 my %search_code = ( advanced_search_type => $advanced_srch_type,
243 code_loop => \@authvalueloop );
244 push @advancedsearchesloop, \%search_code;
247 $template->param(advancedsearchesloop => \@advancedsearchesloop);
249 # The following should only be loaded if we're bringing up the advanced search template
250 if ( $template_type && $template_type eq 'advsearch' ) {
251 # load the servers (used for searching -- to do federated searching, etc.)
252 my $primary_servers_loop;# = displayPrimaryServers();
253 $template->param(outer_servers_loop => $primary_servers_loop,);
255 my $secondary_servers_loop;
256 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
258 # set the default sorting
259 if ( C4::Context->preference('OPACdefaultSortField')
260 && C4::Context->preference('OPACdefaultSortOrder') ) {
261 my $default_sort_by =
262 C4::Context->preference('OPACdefaultSortField') . '_'
263 . C4::Context->preference('OPACdefaultSortOrder');
264 $template->param( sort_by => $default_sort_by );
267 # determine what to display next to the search boxes (ie, boolean option
268 # shouldn't appear on the first one, scan indexes should, adding a new
269 # box should only appear on the last, etc.
270 my @search_boxes_array;
271 my $search_boxes_count = 3; # begin whith 3 boxes
272 for (my $i=1;$i<=$search_boxes_count;$i++) {
273 # if it's the first one, don't display boolean option, but show scan indexes
274 if ($i==1) {
275 push @search_boxes_array,
277 scan_index => 1,
281 # if it's the last one, show the 'add field' box
282 elsif ($i==$search_boxes_count) {
283 push @search_boxes_array,
285 boolean => 1,
286 add_field => 1,
289 else {
290 push @search_boxes_array,
292 boolean => 1,
297 $template->param(uc( C4::Context->preference("marcflavour")) => 1, # we already did this for UNIMARC
298 advsearch => 1,
299 search_boxes_loop => \@search_boxes_array);
301 # use the global setting by default
302 if ( C4::Context->preference("expandedSearchOption") == 1 ) {
303 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
305 # but let the user override it
306 if (defined $cgi->param('expanded_options')) {
307 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
308 $template->param( expanded_options => $cgi->param('expanded_options'));
312 if (C4::Context->preference('OPACNumbersPreferPhrase')) {
313 $template->param('numbersphr' => 1);
316 output_html_with_http_headers $cgi, $cookie, $template->output;
317 exit;
320 ### OK, if we're this far, we're performing an actual search
322 # Fetch the paramater list as a hash in scalar context:
323 # * returns paramater list as tied hash ref
324 # * we can edit the values by changing the key
325 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
326 my $params = $cgi->Vars;
327 my $tag;
328 $tag = $params->{tag} if $params->{tag};
331 # String with params with the search criteria for the paging in opac-detail
332 my $pasarParams = '';
333 my $j = 0;
334 for (keys %$params) {
335 my @pasarParam = $cgi->param($_);
336 for my $paramValue(@pasarParam) {
337 $pasarParams .= '&amp;' if ($j > 0);
338 $pasarParams .= $_ . '=' . $paramValue;
339 $j++;
343 # Params that can have more than one value
344 # sort by is used to sort the query
345 # in theory can have more than one but generally there's just one
346 my @sort_by;
347 my $default_sort_by;
348 if ( C4::Context->preference('OPACdefaultSortField')
349 && C4::Context->preference('OPACdefaultSortOrder') ) {
350 $default_sort_by =
351 C4::Context->preference('OPACdefaultSortField') . '_'
352 . C4::Context->preference('OPACdefaultSortOrder');
355 my @allowed_sortby = qw /acqdate_asc acqdate_dsc author_az author_za call_number_asc call_number_dsc popularity_asc popularity_dsc pubdate_asc pubdate_dsc relevance title_az title_za/;
356 @sort_by = $cgi->param('sort_by');
357 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
358 foreach my $sort (@sort_by) {
359 if ( $sort ~~ @allowed_sortby ) {
360 $template->param($sort => 1);
363 $template->param('sort_by' => $sort_by[0]);
365 # Use the servers defined, or just search our local catalog(default)
366 my @servers = $cgi->param('server');
367 unless (@servers) {
368 #FIXME: this should be handled using Context.pm
369 @servers = ("biblioserver");
370 # @servers = C4::Context->config("biblioserver");
373 # operators include boolean and proximity operators and are used
374 # to evaluate multiple operands
375 my @operators = $cgi->param('op');
376 @operators = map { uri_unescape($_) } @operators;
378 # indexes are query qualifiers, like 'title', 'author', etc. They
379 # can be single or multiple parameters separated by comma: kw,right-Truncation
380 my @indexes = $cgi->param('idx');
381 @indexes = map { uri_unescape($_) } @indexes;
383 # if a simple index (only one) display the index used in the top search box
384 if ($indexes[0] && !$indexes[1]) {
385 $template->param("ms_".$indexes[0] => 1);
387 # an operand can be a single term, a phrase, or a complete ccl query
388 my @operands = $cgi->param('q');
389 @operands = map { uri_unescape($_) } @operands;
391 $template->{VARS}->{querystring} = join(' ', @operands);
393 # if a simple search, display the value in the search box
394 if ($operands[0] && !$operands[1]) {
395 my $ms_query = $operands[0];
396 $ms_query =~ s/ #\S+//;
397 $template->param(ms_value => $ms_query);
400 # limits are use to limit to results to a pre-defined category such as branch or language
401 my @limits = $cgi->param('limit');
402 @limits = map { uri_unescape($_) } @limits;
404 if($params->{'multibranchlimit'}) {
405 my $multibranch = '('.join( " or ", map { "branch: $_ " } @{ GetBranchesInCategory( $params->{'multibranchlimit'} ) } ).')';
406 push @limits, $multibranch if ($multibranch ne '()');
409 my $available;
410 foreach my $limit(@limits) {
411 if ($limit =~/available/) {
412 $available = 1;
415 $template->param(available => $available);
417 # append year limits if they exist
418 if ($params->{'limit-yr'}) {
419 if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
420 my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
421 push @limits, "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
423 elsif ($params->{'limit-yr'} =~ /\d{4}/) {
424 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
426 else {
427 #FIXME: Should return a error to the user, incorect date format specified
431 # Params that can only have one value
432 my $scan = $params->{'scan'};
433 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
434 my $countRSS = C4::Context->preference('numSearchRSSResults') || 50;
435 my $results_per_page = $params->{'count'} || $count;
436 my $offset = $params->{'offset'} || 0;
437 my $page = $cgi->param('page') || 1;
438 $offset = ($page-1)*$results_per_page if $page>1;
439 my $hits;
440 my $expanded_facet = $params->{'expand'};
442 # Define some global variables
443 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
445 my @results;
447 ## I. BUILD THE QUERY
448 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by, 0, $lang);
450 sub _input_cgi_parse {
451 my @elements;
452 for my $this_cgi ( split('&',shift) ) {
453 next unless $this_cgi;
454 $this_cgi =~ /(.*?)=(.*)/;
455 push @elements, { input_name => $1, input_value => $2 };
457 return @elements;
460 ## parse the query_cgi string and put it into a form suitable for <input>s
461 my @query_inputs = _input_cgi_parse($query_cgi);
462 $template->param ( QUERY_INPUTS => \@query_inputs );
464 ## parse the limit_cgi string and put it into a form suitable for <input>s
465 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
467 # add OPAC 'hidelostitems'
468 #if (C4::Context->preference('hidelostitems') == 1) {
469 # # either lost ge 0 or no value in the lost register
470 # $query ="($query) and ( (lost,st-numeric <= 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='') )";
473 # add OPAC suppression - requires at least one item indexed with Suppress
474 if (C4::Context->preference('OpacSuppression')) {
475 # OPAC suppression by IP address
476 if (C4::Context->preference('OpacSuppressionByIPRange')) {
477 my $IPAddress = $ENV{'REMOTE_ADDR'};
478 my $IPRange = C4::Context->preference('OpacSuppressionByIPRange');
479 if ($IPAddress !~ /^$IPRange/) {
480 $query = "($query) not Suppress=1";
483 else {
484 $query = "($query) not Suppress=1";
488 $template->param ( LIMIT_INPUTS => \@limit_inputs );
489 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
491 ## II. DO THE SEARCH AND GET THE RESULTS
492 my $total = 0; # the total results for the whole set
493 my $facets; # this object stores the faceted results that display on the left-hand of the results page
494 my @results_array;
495 my $results_hashref;
496 my @coins;
498 if ($tag) {
499 $query_cgi = "tag=" .$tag . "&" . $query_cgi;
500 my $taglist = get_tags({term=>$tag, approved=>1});
501 $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
502 my @biblist = (map {GetBiblioData($_->{biblionumber})} @$taglist);
503 my @marclist = (map {$_->{marc}} @biblist );
504 $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
505 $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
506 # FIXME: tag search and standard search should work together, not exclusively
507 # FIXME: No facets for tags search.
508 } elsif ($build_grouped_results) {
509 eval {
510 ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
512 } else {
513 $pasarParams .= '&amp;query=' . $query;
514 $pasarParams .= '&amp;count=' . $results_per_page;
515 $pasarParams .= '&amp;simple_query=' . $simple_query;
516 $pasarParams .= '&amp;query_type=' . $query_type if ($query_type);
517 eval {
518 ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$itemtypes,$query_type,$scan,1);
521 # This sorts the facets into alphabetical order
522 if ($facets) {
523 foreach my $f (@$facets) {
524 $f->{facets} = [ sort { uc($a->{facet_title_value}) cmp uc($b->{facet_title_value}) } @{ $f->{facets} } ];
526 @$facets = sort {$a->{expand} cmp $b->{expand}} @$facets;
529 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
530 if ($@ || $error) {
531 $template->param(query_error => $error.$@);
532 output_html_with_http_headers $cgi, $cookie, $template->output;
533 exit;
536 # At this point, each server has given us a result set
537 # now we build that set for template display
538 my @sup_results_array;
539 for (my $i=0;$i<@servers;$i++) {
540 my $server = $servers[$i];
541 if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
542 $hits = $results_hashref->{$server}->{"hits"};
543 my $page = $cgi->param('page') || 0;
544 my @newresults;
545 if ($build_grouped_results) {
546 foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
547 # because pazGetRecords handles retieving only the records
548 # we want as specified by $offset and $results_per_page,
549 # we need to set the offset parameter of searchResults to 0
550 my @group_results = searchResults( 'opac', $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
551 $group->{"RECORDS"});
552 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
554 } else {
555 @newresults = searchResults('opac', $query_desc, $hits, $results_per_page, $offset, $scan,
556 $results_hashref->{$server}->{"RECORDS"});
559 foreach my $res (@newresults) {
561 # must define a value for size if not present in DB
562 # in order to avoid problems generated by the default size value in TT
563 if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
564 # while we're checking each line, see if item is in the cart
565 if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
566 $res->{'incart'} = 1;
569 if (C4::Context->preference('COinSinOPACResults')) {
570 my $record = GetMarcBiblio($res->{'biblionumber'});
571 $res->{coins} = GetCOinSBiblio($record);
573 if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
574 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
575 $isbn = $isbn->as_isbn13->as_string;
576 $isbn =~ s/-//g;
577 my $social_datas = C4::SocialData::get_data( $isbn );
578 if ( $social_datas ) {
579 for my $key ( keys %$social_datas ) {
580 $res->{$key} = $$social_datas{$key};
581 if ( $key eq 'score_avg' ){
582 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
589 if (C4::Context->preference('TagsEnabled') and
590 C4::Context->preference('TagsShowOnList')) {
591 if ( my $bibnum = $res->{biblionumber} ) {
592 $res->{itemsissued} = CountItemsIssued( $bibnum );
593 $res->{'TagLoop'} = get_tags({
594 biblionumber => $bibnum,
595 approved => 1,
596 sort => '-weight',
597 limit => C4::Context->preference('TagsShowOnList')
602 if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
603 my $rating = GetRating( $res->{'biblionumber'}, $borrowernumber );
604 $res->{'rating_value'} = $rating->{'rating_value'};
605 $res->{'rating_total'} = $rating->{'rating_total'};
606 $res->{'rating_avg'} = $rating->{'rating_avg'};
607 $res->{'rating_avg_int'} = $rating->{'rating_avg_int'};
611 if ($results_hashref->{$server}->{"hits"}){
612 $total = $total + $results_hashref->{$server}->{"hits"};
615 # Opac search history
616 my $newsearchcookie;
617 if (C4::Context->preference('EnableOpacSearchHistory')) {
618 my @recentSearches = ParseSearchHistoryCookie($cgi);
620 # Adding the new search if needed
621 my $path_info = $cgi->url(-path_info=>1);
622 my $query_cgi_history = $cgi->url(-query=>1);
623 $query_cgi_history =~ s/^$path_info\?//;
624 $query_cgi_history =~ s/;/&/g;
625 my $query_desc_history = "$query_desc, $limit_desc";
627 if (!$borrowernumber || $borrowernumber eq '') {
628 # To a cookie (the user is not logged in)
629 if (!$offset) {
630 push @recentSearches, {
631 "query_desc" => Encode::decode_utf8($query_desc_history) || "unknown",
632 "query_cgi" => Encode::decode_utf8($query_cgi_history) || "unknown",
633 "time" => time(),
634 "total" => $total
636 $template->param(ShowOpacRecentSearchLink => 1);
639 shift @recentSearches if (@recentSearches > 15);
640 # Pushing the cookie back
641 $newsearchcookie = $cgi->cookie(
642 -name => 'KohaOpacRecentSearches',
643 # We uri_escape the whole serialized structure so we're sure we won't have any encoding problems
644 -value => uri_escape( encode_json(\@recentSearches) ),
645 -expires => ''
647 $cookie = [$cookie, $newsearchcookie];
649 else {
650 # To the session (the user is logged in)
651 if (!$offset) {
652 AddSearchHistory($borrowernumber, $cgi->cookie("CGISESSID"), $query_desc_history, $query_cgi_history, $total);
653 $template->param(ShowOpacRecentSearchLink => 1);
657 ## If there's just one result, redirect to the detail page
658 if ($total == 1 && $format ne 'rss2'
659 && $format ne 'opensearchdescription' && $format ne 'atom') {
660 my $biblionumber=$newresults[0]->{biblionumber};
661 if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
662 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
663 } elsif (C4::Context->preference('BiblioDefaultView') eq 'marc') {
664 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
665 } else {
666 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
668 exit;
670 if ($hits) {
671 if ( !$build_grouped_results ) {
672 # We build the encrypted list of first OPACnumSearchResults biblios to pass with the search criteria for paging on opac-detail
673 $pasarParams .= '&amp;listBiblios=';
674 my $j = 0;
675 foreach (@newresults) {
676 my $bibnum = ($_->{biblionumber})?$_->{biblionumber}:0;
677 $pasarParams .= $bibnum . ',';
678 $j++;
679 last if ($j == $results_per_page);
681 chop $pasarParams if ($pasarParams =~ /,$/);
682 $pasarParams .= '&amp;total=' . int($total) if ($pasarParams !~ /total=(?:[0-9]+)?/);
683 if ($pasarParams) {
684 my $session = get_session($cgi->cookie("CGISESSID"));
685 $session->param('busc' => $pasarParams);
689 $template->param(total => $hits);
690 my $limit_cgi_not_availablity = $limit_cgi;
691 $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
692 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
693 $template->param(limit_cgi => $limit_cgi);
694 $template->param(countrss => $countRSS );
695 $template->param(query_cgi => $query_cgi);
696 $template->param(query_desc => $query_desc);
697 $template->param(limit_desc => $limit_desc);
698 $template->param(offset => $offset);
699 $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
700 if ($query_desc || $limit_desc) {
701 $template->param(searchdesc => 1);
703 $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
704 $template->param(results_per_page => $results_per_page);
705 my $hide = C4::Context->preference('OpacHiddenItems');
706 $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
707 my $branch = '';
708 if (C4::Context->userenv){
709 $branch = C4::Context->userenv->{branch};
711 if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
712 if (
713 ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
715 C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
717 my $branchname;
718 if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
719 $branchname = $branches->{$branch}->{'branchname'};
721 elsif ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
722 $branchname = $branches->{ $ENV{'BRANCHCODE'} }->{'branchname'};
725 foreach my $res ( @newresults ) {
726 my @new_loop;
727 my @top_loop;
728 my @old_loop = @{$res->{'available_items_loop'}};
729 foreach my $item ( @old_loop ) {
730 if ( $item->{'branchname'} eq $branchname ) {
731 $item->{'this_branch'} = 1;
732 push( @top_loop, $item );
733 } else {
734 push( @new_loop, $item );
737 my @complete_loop = ( @top_loop, @new_loop );
738 $res->{'available_items_loop'} = \@complete_loop;
743 $template->param(
744 SEARCH_RESULTS => \@newresults,
745 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
746 suppress_result_number => $hide,
748 if (C4::Context->preference("OPACLocalCoverImages")){
749 $template->param(OPACLocalCoverImages => 1);
750 $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
752 ## Build the page numbers on the bottom of the page
753 my @page_numbers;
754 # total number of pages there will be
755 my $pages = ceil($hits / $results_per_page);
756 # default page number
757 my $current_page_number = 1;
758 if ($offset) {
759 $current_page_number = ( $offset / $results_per_page + 1 );
761 my $previous_page_offset;
762 if ( $offset >= $results_per_page ) {
763 $previous_page_offset = $offset - $results_per_page;
765 my $next_page_offset = $offset + $results_per_page;
766 # If we're within the first 10 pages, keep it simple
767 #warn "current page:".$current_page_number;
768 if ($current_page_number < 10) {
769 # just show the first 10 pages
770 # Loop through the pages
771 my $pages_to_show = 10;
772 $pages_to_show = $pages if $pages<10;
773 for ($i=1; $i<=$pages_to_show;$i++) {
774 # the offset for this page
775 my $this_offset = (($i*$results_per_page)-$results_per_page);
776 # the page number for this page
777 my $this_page_number = $i;
778 # put it in the array
779 push @page_numbers,
780 { offset => $this_offset,
781 pg => $this_page_number,
782 highlight => $this_page_number == $current_page_number,
783 sort_by => join ' ', @sort_by
789 # now, show twenty pages, with the current one smack in the middle
790 else {
791 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
792 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
793 my $this_page_number = $i-9;
794 if ( $this_page_number <= $pages ) {
795 push @page_numbers,
796 { offset => $this_offset,
797 pg => $this_page_number,
798 highlight => $this_page_number == $current_page_number,
799 sort_by => join ' ', @sort_by
805 $template->param( PAGE_NUMBERS => \@page_numbers,
806 previous_page_offset => $previous_page_offset) unless $pages < 2;
807 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
809 # no hits
810 else {
811 my $nohits = C4::Context->preference('OPACNoResultsFound');
812 if ($nohits and $nohits=~/{QUERY_KW}/){
813 # extracting keywords in case of relaunching search
814 (my $query_kw=$query_desc)=~s/ and|or / /g;
815 $query_kw = Encode::decode_utf8($query_kw);
816 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^,:]|$)/g);
817 $query_kw=join('+',@query_kw);
818 $nohits=~s/{QUERY_KW}/$query_kw/g;
819 $template->param('OPACNoResultsFound' =>$nohits);
821 $template->param(
822 searchdesc => 1,
823 query_desc => $query_desc,
824 limit_desc => $limit_desc,
825 query_cgi => $query_cgi,
826 limit_cgi => $limit_cgi
829 } # end of the if local
830 # asynchronously search the authority server
831 elsif ($server && $server =~/authorityserver/) { # this is the local authority server
832 my @inner_sup_results_array;
833 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
834 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
835 my $title_field = $marc_record_object->field(100);
836 push @inner_sup_results_array, {
837 'title' => $title_field->subfield('a'),
838 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
841 my $servername = $server;
842 push @sup_results_array, { servername => $servername,
843 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
845 # FIXME: can add support for other targets as needed here
846 $template->param( outer_sup_results_loop => \@sup_results_array);
847 } #/end of the for loop
848 #$template->param(FEDERATED_RESULTS => \@results_array);
850 $template->param(
851 #classlist => $classlist,
852 total => $total,
853 opacfacets => 1,
854 facets_loop => $facets,
855 displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
856 scan => $scan,
857 search_error => $error,
860 if ($query_desc || $limit_desc) {
861 $template->param(searchdesc => 1);
864 # VI. BUILD THE TEMPLATE
865 # Build drop-down list for 'Add To:' menu...
866 my ($totalref, $pubshelves, $barshelves)=
867 C4::VirtualShelves::GetSomeShelfNames($borrowernumber,'COMBO',1);
868 $template->param(
869 addbarshelves => $totalref->{bartotal},
870 addbarshelvesloop => $barshelves,
871 addpubshelves => $totalref->{pubtotal},
872 addpubshelvesloop => $pubshelves,
875 my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
877 # If GoogleIndicTransliteration system preference is On Set paramter to load Google's javascript in OPAC search screens
878 if (C4::Context->preference('GoogleIndicTransliteration')) {
879 $template->param('GoogleIndicTransliteration' => 1);
882 $template->{VARS}->{DidYouMean} =
883 ( defined C4::Context->preference('OPACdidyoumean')
884 && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
885 $template->{VARS}->{IDreamBooksReviews} = C4::Context->preference('IDreamBooksReviews');
886 $template->{VARS}->{IDreamBooksReadometer} = C4::Context->preference('IDreamBooksReadometer');
887 $template->{VARS}->{IDreamBooksResults} = C4::Context->preference('IDreamBooksResults');
889 $template->param( borrowernumber => $borrowernumber);
890 output_with_http_headers $cgi, $cookie, $template->output, $content_type;