Bug 18688: Warnings about UTF-8 charset when creating a new language
[koha.git] / opac / opac-search.pl
blob96264e4452f792618af0664d5840d3091c83d664
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
10 # under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
14 # Koha is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
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;
31 use List::MoreUtils q/any/;
33 use Data::Dumper; # TODO remove
35 use Koha::SearchEngine::Search;
36 use Koha::SearchEngine::QueryBuilder;
38 my $searchengine = C4::Context->preference("SearchEngine");
39 my ($builder, $searcher);
40 #$searchengine = 'Zebra'; # XXX
41 $builder = Koha::SearchEngine::QueryBuilder->new({index => 'biblios'});
42 $searcher = Koha::SearchEngine::Search->new({index => 'biblios'});
44 use C4::Output;
45 use C4::Auth qw(:DEFAULT get_session);
46 use C4::Languages qw(getLanguages);
47 use C4::Search;
48 use C4::Search::History;
49 use C4::Biblio; # Unused here?
50 use C4::Koha;
51 use C4::Tags qw(get_tags);
52 use C4::SocialData;
53 use C4::External::OverDrive;
55 use Koha::Libraries;
56 use Koha::ItemTypes;
57 use Koha::Ratings;
58 use Koha::Virtualshelves;
59 use Koha::Library::Groups;
60 use Koha::Patrons;
61 use Koha::SearchFields;
63 use POSIX qw(ceil floor strftime);
64 use URI::Escape;
65 use JSON qw/decode_json encode_json/;
66 use Business::ISBN;
68 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
69 # create a new CGI object
70 # FIXME: no_undef_params needs to be tested
71 use CGI qw('-no_undef_params' -utf8);
72 my $cgi = new CGI;
74 my $branch_group_limit = $cgi->param("branch_group_limit");
75 if ( $branch_group_limit ) {
76 if ( $branch_group_limit =~ /^multibranchlimit-/ ) {
77 # For search groups we are going to convert this branch_group_limit CGI
78 # parameter into a multibranchlimit CGI parameter for the purposes of
79 # actually performing the query
80 $cgi->param(
81 -name => 'multibranchlimit',
82 -values => substr($branch_group_limit, 17)
84 } else {
85 $cgi->append(
86 -name => 'limit',
87 -values => [ $branch_group_limit ]
92 BEGIN {
93 if (C4::Context->preference('BakerTaylorEnabled')) {
94 require C4::External::BakerTaylor;
95 import C4::External::BakerTaylor qw(&image_url &link_url);
99 my ($template,$borrowernumber,$cookie);
100 # decide which template to use
101 my $template_name;
102 my $template_type = 'basic';
103 my @params = $cgi->multi_param("limit");
104 my @searchCategories = $cgi->multi_param('searchcat');
106 my $format = $cgi->param("format") || '';
107 my $build_grouped_results = C4::Context->preference('OPACGroupResults');
108 if ($format =~ /(rss|atom|opensearchdescription)/) {
109 $template_name = 'opac-opensearch.tt';
111 elsif (@params && $build_grouped_results) {
112 $template_name = 'opac-results-grouped.tt';
114 elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) || @searchCategories ) {
115 $template_name = 'opac-results.tt';
117 else {
118 $template_name = 'opac-advsearch.tt';
119 $template_type = 'advsearch';
122 $format = 'rss' if $format =~ /^rss2?$/;
124 # load the template
125 ($template, $borrowernumber, $cookie) = get_template_and_user({
126 template_name => $template_name,
127 query => $cgi,
128 type => "opac",
129 authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
132 my $patron = Koha::Patrons->find( $borrowernumber );
134 my $lang = C4::Languages::getlanguage($cgi);
136 if ($template_name eq 'opac-results.tt') {
137 $template->param('COinSinOPACResults' => C4::Context->preference('COinSinOPACResults'));
140 # get biblionumbers stored in the cart
141 my @cart_list;
143 if($cgi->cookie("bib_list")){
144 my $cart_list = $cgi->cookie("bib_list");
145 @cart_list = split(/\//, $cart_list);
148 if ($format eq 'rss' or $format eq 'opensearchdescription' or $format eq 'atom') {
149 $template->param($format => 1);
150 $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime)) if ($format eq 'atom');
151 # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
152 # entry, but not sure if that's worth an extra database query for each bib
154 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
155 $template->param('UNIMARC' => 1);
157 elsif (C4::Context->preference("marcflavour") eq "MARC21" ) {
158 $template->param('usmarc' => 1);
161 $template->param( 'OPACNoResultsFound' => C4::Context->preference('OPACNoResultsFound') );
163 $template->param(
164 OpacStarRatings => C4::Context->preference("OpacStarRatings") );
166 if (C4::Context->preference('BakerTaylorEnabled')) {
167 $template->param(
168 BakerTaylorEnabled => 1,
169 BakerTaylorImageURL => &image_url(),
170 BakerTaylorLinkURL => &link_url(),
171 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
175 if (C4::Context->preference('TagsEnabled')) {
176 $template->param(TagsEnabled => 1);
177 foreach (qw(TagsShowOnList TagsInputOnList)) {
178 C4::Context->preference($_) and $template->param($_ => 1);
182 ## URI Re-Writing
183 # Deprecated, but preserved because it's interesting :-)
184 # The same thing can be accomplished with mod_rewrite in
185 # a more elegant way
187 #my $rewrite_flag;
188 #my $uri = $cgi->url(-base => 1);
189 #my $relative_url = $cgi->url(-relative=>1);
190 #$uri.="/".$relative_url."?";
191 #warn "URI:$uri";
192 #my @cgi_params_list = $cgi->param();
193 #my $url_params = $cgi->Vars;
195 #for my $each_param_set (@cgi_params_list) {
196 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
198 #warn "New URI:$uri";
199 # Only re-write a URI if there are params or if it already hasn't been re-written
200 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
201 # print $cgi->redirect( -uri=>$uri."&r=1",
202 # -cookie => $cookie);
203 # exit;
206 # load the branches
208 if ($cgi->param("returntosearch")) {
209 $template->param('ReturnToSearch' => 1);
211 if ($cgi->cookie("search_path_code")) {
212 my $pathcode = $cgi->cookie("search_path_code");
213 if ($pathcode eq '"ads"') {
214 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?returntosearch=1');
216 elsif ($pathcode eq '"exs"') {
217 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?expanded_options=1&returntosearch=1');
219 else {
220 warn "ReturnPath switch error";
224 my @search_groups = Koha::Library::Groups->get_search_groups();
225 $template->param( search_groups => \@search_groups );
227 # load the language limits (for search)
228 my $languages_limit_loop = getLanguages($lang, 1);
229 $template->param(search_languages_loop => $languages_limit_loop,);
231 # load the Type stuff
232 my $itemtypes = GetItemTypesCategorized;
233 # add translated_description to itemtypes
234 foreach my $itemtype ( keys %{$itemtypes} ) {
235 # Itemtypes search categories don't have (yet) translated descriptions, they are auth values (and could still have no descriptions too BZ 18400)
236 # If 'iscat' (see ITEMTYPECAT) then there is no itemtype and the description is not translated
237 my $translated_description = $itemtypes->{$itemtype}->{iscat}
238 ? $itemtypes->{$itemtype}->{description}
239 : Koha::ItemTypes->find($itemtype)->translated_description;
240 $itemtypes->{$itemtype}->{translated_description} = $translated_description || $itemtypes->{$itemtype}->{description} || q{};
243 # the index parameter is different for item-level itemtypes
244 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
245 my @advancedsearchesloop;
246 my $cnt;
247 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
248 my @advanced_search_types = split(/\|/, $advanced_search_types);
250 my $hidingrules = {};
251 my $yaml = C4::Context->preference('OpacHiddenItems');
252 if ( $yaml =~ /\S/ ) {
253 $yaml = "$yaml\n\n"; # YAML expects trailing newline. Surplus does not hurt.
254 eval {
255 $hidingrules = YAML::Load($yaml);
257 if ($@) {
258 warn "Unable to parse OpacHiddenItems syspref : $@";
262 my @sorted_itemtypes = sort { $itemtypes->{$a}->{translated_description} cmp $itemtypes->{$b}->{translated_description} } keys %$itemtypes;
263 foreach my $advanced_srch_type (@advanced_search_types) {
264 $advanced_srch_type =~ s/^\s*//;
265 $advanced_srch_type =~ s/\s*$//;
266 if ($advanced_srch_type eq 'itemtypes') {
267 # itemtype is a special case, since it's not defined in authorized values
268 my @itypesloop;
269 foreach my $thisitemtype ( @sorted_itemtypes ) {
270 next if $hidingrules->{itype} && any { $_ eq $thisitemtype } @{$hidingrules->{itype}};
271 next if $hidingrules->{itemtype} && any { $_ eq $thisitemtype } @{$hidingrules->{itemtype}};
272 my %row =( number=>$cnt++,
273 ccl => "$itype_or_itemtype,phr",
274 code => $thisitemtype,
275 description => $itemtypes->{$thisitemtype}->{translated_description},
276 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
277 cat => $itemtypes->{$thisitemtype}->{'iscat'},
278 hideinopac => $itemtypes->{$thisitemtype}->{'hideinopac'},
279 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
281 if ( !$itemtypes->{$thisitemtype}->{'hideinopac'} ) {
282 push @itypesloop, \%row;
285 my %search_code = ( advanced_search_type => $advanced_srch_type,
286 code_loop => \@itypesloop );
287 push @advancedsearchesloop, \%search_code;
288 } else {
289 # covers all the other cases: non-itemtype authorized values
290 my $advsearchtypes = GetAuthorisedValues($advanced_srch_type, 'opac');
291 my @authvalueloop;
292 for my $thisitemtype (@$advsearchtypes) {
293 my $hiding_key = lc $thisitemtype->{category};
294 $hiding_key = "location" if $hiding_key eq 'loc';
295 next if $hidingrules->{$hiding_key} && any { $_ eq $thisitemtype->{authorised_value} } @{$hidingrules->{$hiding_key}};
296 my %row =(
297 number=>$cnt++,
298 ccl => $advanced_srch_type,
299 code => $thisitemtype->{authorised_value},
300 description => $thisitemtype->{'lib_opac'} || $thisitemtype->{'lib'},
301 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
302 imageurl => getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
304 push @authvalueloop, \%row;
306 my %search_code = ( advanced_search_type => $advanced_srch_type,
307 code_loop => \@authvalueloop );
308 push @advancedsearchesloop, \%search_code;
311 $template->param(advancedsearchesloop => \@advancedsearchesloop);
313 # The following should only be loaded if we're bringing up the advanced search template
314 if ( $template_type && $template_type eq 'advsearch' ) {
315 # load the servers (used for searching -- to do federated searching, etc.)
316 my $primary_servers_loop;# = displayPrimaryServers();
317 $template->param(outer_servers_loop => $primary_servers_loop,);
319 my $secondary_servers_loop;
320 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
322 # set the default sorting
323 if ( C4::Context->preference('OPACdefaultSortField')
324 && C4::Context->preference('OPACdefaultSortOrder') ) {
325 my $default_sort_by =
326 C4::Context->preference('OPACdefaultSortField') . '_'
327 . C4::Context->preference('OPACdefaultSortOrder');
328 $template->param( sort_by => $default_sort_by );
331 # determine what to display next to the search boxes (ie, boolean option
332 # shouldn't appear on the first one, scan indexes should, adding a new
333 # box should only appear on the last, etc.
334 my @search_boxes_array;
335 my $search_boxes_count = 3; # begin with 3 boxes
336 $template->param( search_boxes_count => $search_boxes_count );
338 if ($cgi->cookie("num_paragraph")){
339 $search_boxes_count = $cgi->cookie("num_paragraph");
342 for (my $i=1;$i<=$search_boxes_count;$i++) {
343 # if it's the first one, don't display boolean option, but show scan indexes
344 if ($i==1) {
345 push @search_boxes_array,
347 scan_index => 1,
351 # if it's the last one, show the 'add field' box
352 elsif ($i==$search_boxes_count) {
353 push @search_boxes_array,
355 boolean => 1,
356 add_field => 1,
359 else {
360 push @search_boxes_array,
362 boolean => 1,
368 my @advsearch_limits = split /,/, C4::Context->preference('OpacAdvSearchOptions');
369 my @advsearch_more_limits = split /,/,
370 C4::Context->preference('OpacAdvSearchMoreOptions');
371 $template->param(
372 uc( C4::Context->preference("marcflavour") ) => 1, # we already did this for UNIMARC
373 advsearch => 1,
374 search_boxes_loop => \@search_boxes_array,
375 OpacAdvSearchOptions => \@advsearch_limits,
376 OpacAdvSearchMoreOptions => \@advsearch_more_limits,
379 # use the global setting by default
380 if ( C4::Context->preference("expandedSearchOption") == 1 ) {
381 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
383 # but let the user override it
384 if (defined $cgi->param('expanded_options')) {
385 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
386 $template->param( expanded_options => scalar $cgi->param('expanded_options'));
391 output_html_with_http_headers $cgi, $cookie, $template->output;
392 exit;
395 ### OK, if we're this far, we're performing an actual search
397 # Fetch the paramater list as a hash in scalar context:
398 # * returns paramater list as tied hash ref
399 # * we can edit the values by changing the key
400 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
401 my $params = $cgi->Vars;
402 my $tag;
403 if ( $params->{tag} ) {
404 $tag = $params->{tag};
405 $template->param( tag => $tag );
408 # String with params with the search criteria for the paging in opac-detail
409 # param value is URI encoded and params separator is HTML encode (&amp;)
410 my $pasarParams = '';
411 my $j = 0;
412 for (keys %$params) {
413 my @pasarParam = $cgi->multi_param($_);
414 for my $paramValue(@pasarParam) {
415 $pasarParams .= '&amp;' if ($j > 0);
416 $pasarParams .= $_ . '=' . uri_escape_utf8($paramValue);
417 $j++;
421 # Params that can have more than one value
422 # sort by is used to sort the query
423 # in theory can have more than one but generally there's just one
424 my @sort_by;
425 my $default_sort_by;
426 if ( C4::Context->preference('OPACdefaultSortField')
427 && C4::Context->preference('OPACdefaultSortOrder') ) {
428 $default_sort_by =
429 C4::Context->preference('OPACdefaultSortField') . '_'
430 . C4::Context->preference('OPACdefaultSortOrder');
433 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/;
434 @sort_by = $cgi->multi_param('sort_by');
435 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
436 foreach my $sort (@sort_by) {
437 if ( grep { /^$sort$/ } @allowed_sortby ) {
438 $template->param($sort => 1);
441 $template->param('sort_by' => $sort_by[0]);
443 # Use the servers defined, or just search our local catalog(default)
444 my @servers = $cgi->multi_param('server');
445 unless (@servers) {
446 #FIXME: this should be handled using Context.pm
447 @servers = ("biblioserver");
448 # @servers = C4::Context->config("biblioserver");
451 # operators include boolean and proximity operators and are used
452 # to evaluate multiple operands
453 my @operators = $cgi->multi_param('op');
454 @operators = map { uri_unescape($_) } @operators;
456 # indexes are query qualifiers, like 'title', 'author', etc. They
457 # can be single or multiple parameters separated by comma: kw,right-Truncation
458 my @indexes = $cgi->multi_param('idx');
459 @indexes = map { uri_unescape($_) } @indexes;
461 # if a simple index (only one) display the index used in the top search box
462 if ($indexes[0] && !$indexes[1]) {
463 my $idx = "ms_".$indexes[0];
464 $idx =~ s/\,/comma/g; # template toolkit doesn't like variables with a , in it
465 $idx =~ s/-/dash/g; # template toolkit doesn't like variables with a dash in it
466 $template->param($idx => 1);
468 # an operand can be a single term, a phrase, or a complete ccl query
469 my @operands = $cgi->multi_param('q');
470 @operands = map { uri_unescape($_) } @operands;
472 $template->{VARS}->{querystring} = join(' ', @operands);
474 # if a simple search, display the value in the search box
475 if ($operands[0] && !$operands[1]) {
476 my $ms_query = $operands[0];
477 $ms_query =~ s/ #\S+//;
478 $template->param(ms_value => $ms_query);
481 # limits are use to limit to results to a pre-defined category such as branch or language
482 my @limits = $cgi->multi_param('limit');
483 @limits = map { uri_unescape($_) } @limits;
484 my @nolimits = $cgi->multi_param('nolimit');
485 @nolimits = map { uri_unescape($_) } @nolimits;
486 my %is_nolimit = map { $_ => 1 } @nolimits;
487 @limits = grep { not $is_nolimit{$_} } @limits;
489 if (@searchCategories > 0) {
490 my @tabcat;
491 foreach my $typecategory (@searchCategories) {
492 my @itemtypes = Koha::ItemTypes->search({ searchcategory => $typecategory });
493 push @tabcat, $_->itemtype for @itemtypes;
496 foreach my $itemtypeInCategory (@tabcat) {
497 push (@limits, "mc-$itype_or_itemtype,phr:".$itemtypeInCategory);
501 @limits = map { uri_unescape($_) } @limits;
503 if($params->{'multibranchlimit'}) {
504 my $search_group = Koha::Library::Groups->find( $params->{multibranchlimit} );
505 my @libraries = $search_group->all_libraries;
506 my $multibranch = '('.join( " or ", map { 'branch: ' . $_->branchcode } @libraries ) .')';
507 push @limits, $multibranch if ($multibranch ne '()');
510 my $available;
511 foreach my $limit(@limits) {
512 if ($limit =~/available/) {
513 $available = 1;
516 $template->param(available => $available);
518 # append year limits if they exist
519 if ($params->{'limit-yr'}) {
520 if ($params->{'limit-yr'} =~ /\d{4}/) {
521 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
523 else {
524 #FIXME: Should return a error to the user, incorect date format specified
528 # Params that can only have one value
529 my $scan = $params->{'scan'};
530 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
531 my $countRSS = C4::Context->preference('numSearchRSSResults') || 50;
532 my $results_per_page = $params->{'count'} || $count;
533 my $offset = $params->{'offset'} || 0;
534 $offset = 0 if $offset < 0;
535 my $page = $cgi->param('page') || 1;
536 $offset = ($page-1)*$results_per_page if $page>1;
537 my $hits;
539 # Define some global variables
540 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
542 my @results;
544 my $suppress = 0;
545 if (C4::Context->preference('OpacSuppression')) {
546 # OPAC suppression by IP address
547 if (C4::Context->preference('OpacSuppressionByIPRange')) {
548 my $IPAddress = $ENV{'REMOTE_ADDR'};
549 my $IPRange = C4::Context->preference('OpacSuppressionByIPRange');
550 $suppress = ($IPAddress !~ /^$IPRange/);
552 else {
553 $suppress = 1;
557 ## I. BUILD THE QUERY
558 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type)
559 = $builder->build_query_compat(
560 \@operators,
561 \@operands,
562 \@indexes,
563 \@limits,
564 \@sort_by,
566 $lang,
568 suppress => $suppress,
569 is_opac => 1,
570 weighted_fields => !$cgi->param('advsearch')
574 sub _input_cgi_parse {
575 my @elements;
576 my $query_cgi = shift or return @elements;
577 for my $this_cgi ( split('&',$query_cgi) ) {
578 next unless $this_cgi;
579 $this_cgi =~ /(.*?)=(.*)/;
580 push @elements, { input_name => $1, input_value => Encode::decode_utf8( uri_unescape($2) ) };
582 return @elements;
585 ## parse the query_cgi string and put it into a form suitable for <input>s
586 my @query_inputs = _input_cgi_parse($query_cgi);
587 $template->param ( QUERY_INPUTS => \@query_inputs );
589 ## parse the limit_cgi string and put it into a form suitable for <input>s
590 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
592 # OpenURL
593 my @OpenURL_itypes;
594 if (C4::Context->preference('OPACShowOpenURL')) {
595 @OpenURL_itypes = split( /\s/, C4::Context->preference('OPACOpenURLItemTypes') );
596 $template->param(
597 OPACShowOpenURL => 1,
598 OpenURLResolverURL => C4::Context->preference('OpenURLResolverURL'),
599 OpenURLText => C4::Context->preference('OpenURLText'),
600 OpenURLImageLocation => C4::Context->preference('OpenURLImageLocation')
604 $template->param ( LIMIT_INPUTS => \@limit_inputs );
605 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
607 ## II. DO THE SEARCH AND GET THE RESULTS
608 my $total = 0; # the total results for the whole set
609 my $facets; # this object stores the faceted results that display on the left-hand of the results page
610 my @results_array;
611 my $results_hashref;
612 my @coins;
614 if ($tag) {
615 $query_cgi = "tag=" . uri_escape_utf8( $tag ) . "&" . $query_cgi;
616 my $taglist = get_tags({term=>$tag, approved=>1});
617 $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
618 my @marclist = map { C4::Biblio::GetXmlBiblio( $_->{biblionumber} ) } @$taglist;
619 $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
620 $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
621 # FIXME: tag search and standard search should work together, not exclusively
622 # FIXME: Because search and standard search don't work together OpacHiddenItems
623 # displays search results which should be hidden.
624 # FIXME: No facets for tags search.
625 } elsif ($build_grouped_results) {
626 eval {
627 ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,undef,$query_type,$scan);
629 } else {
630 $pasarParams .= '&amp;query=' . uri_escape_utf8($query);
631 $pasarParams .= '&amp;count=' . uri_escape_utf8($results_per_page);
632 $pasarParams .= '&amp;simple_query=' . uri_escape_utf8($simple_query);
633 $pasarParams .= '&amp;query_type=' . uri_escape_utf8($query_type) if ($query_type);
634 my $itemtypes_nocategory = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
635 eval {
636 ($error, $results_hashref, $facets) = $searcher->search_compat($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,undef,$itemtypes_nocategory,$query_type,$scan,1);
640 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
641 if (not $tag and ( $@ || $error)) {
642 $template->param(query_error => $error.$@);
643 output_html_with_http_headers $cgi, $cookie, $template->output;
644 exit;
647 # At this point, each server has given us a result set
648 # now we build that set for template display
649 my @sup_results_array;
650 my $search_context = {};
651 $search_context->{'interface'} = 'opac';
652 if (C4::Context->preference('OpacHiddenItemsExceptions')){
653 $search_context->{'category'} = $patron ? $patron->categorycode : q{};
656 for (my $i=0;$i<@servers;$i++) {
657 my $server = $servers[$i];
658 if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
659 $hits = $results_hashref->{$server}->{"hits"};
660 my $page = $cgi->param('page') || 0;
661 my @newresults;
662 if ($build_grouped_results) {
663 foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
664 # because pazGetRecords handles retieving only the records
665 # we want as specified by $offset and $results_per_page,
666 # we need to set the offset parameter of searchResults to 0
667 my @group_results = searchResults( $search_context, $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
668 $group->{"RECORDS"});
669 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
671 } else {
672 @newresults = searchResults( $search_context, $query_desc, $hits, $results_per_page, $offset, $scan,
673 $results_hashref->{$server}->{"RECORDS"});
675 $hits = 0 unless @newresults;
677 my $art_req_itypes;
678 if( C4::Context->preference('ArticleRequests') ) {
679 $art_req_itypes = Koha::IssuingRules->guess_article_requestable_itemtypes({ $patron ? ( categorycode => $patron->categorycode ) : () });
682 foreach my $res (@newresults) {
684 # must define a value for size if not present in DB
685 # in order to avoid problems generated by the default size value in TT
686 if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
687 # while we're checking each line, see if item is in the cart
688 if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
689 $res->{'incart'} = 1;
692 if (C4::Context->preference('COinSinOPACResults')) {
693 my $biblio = Koha::Biblios->find( $res->{'biblionumber'} );
694 # Catch the exception as Koha::Biblio::Metadata->record can explode if the MARCXML is invalid
695 $res->{coins} = $biblio ? eval {$biblio->get_coins} : q{}; # FIXME This should be moved at the beginning of the @newresults loop
697 if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
698 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
699 $isbn = $isbn->as_isbn13->as_string;
700 $isbn =~ s/-//g;
701 my $social_datas = C4::SocialData::get_data( $isbn );
702 if ( $social_datas ) {
703 for my $key ( keys %$social_datas ) {
704 $res->{$key} = $$social_datas{$key};
705 if ( $key eq 'score_avg' ){
706 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
713 if (C4::Context->preference('TagsEnabled') and
714 C4::Context->preference('TagsShowOnList')) {
715 if ( my $bibnum = $res->{biblionumber} ) {
716 $res->{itemsissued} = CountItemsIssued( $bibnum );
717 $res->{'TagLoop'} = get_tags({
718 biblionumber => $bibnum,
719 approved => 1,
720 sort => '-weight',
721 limit => C4::Context->preference('TagsShowOnList')
726 $res->{shelves} = Koha::Virtualshelves->get_shelves_containing_record(
728 biblionumber => $res->{biblionumber},
729 borrowernumber => $borrowernumber
733 if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
734 my $ratings = Koha::Ratings->search({ biblionumber => $res->{biblionumber} });
735 $res->{ratings} = $ratings;
736 $res->{my_rating} = $borrowernumber ? $ratings->search({ borrowernumber => $borrowernumber })->next : undef;
739 # BZ17530: 'Intelligent' guess if result can be article requested
740 $res->{artreqpossible} = ( $art_req_itypes->{ $res->{itemtype} // q{} } || $art_req_itypes->{ '*' } ) ? 1 : q{};
743 if ($results_hashref->{$server}->{"hits"}){
744 $total = $total + $hits;
747 # Opac search history
748 if (C4::Context->preference('EnableOpacSearchHistory')) {
749 unless ( $offset ) {
750 my $path_info = $cgi->url(-path_info=>1);
751 my $query_cgi_history = $cgi->url(-query=>1);
752 $query_cgi_history =~ s/^$path_info\?//;
753 $query_cgi_history =~ s/;/&/g;
754 my $query_desc_history = join ", ", grep { defined $_ } $query_desc, $limit_desc;
756 unless ( $borrowernumber ) {
757 my $new_searches = C4::Search::History::add_to_session({
758 cgi => $cgi,
759 query_desc => $query_desc_history,
760 query_cgi => $query_cgi_history,
761 total => $total,
762 type => "biblio",
764 } else {
765 # To the session (the user is logged in)
766 C4::Search::History::add({
767 userid => $borrowernumber,
768 sessionid => $cgi->cookie("CGISESSID"),
769 query_desc => $query_desc_history,
770 query_cgi => $query_cgi_history,
771 total => $total,
772 type => "biblio",
776 $template->param( EnableOpacSearchHistory => 1 );
779 ## If there's just one result, redirect to the detail page
780 if ($total == 1 && $format ne 'rss'
781 && $format ne 'opensearchdescription' && $format ne 'atom') {
782 my $biblionumber=$newresults[0]->{biblionumber};
783 if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
784 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
785 } elsif (C4::Context->preference('BiblioDefaultView') eq 'marc') {
786 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
787 } else {
788 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
790 exit;
792 if ($hits) {
793 if ( !$build_grouped_results ) {
794 # We build the encrypted list of first OPACnumSearchResults biblios to pass with the search criteria for paging on opac-detail
795 $pasarParams .= '&amp;listBiblios=';
796 my $j = 0;
797 foreach (@newresults) {
798 my $bibnum = ($_->{biblionumber})?$_->{biblionumber}:0;
799 $pasarParams .= uri_escape_utf8($bibnum) . ',';
800 $j++;
801 last if ($j == $results_per_page);
803 chop $pasarParams if ($pasarParams =~ /,$/);
804 $pasarParams .= '&amp;total=' . uri_escape_utf8( int($total) ) if ($pasarParams !~ /total=(?:[0-9]+)?/);
805 if ($pasarParams) {
806 my $session = get_session($cgi->cookie("CGISESSID"));
807 $session->param('busc' => $pasarParams);
811 $template->param(total => $hits);
812 my $limit_cgi_not_availablity = $limit_cgi;
813 $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
814 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
815 $template->param(limit_cgi => $limit_cgi);
816 $template->param(countrss => $countRSS );
817 $template->param(query_cgi => $query_cgi);
818 $template->param(query_desc => $query_desc);
819 $template->param(limit_desc => $limit_desc);
820 $template->param(offset => $offset);
821 $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
822 if ($query_desc || $limit_desc) {
823 $template->param(searchdesc => 1);
825 $template->param(results_per_page => $results_per_page);
826 my $hide = C4::Context->preference('OpacHiddenItems');
827 $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
828 my $branch = '';
829 if (C4::Context->userenv){
830 $branch = C4::Context->userenv->{branch};
832 if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
833 if (
834 ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
836 C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
838 my $branchcode;
839 if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
840 $branchcode = $branch;
842 elsif ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
843 $branchcode = $ENV{'BRANCHCODE'};
846 foreach my $res ( @newresults ) {
847 my @new_loop;
848 my @top_loop;
849 my @old_loop = @{$res->{'available_items_loop'}};
850 foreach my $item ( @old_loop ) {
851 if ( $item->{'branchcode'} eq $branchcode ) {
852 $item->{'this_branch'} = 1;
853 push( @top_loop, $item );
854 } else {
855 push( @new_loop, $item );
858 my @complete_loop = ( @top_loop, @new_loop );
859 $res->{'available_items_loop'} = \@complete_loop;
864 $template->param(
865 SEARCH_RESULTS => \@newresults,
866 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
867 suppress_result_number => $hide,
869 if (C4::Context->preference("OPACLocalCoverImages")){
870 $template->param(OPACLocalCoverImages => 1);
871 $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
873 ## Build the page numbers on the bottom of the page
874 my @page_numbers;
875 my $max_result_window = $searcher->max_result_window;
876 my $hits_to_paginate = ($max_result_window && $max_result_window < $hits) ? $max_result_window : $hits;
877 $template->param( hits_to_paginate => $hits_to_paginate );
878 # total number of pages there will be
879 my $pages = ceil($hits_to_paginate / $results_per_page);
880 my $last_page_offset = ( $pages - 1 ) * $results_per_page;
881 # default page number
882 my $current_page_number = 1;
883 if ($offset) {
884 $current_page_number = ( $offset / $results_per_page + 1 );
886 my $previous_page_offset;
887 if ( $offset >= $results_per_page ) {
888 $previous_page_offset = $offset - $results_per_page;
890 my $next_page_offset = $offset + $results_per_page;
891 # If we're within the first 10 pages, keep it simple
892 #warn "current page:".$current_page_number;
893 if ($current_page_number < 10) {
894 # just show the first 10 pages
895 # Loop through the pages
896 my $pages_to_show = 10;
897 $pages_to_show = $pages if $pages<10;
898 for ($i=1; $i<=$pages_to_show;$i++) {
899 # the offset for this page
900 my $this_offset = (($i*$results_per_page)-$results_per_page);
901 # the page number for this page
902 my $this_page_number = $i;
903 # put it in the array
904 push @page_numbers,
905 { offset => $this_offset,
906 pg => $this_page_number,
907 highlight => $this_page_number == $current_page_number,
908 sort_by => join ' ', @sort_by
914 # now, show twenty pages, with the current one smack in the middle
915 else {
916 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
917 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
918 my $this_page_number = $i-9;
919 if ( $this_page_number <= $pages ) {
920 push @page_numbers,
921 { offset => $this_offset,
922 pg => $this_page_number,
923 highlight => $this_page_number == $current_page_number,
924 sort_by => join ' ', @sort_by
930 $template->param( PAGE_NUMBERS => \@page_numbers,
931 last_page_offset => $last_page_offset,
932 previous_page_offset => $previous_page_offset) unless $pages < 2;
933 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
935 # no hits
936 else {
937 my $nohits = C4::Context->preference('OPACNoResultsFound');
938 if ($nohits and $nohits=~/{QUERY_KW}/){
939 # extracting keywords in case of relaunching search
940 (my $query_kw=$query_desc)=~s/ and|or / /g;
941 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^,:]|$)/g);
942 $query_kw=join('+',@query_kw);
943 $nohits=~s/{QUERY_KW}/$query_kw/g;
944 $template->param('OPACNoResultsFound' =>$nohits);
946 $template->param(
947 searchdesc => 1,
948 query_desc => $query_desc,
949 limit_desc => $limit_desc,
950 query_cgi => $query_cgi,
951 limit_cgi => $limit_cgi
954 } # end of the if local
955 # asynchronously search the authority server
956 elsif ($server && $server =~/authorityserver/) { # this is the local authority server
957 my @inner_sup_results_array;
958 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
959 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
960 my $title_field = $marc_record_object->field(100);
961 push @inner_sup_results_array, {
962 'title' => $title_field->subfield('a'),
963 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
966 my $servername = $server;
967 push @sup_results_array, { servername => $servername,
968 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
970 # FIXME: can add support for other targets as needed here
971 $template->param( outer_sup_results_loop => \@sup_results_array);
972 } #/end of the for loop
973 #$template->param(FEDERATED_RESULTS => \@results_array);
975 for my $facet ( @$facets ) {
976 for my $entry ( @{ $facet->{facets} } ) {
977 my $index = $entry->{type_link_value};
978 my $value = $entry->{facet_link_value};
979 $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
984 $template->param(
985 #classlist => $classlist,
986 total => $total,
987 opacfacets => 1,
988 facets_loop => $facets,
989 displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
990 scan => $scan,
991 search_error => $error,
994 if ($query_desc || $limit_desc) {
995 $template->param(searchdesc => 1);
998 # VI. BUILD THE TEMPLATE
999 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
1001 borrowernumber => $borrowernumber,
1002 add_allowed => 1,
1003 category => 1,
1006 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1008 borrowernumber => $borrowernumber,
1009 add_allowed => 1,
1010 category => 2,
1014 $template->param(
1015 add_to_some_private_shelves => $some_private_shelves,
1016 add_to_some_public_shelves => $some_public_shelves,
1019 my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
1021 # If GoogleIndicTransliteration system preference is On Set parameter to load Google's javascript in OPAC search screens
1022 if (C4::Context->preference('GoogleIndicTransliteration')) {
1023 $template->param('GoogleIndicTransliteration' => 1);
1026 $template->{VARS}->{DidYouMean} =
1027 ( defined C4::Context->preference('OPACdidyoumean')
1028 && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
1029 $template->{VARS}->{IDreamBooksReviews} = C4::Context->preference('IDreamBooksReviews');
1030 $template->{VARS}->{IDreamBooksReadometer} = C4::Context->preference('IDreamBooksReadometer');
1031 $template->{VARS}->{IDreamBooksResults} = C4::Context->preference('IDreamBooksResults');
1033 if ($offset == 0) {
1034 $template->param(firstPage => 1);
1037 $template->param( borrowernumber => $borrowernumber);
1038 output_with_http_headers $cgi, $cookie, $template->output, $content_type;