Bug 11054: Specify UTF-8 encoding when creating a child record
[koha.git] / opac / opac-search.pl
blob2854da62030909fe16fbac7b915b891ee0c2529d
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;
54 use C4::External::OverDrive;
56 use POSIX qw(ceil floor strftime);
57 use URI::Escape;
58 use JSON qw/decode_json encode_json/;
59 use Business::ISBN;
61 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
62 # create a new CGI object
63 # FIXME: no_undef_params needs to be tested
64 use CGI qw('-no_undef_params');
65 my $cgi = new CGI;
67 my $branch_group_limit = $cgi->param("branch_group_limit");
68 if ( $branch_group_limit ) {
69 if ( $branch_group_limit =~ /^multibranchlimit-/ ) {
70 # For search groups we are going to convert this branch_group_limit CGI
71 # parameter into a multibranchlimit CGI parameter for the purposes of
72 # actually performing the query
73 $cgi->param(
74 -name => 'multibranchlimit',
75 -values => substr($branch_group_limit, 17)
77 } else {
78 $cgi->append(
79 -name => 'limit',
80 -values => [ $branch_group_limit ]
85 BEGIN {
86 if (C4::Context->preference('BakerTaylorEnabled')) {
87 require C4::External::BakerTaylor;
88 import C4::External::BakerTaylor qw(&image_url &link_url);
92 my ($template,$borrowernumber,$cookie);
93 my $lang = C4::Templates::getlanguage($cgi, 'opac');
94 # decide which template to use
95 my $template_name;
96 my $template_type = 'basic';
97 my @params = $cgi->param("limit");
100 my $format = $cgi->param("format") || '';
101 my $build_grouped_results = C4::Context->preference('OPACGroupResults');
102 if ($format =~ /(rss|atom|opensearchdescription)/) {
103 $template_name = 'opac-opensearch.tmpl';
105 elsif (@params && $build_grouped_results) {
106 $template_name = 'opac-results-grouped.tmpl';
108 elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
109 $template_name = 'opac-results.tmpl';
111 else {
112 $template_name = 'opac-advsearch.tmpl';
113 $template_type = 'advsearch';
115 # load the template
116 ($template, $borrowernumber, $cookie) = get_template_and_user({
117 template_name => $template_name,
118 query => $cgi,
119 type => "opac",
120 authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
123 if ($template_name eq 'opac-results.tmpl') {
124 $template->param('COinSinOPACResults' => C4::Context->preference('COinSinOPACResults'));
127 # get biblionumbers stored in the cart
128 my @cart_list;
130 if($cgi->cookie("bib_list")){
131 my $cart_list = $cgi->cookie("bib_list");
132 @cart_list = split(/\//, $cart_list);
135 if ($format eq 'rss2' or $format eq 'opensearchdescription' or $format eq 'atom') {
136 $template->param($format => 1);
137 $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime)) if ($format eq 'atom');
138 # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
139 # entry, but not sure if that's worth an extra database query for each bib
141 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
142 $template->param('UNIMARC' => 1);
144 elsif (C4::Context->preference("marcflavour") eq "MARC21" ) {
145 $template->param('usmarc' => 1);
147 $template->param( 'AllowOnShelfHolds' => C4::Context->preference('AllowOnShelfHolds') );
148 $template->param( 'OPACNoResultsFound' => C4::Context->preference('OPACNoResultsFound') );
150 $template->param(
151 OpacStarRatings => C4::Context->preference("OpacStarRatings") );
153 if (C4::Context->preference('BakerTaylorEnabled')) {
154 $template->param(
155 BakerTaylorEnabled => 1,
156 BakerTaylorImageURL => &image_url(),
157 BakerTaylorLinkURL => &link_url(),
158 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
162 if (C4::Context->preference('TagsEnabled')) {
163 $template->param(TagsEnabled => 1);
164 foreach (qw(TagsShowOnList TagsInputOnList)) {
165 C4::Context->preference($_) and $template->param($_ => 1);
169 ## URI Re-Writing
170 # Deprecated, but preserved because it's interesting :-)
171 # The same thing can be accomplished with mod_rewrite in
172 # a more elegant way
174 #my $rewrite_flag;
175 #my $uri = $cgi->url(-base => 1);
176 #my $relative_url = $cgi->url(-relative=>1);
177 #$uri.="/".$relative_url."?";
178 #warn "URI:$uri";
179 #my @cgi_params_list = $cgi->param();
180 #my $url_params = $cgi->Vars;
182 #for my $each_param_set (@cgi_params_list) {
183 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
185 #warn "New URI:$uri";
186 # Only re-write a URI if there are params or if it already hasn't been re-written
187 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
188 # print $cgi->redirect( -uri=>$uri."&r=1",
189 # -cookie => $cookie);
190 # exit;
193 # load the branches
195 my $branches = GetBranches(); # used later in *getRecords, probably should be internalized by those functions after caching in C4::Branch is established
196 $template->param(
197 searchdomainloop => GetBranchCategories('searchdomain'),
200 # load the language limits (for search)
201 my $languages_limit_loop = getAllLanguages($lang);
202 $template->param(search_languages_loop => $languages_limit_loop,);
204 # load the Type stuff
205 my $itemtypes = GetItemTypes;
206 # the index parameter is different for item-level itemtypes
207 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
208 my @advancedsearchesloop;
209 my $cnt;
210 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
211 my @advanced_search_types = split(/\|/, $advanced_search_types);
213 foreach my $advanced_srch_type (@advanced_search_types) {
214 if ($advanced_srch_type eq 'itemtypes') {
215 # itemtype is a special case, since it's not defined in authorized values
216 my @itypesloop;
217 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
218 my %row =( number=>$cnt++,
219 ccl => "$itype_or_itemtype,phr",
220 code => $thisitemtype,
221 description => $itemtypes->{$thisitemtype}->{'description'},
222 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
224 push @itypesloop, \%row;
226 my %search_code = ( advanced_search_type => $advanced_srch_type,
227 code_loop => \@itypesloop );
228 push @advancedsearchesloop, \%search_code;
229 } else {
230 # covers all the other cases: non-itemtype authorized values
231 my $advsearchtypes = GetAuthorisedValues($advanced_srch_type, '', 'opac');
232 my @authvalueloop;
233 for my $thisitemtype (@$advsearchtypes) {
234 my %row =(
235 number=>$cnt++,
236 ccl => $advanced_srch_type,
237 code => $thisitemtype->{authorised_value},
238 description => $thisitemtype->{'lib_opac'} || $thisitemtype->{'lib'},
239 imageurl => getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
241 push @authvalueloop, \%row;
243 my %search_code = ( advanced_search_type => $advanced_srch_type,
244 code_loop => \@authvalueloop );
245 push @advancedsearchesloop, \%search_code;
248 $template->param(advancedsearchesloop => \@advancedsearchesloop);
250 # The following should only be loaded if we're bringing up the advanced search template
251 if ( $template_type && $template_type eq 'advsearch' ) {
252 # load the servers (used for searching -- to do federated searching, etc.)
253 my $primary_servers_loop;# = displayPrimaryServers();
254 $template->param(outer_servers_loop => $primary_servers_loop,);
256 my $secondary_servers_loop;
257 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
259 # set the default sorting
260 if ( C4::Context->preference('OPACdefaultSortField')
261 && C4::Context->preference('OPACdefaultSortOrder') ) {
262 my $default_sort_by =
263 C4::Context->preference('OPACdefaultSortField') . '_'
264 . C4::Context->preference('OPACdefaultSortOrder');
265 $template->param( sort_by => $default_sort_by );
268 # determine what to display next to the search boxes (ie, boolean option
269 # shouldn't appear on the first one, scan indexes should, adding a new
270 # box should only appear on the last, etc.
271 my @search_boxes_array;
272 my $search_boxes_count = 3; # begin whith 3 boxes
273 for (my $i=1;$i<=$search_boxes_count;$i++) {
274 # if it's the first one, don't display boolean option, but show scan indexes
275 if ($i==1) {
276 push @search_boxes_array,
278 scan_index => 1,
282 # if it's the last one, show the 'add field' box
283 elsif ($i==$search_boxes_count) {
284 push @search_boxes_array,
286 boolean => 1,
287 add_field => 1,
290 else {
291 push @search_boxes_array,
293 boolean => 1,
298 $template->param(uc( C4::Context->preference("marcflavour")) => 1, # we already did this for UNIMARC
299 advsearch => 1,
300 search_boxes_loop => \@search_boxes_array);
302 # use the global setting by default
303 if ( C4::Context->preference("expandedSearchOption") == 1 ) {
304 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
306 # but let the user override it
307 if (defined $cgi->param('expanded_options')) {
308 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
309 $template->param( expanded_options => $cgi->param('expanded_options'));
313 if (C4::Context->preference('OPACNumbersPreferPhrase')) {
314 $template->param('numbersphr' => 1);
317 output_html_with_http_headers $cgi, $cookie, $template->output;
318 exit;
321 ### OK, if we're this far, we're performing an actual search
323 # Fetch the paramater list as a hash in scalar context:
324 # * returns paramater list as tied hash ref
325 # * we can edit the values by changing the key
326 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
327 my $params = $cgi->Vars;
328 my $tag;
329 $tag = $params->{tag} if $params->{tag};
332 # String with params with the search criteria for the paging in opac-detail
333 my $pasarParams = '';
334 my $j = 0;
335 for (keys %$params) {
336 my @pasarParam = $cgi->param($_);
337 for my $paramValue(@pasarParam) {
338 $pasarParams .= '&amp;' if ($j > 0);
339 $pasarParams .= $_ . '=' . $paramValue;
340 $j++;
344 # Params that can have more than one value
345 # sort by is used to sort the query
346 # in theory can have more than one but generally there's just one
347 my @sort_by;
348 my $default_sort_by;
349 if ( C4::Context->preference('OPACdefaultSortField')
350 && C4::Context->preference('OPACdefaultSortOrder') ) {
351 $default_sort_by =
352 C4::Context->preference('OPACdefaultSortField') . '_'
353 . C4::Context->preference('OPACdefaultSortOrder');
356 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/;
357 @sort_by = $cgi->param('sort_by');
358 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
359 foreach my $sort (@sort_by) {
360 if ( $sort ~~ @allowed_sortby ) {
361 $template->param($sort => 1);
364 $template->param('sort_by' => $sort_by[0]);
366 # Use the servers defined, or just search our local catalog(default)
367 my @servers = $cgi->param('server');
368 unless (@servers) {
369 #FIXME: this should be handled using Context.pm
370 @servers = ("biblioserver");
371 # @servers = C4::Context->config("biblioserver");
374 # operators include boolean and proximity operators and are used
375 # to evaluate multiple operands
376 my @operators = $cgi->param('op');
377 @operators = map { uri_unescape($_) } @operators;
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 = $cgi->param('idx');
382 @indexes = map { uri_unescape($_) } @indexes;
384 # if a simple index (only one) display the index used in the top search box
385 if ($indexes[0] && !$indexes[1]) {
386 $template->param("ms_".$indexes[0] => 1);
388 # an operand can be a single term, a phrase, or a complete ccl query
389 my @operands = $cgi->param('q');
390 @operands = map { uri_unescape($_) } @operands;
392 $template->{VARS}->{querystring} = join(' ', @operands);
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);
401 # limits are use to limit to results to a pre-defined category such as branch or language
402 my @limits = $cgi->param('limit');
403 @limits = map { uri_unescape($_) } @limits;
405 if($params->{'multibranchlimit'}) {
406 my $multibranch = '('.join( " or ", map { "branch: $_ " } @{ GetBranchesInCategory( $params->{'multibranchlimit'} ) } ).')';
407 push @limits, $multibranch if ($multibranch ne '()');
410 my $available;
411 foreach my $limit(@limits) {
412 if ($limit =~/available/) {
413 $available = 1;
416 $template->param(available => $available);
418 # append year limits if they exist
419 if ($params->{'limit-yr'}) {
420 if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
421 my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
422 push @limits, "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
424 elsif ($params->{'limit-yr'} =~ /\d{4}/) {
425 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
427 else {
428 #FIXME: Should return a error to the user, incorect date format specified
432 # Params that can only have one value
433 my $scan = $params->{'scan'};
434 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
435 my $countRSS = C4::Context->preference('numSearchRSSResults') || 50;
436 my $results_per_page = $params->{'count'} || $count;
437 my $offset = $params->{'offset'} || 0;
438 my $page = $cgi->param('page') || 1;
439 $offset = ($page-1)*$results_per_page if $page>1;
440 my $hits;
441 my $expanded_facet = $params->{'expand'};
443 # Define some global variables
444 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
446 my @results;
448 ## I. BUILD THE QUERY
449 ( $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);
451 sub _input_cgi_parse {
452 my @elements;
453 for my $this_cgi ( split('&',shift) ) {
454 next unless $this_cgi;
455 $this_cgi =~ /(.*?)=(.*)/;
456 push @elements, { input_name => $1, input_value => $2 };
458 return @elements;
461 ## parse the query_cgi string and put it into a form suitable for <input>s
462 my @query_inputs = _input_cgi_parse($query_cgi);
463 $template->param ( QUERY_INPUTS => \@query_inputs );
465 ## parse the limit_cgi string and put it into a form suitable for <input>s
466 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
468 # add OPAC 'hidelostitems'
469 #if (C4::Context->preference('hidelostitems') == 1) {
470 # # either lost ge 0 or no value in the lost register
471 # $query ="($query) and ( (lost,st-numeric <= 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='') )";
474 # add OPAC suppression - requires at least one item indexed with Suppress
475 if (C4::Context->preference('OpacSuppression')) {
476 # OPAC suppression by IP address
477 if (C4::Context->preference('OpacSuppressionByIPRange')) {
478 my $IPAddress = $ENV{'REMOTE_ADDR'};
479 my $IPRange = C4::Context->preference('OpacSuppressionByIPRange');
480 if ($IPAddress !~ /^$IPRange/) {
481 $query = "($query) not Suppress=1";
484 else {
485 $query = "($query) not Suppress=1";
489 $template->param ( LIMIT_INPUTS => \@limit_inputs );
490 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
492 ## II. DO THE SEARCH AND GET THE RESULTS
493 my $total = 0; # the total results for the whole set
494 my $facets; # this object stores the faceted results that display on the left-hand of the results page
495 my @results_array;
496 my $results_hashref;
497 my @coins;
499 if ($tag) {
500 $query_cgi = "tag=" .$tag . "&" . $query_cgi;
501 my $taglist = get_tags({term=>$tag, approved=>1});
502 $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
503 my @biblist = (map {GetBiblioData($_->{biblionumber})} @$taglist);
504 my @marclist = (map {$_->{marc}} @biblist );
505 $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
506 $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
507 # FIXME: tag search and standard search should work together, not exclusively
508 # FIXME: No facets for tags search.
509 } elsif ($build_grouped_results) {
510 eval {
511 ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
513 } else {
514 $pasarParams .= '&amp;query=' . $query;
515 $pasarParams .= '&amp;count=' . $results_per_page;
516 $pasarParams .= '&amp;simple_query=' . $simple_query;
517 $pasarParams .= '&amp;query_type=' . $query_type if ($query_type);
518 eval {
519 ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$itemtypes,$query_type,$scan,1);
522 # This sorts the facets into alphabetical order
523 if ($facets) {
524 foreach my $f (@$facets) {
525 $f->{facets} = [ sort { uc($a->{facet_title_value}) cmp uc($b->{facet_title_value}) } @{ $f->{facets} } ];
527 @$facets = sort {$a->{expand} cmp $b->{expand}} @$facets;
530 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
531 if ($@ || $error) {
532 $template->param(query_error => $error.$@);
533 output_html_with_http_headers $cgi, $cookie, $template->output;
534 exit;
537 # At this point, each server has given us a result set
538 # now we build that set for template display
539 my @sup_results_array;
540 for (my $i=0;$i<@servers;$i++) {
541 my $server = $servers[$i];
542 if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
543 $hits = $results_hashref->{$server}->{"hits"};
544 my $page = $cgi->param('page') || 0;
545 my @newresults;
546 if ($build_grouped_results) {
547 foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
548 # because pazGetRecords handles retieving only the records
549 # we want as specified by $offset and $results_per_page,
550 # we need to set the offset parameter of searchResults to 0
551 my @group_results = searchResults( 'opac', $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
552 $group->{"RECORDS"});
553 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
555 } else {
556 @newresults = searchResults('opac', $query_desc, $hits, $results_per_page, $offset, $scan,
557 $results_hashref->{$server}->{"RECORDS"});
560 foreach my $res (@newresults) {
562 # must define a value for size if not present in DB
563 # in order to avoid problems generated by the default size value in TT
564 if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
565 # while we're checking each line, see if item is in the cart
566 if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
567 $res->{'incart'} = 1;
570 if (C4::Context->preference('COinSinOPACResults')) {
571 my $record = GetMarcBiblio($res->{'biblionumber'});
572 $res->{coins} = GetCOinSBiblio($record);
574 if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
575 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
576 $isbn = $isbn->as_isbn13->as_string;
577 $isbn =~ s/-//g;
578 my $social_datas = C4::SocialData::get_data( $isbn );
579 if ( $social_datas ) {
580 for my $key ( keys %$social_datas ) {
581 $res->{$key} = $$social_datas{$key};
582 if ( $key eq 'score_avg' ){
583 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
590 if (C4::Context->preference('TagsEnabled') and
591 C4::Context->preference('TagsShowOnList')) {
592 if ( my $bibnum = $res->{biblionumber} ) {
593 $res->{itemsissued} = CountItemsIssued( $bibnum );
594 $res->{'TagLoop'} = get_tags({
595 biblionumber => $bibnum,
596 approved => 1,
597 sort => '-weight',
598 limit => C4::Context->preference('TagsShowOnList')
603 if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
604 my $rating = GetRating( $res->{'biblionumber'}, $borrowernumber );
605 $res->{'rating_value'} = $rating->{'rating_value'};
606 $res->{'rating_total'} = $rating->{'rating_total'};
607 $res->{'rating_avg'} = $rating->{'rating_avg'};
608 $res->{'rating_avg_int'} = $rating->{'rating_avg_int'};
612 if ($results_hashref->{$server}->{"hits"}){
613 $total = $total + $results_hashref->{$server}->{"hits"};
616 # Opac search history
617 my $newsearchcookie;
618 if (C4::Context->preference('EnableOpacSearchHistory')) {
619 my @recentSearches = ParseSearchHistoryCookie($cgi);
621 # Adding the new search if needed
622 my $path_info = $cgi->url(-path_info=>1);
623 my $query_cgi_history = $cgi->url(-query=>1);
624 $query_cgi_history =~ s/^$path_info\?//;
625 $query_cgi_history =~ s/;/&/g;
626 my $query_desc_history = "$query_desc, $limit_desc";
628 if (!$borrowernumber || $borrowernumber eq '') {
629 # To a cookie (the user is not logged in)
630 if (!$offset) {
631 push @recentSearches, {
632 "query_desc" => Encode::decode_utf8($query_desc_history) || "unknown",
633 "query_cgi" => Encode::decode_utf8($query_cgi_history) || "unknown",
634 "time" => time(),
635 "total" => $total
637 $template->param(ShowOpacRecentSearchLink => 1);
640 shift @recentSearches if (@recentSearches > 15);
641 # Pushing the cookie back
642 $newsearchcookie = $cgi->cookie(
643 -name => 'KohaOpacRecentSearches',
644 # We uri_escape the whole serialized structure so we're sure we won't have any encoding problems
645 -value => uri_escape( encode_json(\@recentSearches) ),
646 -expires => ''
648 $cookie = [$cookie, $newsearchcookie];
650 else {
651 # To the session (the user is logged in)
652 if (!$offset) {
653 AddSearchHistory($borrowernumber, $cgi->cookie("CGISESSID"), $query_desc_history, $query_cgi_history, $total);
654 $template->param(ShowOpacRecentSearchLink => 1);
658 ## If there's just one result, redirect to the detail page
659 if ($total == 1 && $format ne 'rss2'
660 && $format ne 'opensearchdescription' && $format ne 'atom') {
661 my $biblionumber=$newresults[0]->{biblionumber};
662 if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
663 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
664 } elsif (C4::Context->preference('BiblioDefaultView') eq 'marc') {
665 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
666 } else {
667 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
669 exit;
671 if ($hits) {
672 if ( !$build_grouped_results ) {
673 # We build the encrypted list of first OPACnumSearchResults biblios to pass with the search criteria for paging on opac-detail
674 $pasarParams .= '&amp;listBiblios=';
675 my $j = 0;
676 foreach (@newresults) {
677 my $bibnum = ($_->{biblionumber})?$_->{biblionumber}:0;
678 $pasarParams .= $bibnum . ',';
679 $j++;
680 last if ($j == $results_per_page);
682 chop $pasarParams if ($pasarParams =~ /,$/);
683 $pasarParams .= '&amp;total=' . int($total) if ($pasarParams !~ /total=(?:[0-9]+)?/);
684 if ($pasarParams) {
685 my $session = get_session($cgi->cookie("CGISESSID"));
686 $session->param('busc' => $pasarParams);
690 $template->param(total => $hits);
691 my $limit_cgi_not_availablity = $limit_cgi;
692 $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
693 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
694 $template->param(limit_cgi => $limit_cgi);
695 $template->param(countrss => $countRSS );
696 $template->param(query_cgi => $query_cgi);
697 $template->param(query_desc => $query_desc);
698 $template->param(limit_desc => $limit_desc);
699 $template->param(offset => $offset);
700 $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
701 if ($query_desc || $limit_desc) {
702 $template->param(searchdesc => 1);
704 $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
705 $template->param(results_per_page => $results_per_page);
706 my $hide = C4::Context->preference('OpacHiddenItems');
707 $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
708 my $branch = '';
709 if (C4::Context->userenv){
710 $branch = C4::Context->userenv->{branch};
712 if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
713 if (
714 ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
716 C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
718 my $branchname;
719 if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
720 $branchname = $branches->{$branch}->{'branchname'};
722 elsif ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
723 $branchname = $branches->{ $ENV{'BRANCHCODE'} }->{'branchname'};
726 foreach my $res ( @newresults ) {
727 my @new_loop;
728 my @top_loop;
729 my @old_loop = @{$res->{'available_items_loop'}};
730 foreach my $item ( @old_loop ) {
731 if ( $item->{'branchname'} eq $branchname ) {
732 $item->{'this_branch'} = 1;
733 push( @top_loop, $item );
734 } else {
735 push( @new_loop, $item );
738 my @complete_loop = ( @top_loop, @new_loop );
739 $res->{'available_items_loop'} = \@complete_loop;
744 $template->param(
745 SEARCH_RESULTS => \@newresults,
746 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
747 suppress_result_number => $hide,
749 if (C4::Context->preference("OPACLocalCoverImages")){
750 $template->param(OPACLocalCoverImages => 1);
751 $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
753 ## Build the page numbers on the bottom of the page
754 my @page_numbers;
755 # total number of pages there will be
756 my $pages = ceil($hits / $results_per_page);
757 # default page number
758 my $current_page_number = 1;
759 if ($offset) {
760 $current_page_number = ( $offset / $results_per_page + 1 );
762 my $previous_page_offset;
763 if ( $offset >= $results_per_page ) {
764 $previous_page_offset = $offset - $results_per_page;
766 my $next_page_offset = $offset + $results_per_page;
767 # If we're within the first 10 pages, keep it simple
768 #warn "current page:".$current_page_number;
769 if ($current_page_number < 10) {
770 # just show the first 10 pages
771 # Loop through the pages
772 my $pages_to_show = 10;
773 $pages_to_show = $pages if $pages<10;
774 for ($i=1; $i<=$pages_to_show;$i++) {
775 # the offset for this page
776 my $this_offset = (($i*$results_per_page)-$results_per_page);
777 # the page number for this page
778 my $this_page_number = $i;
779 # put it in the array
780 push @page_numbers,
781 { offset => $this_offset,
782 pg => $this_page_number,
783 highlight => $this_page_number == $current_page_number,
784 sort_by => join ' ', @sort_by
790 # now, show twenty pages, with the current one smack in the middle
791 else {
792 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
793 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
794 my $this_page_number = $i-9;
795 if ( $this_page_number <= $pages ) {
796 push @page_numbers,
797 { offset => $this_offset,
798 pg => $this_page_number,
799 highlight => $this_page_number == $current_page_number,
800 sort_by => join ' ', @sort_by
806 $template->param( PAGE_NUMBERS => \@page_numbers,
807 previous_page_offset => $previous_page_offset) unless $pages < 2;
808 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
810 # no hits
811 else {
812 my $nohits = C4::Context->preference('OPACNoResultsFound');
813 if ($nohits and $nohits=~/{QUERY_KW}/){
814 # extracting keywords in case of relaunching search
815 (my $query_kw=$query_desc)=~s/ and|or / /g;
816 $query_kw = Encode::decode_utf8($query_kw);
817 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^,:]|$)/g);
818 $query_kw=join('+',@query_kw);
819 $nohits=~s/{QUERY_KW}/$query_kw/g;
820 $template->param('OPACNoResultsFound' =>$nohits);
822 $template->param(
823 searchdesc => 1,
824 query_desc => $query_desc,
825 limit_desc => $limit_desc,
826 query_cgi => $query_cgi,
827 limit_cgi => $limit_cgi
830 } # end of the if local
831 # asynchronously search the authority server
832 elsif ($server && $server =~/authorityserver/) { # this is the local authority server
833 my @inner_sup_results_array;
834 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
835 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
836 my $title_field = $marc_record_object->field(100);
837 push @inner_sup_results_array, {
838 'title' => $title_field->subfield('a'),
839 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
842 my $servername = $server;
843 push @sup_results_array, { servername => $servername,
844 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
846 # FIXME: can add support for other targets as needed here
847 $template->param( outer_sup_results_loop => \@sup_results_array);
848 } #/end of the for loop
849 #$template->param(FEDERATED_RESULTS => \@results_array);
851 $template->param(
852 #classlist => $classlist,
853 total => $total,
854 opacfacets => 1,
855 facets_loop => $facets,
856 displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
857 scan => $scan,
858 search_error => $error,
861 if ($query_desc || $limit_desc) {
862 $template->param(searchdesc => 1);
865 # VI. BUILD THE TEMPLATE
866 # Build drop-down list for 'Add To:' menu...
867 my ($totalref, $pubshelves, $barshelves)=
868 C4::VirtualShelves::GetSomeShelfNames($borrowernumber,'COMBO',1);
869 $template->param(
870 addbarshelves => $totalref->{bartotal},
871 addbarshelvesloop => $barshelves,
872 addpubshelves => $totalref->{pubtotal},
873 addpubshelvesloop => $pubshelves,
876 my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
878 # If GoogleIndicTransliteration system preference is On Set paramter to load Google's javascript in OPAC search screens
879 if (C4::Context->preference('GoogleIndicTransliteration')) {
880 $template->param('GoogleIndicTransliteration' => 1);
883 $template->{VARS}->{DidYouMean} =
884 ( defined C4::Context->preference('OPACdidyoumean')
885 && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
886 $template->{VARS}->{IDreamBooksReviews} = C4::Context->preference('IDreamBooksReviews');
887 $template->{VARS}->{IDreamBooksReadometer} = C4::Context->preference('IDreamBooksReadometer');
888 $template->{VARS}->{IDreamBooksResults} = C4::Context->preference('IDreamBooksResults');
890 if ($offset == 0 && IsOverDriveEnabled()) {
891 $template->param(OverDriveEnabled => 1);
892 $template->param(OverDriveLibraryID => C4::Context->preference('OverDriveLibraryID'));
895 $template->param( borrowernumber => $borrowernumber);
896 output_with_http_headers $cgi, $cookie, $template->output, $content_type;