Bug 11936: (QA follow-up) Consistent log message for item insert
[koha.git] / opac / opac-search.pl
blobf06e40a6fa317b90da67371572c8fca14e70bbe2
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::ItemTypes;
56 use Koha::Ratings;
57 use Koha::Virtualshelves;
58 use Koha::Library::Groups;
60 use POSIX qw(ceil floor strftime);
61 use URI::Escape;
62 use JSON qw/decode_json encode_json/;
63 use Business::ISBN;
65 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
66 # create a new CGI object
67 # FIXME: no_undef_params needs to be tested
68 use CGI qw('-no_undef_params' -utf8);
69 my $cgi = new CGI;
71 my $branch_group_limit = $cgi->param("branch_group_limit");
72 if ( $branch_group_limit ) {
73 if ( $branch_group_limit =~ /^multibranchlimit-/ ) {
74 # For search groups we are going to convert this branch_group_limit CGI
75 # parameter into a multibranchlimit CGI parameter for the purposes of
76 # actually performing the query
77 $cgi->param(
78 -name => 'multibranchlimit',
79 -values => substr($branch_group_limit, 17)
81 } else {
82 $cgi->append(
83 -name => 'limit',
84 -values => [ $branch_group_limit ]
89 BEGIN {
90 if (C4::Context->preference('BakerTaylorEnabled')) {
91 require C4::External::BakerTaylor;
92 import C4::External::BakerTaylor qw(&image_url &link_url);
96 my ($template,$borrowernumber,$cookie);
97 # decide which template to use
98 my $template_name;
99 my $template_type = 'basic';
100 my @params = $cgi->multi_param("limit");
101 my @searchCategories = $cgi->multi_param('searchcat');
103 my $format = $cgi->param("format") || '';
104 my $build_grouped_results = C4::Context->preference('OPACGroupResults');
105 if ($format =~ /(rss|atom|opensearchdescription)/) {
106 $template_name = 'opac-opensearch.tt';
108 elsif (@params && $build_grouped_results) {
109 $template_name = 'opac-results-grouped.tt';
111 elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
112 $template_name = 'opac-results.tt';
114 else {
115 $template_name = 'opac-advsearch.tt';
116 $template_type = 'advsearch';
118 # load the template
119 ($template, $borrowernumber, $cookie) = get_template_and_user({
120 template_name => $template_name,
121 query => $cgi,
122 type => "opac",
123 authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
127 my $lang = C4::Languages::getlanguage($cgi);
129 if ($template_name eq 'opac-results.tt') {
130 $template->param('COinSinOPACResults' => C4::Context->preference('COinSinOPACResults'));
133 # get biblionumbers stored in the cart
134 my @cart_list;
136 if($cgi->cookie("bib_list")){
137 my $cart_list = $cgi->cookie("bib_list");
138 @cart_list = split(/\//, $cart_list);
141 if ($format eq 'rss2' or $format eq 'opensearchdescription' or $format eq 'atom') {
142 $template->param($format => 1);
143 $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime)) if ($format eq 'atom');
144 # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
145 # entry, but not sure if that's worth an extra database query for each bib
147 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
148 $template->param('UNIMARC' => 1);
150 elsif (C4::Context->preference("marcflavour") eq "MARC21" ) {
151 $template->param('usmarc' => 1);
154 $template->param( 'OPACNoResultsFound' => C4::Context->preference('OPACNoResultsFound') );
156 $template->param(
157 OpacStarRatings => C4::Context->preference("OpacStarRatings") );
159 if (C4::Context->preference('BakerTaylorEnabled')) {
160 $template->param(
161 BakerTaylorEnabled => 1,
162 BakerTaylorImageURL => &image_url(),
163 BakerTaylorLinkURL => &link_url(),
164 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
168 if (C4::Context->preference('TagsEnabled')) {
169 $template->param(TagsEnabled => 1);
170 foreach (qw(TagsShowOnList TagsInputOnList)) {
171 C4::Context->preference($_) and $template->param($_ => 1);
175 ## URI Re-Writing
176 # Deprecated, but preserved because it's interesting :-)
177 # The same thing can be accomplished with mod_rewrite in
178 # a more elegant way
180 #my $rewrite_flag;
181 #my $uri = $cgi->url(-base => 1);
182 #my $relative_url = $cgi->url(-relative=>1);
183 #$uri.="/".$relative_url."?";
184 #warn "URI:$uri";
185 #my @cgi_params_list = $cgi->param();
186 #my $url_params = $cgi->Vars;
188 #for my $each_param_set (@cgi_params_list) {
189 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
191 #warn "New URI:$uri";
192 # Only re-write a URI if there are params or if it already hasn't been re-written
193 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
194 # print $cgi->redirect( -uri=>$uri."&r=1",
195 # -cookie => $cookie);
196 # exit;
199 # load the branches
201 if ($cgi->param("returntosearch")) {
202 $template->param('ReturnToSearch' => 1);
204 if ($cgi->cookie("search_path_code")) {
205 my $pathcode = $cgi->cookie("search_path_code");
206 if ($pathcode eq '"ads"') {
207 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?returntosearch=1');
209 elsif ($pathcode eq '"exs"') {
210 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?expanded_options=1&returntosearch=1');
212 else {
213 warn "ReturnPath switch error";
217 my @search_groups = Koha::Library::Groups->get_search_groups();
218 $template->param( search_groups => \@search_groups );
220 # load the language limits (for search)
221 my $languages_limit_loop = getLanguages($lang, 1);
222 $template->param(search_languages_loop => $languages_limit_loop,);
224 # load the Type stuff
225 my $itemtypes = GetItemTypesCategorized;
226 # add translated_description to itemtypes
227 foreach my $itemtype ( keys %{$itemtypes} ) {
228 # Itemtypes search categories don't have (yet) translated descriptions, they are auth values (and could still have no descriptions too BZ 18400)
229 # If 'iscat' (see ITEMTYPECAT) then there is no itemtype and the description is not translated
230 my $translated_description = $itemtypes->{$itemtype}->{iscat}
231 ? $itemtypes->{$itemtype}->{description}
232 : Koha::ItemTypes->find($itemtype)->translated_description;
233 $itemtypes->{$itemtype}->{translated_description} = $translated_description || $itemtypes->{$itemtype}->{description} || q{};
236 # the index parameter is different for item-level itemtypes
237 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
238 my @advancedsearchesloop;
239 my $cnt;
240 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
241 my @advanced_search_types = split(/\|/, $advanced_search_types);
243 my $hidingrules = {};
244 my $yaml = C4::Context->preference('OpacHiddenItems');
245 if ( $yaml =~ /\S/ ) {
246 $yaml = "$yaml\n\n"; # YAML expects trailing newline. Surplus does not hurt.
247 eval {
248 $hidingrules = YAML::Load($yaml);
250 if ($@) {
251 warn "Unable to parse OpacHiddenItems syspref : $@";
255 my @sorted_itemtypes = sort { $itemtypes->{$a}->{translated_description} cmp $itemtypes->{$b}->{translated_description} } keys %$itemtypes;
256 foreach my $advanced_srch_type (@advanced_search_types) {
257 $advanced_srch_type =~ s/^\s*//;
258 $advanced_srch_type =~ s/\s*$//;
259 if ($advanced_srch_type eq 'itemtypes') {
260 # itemtype is a special case, since it's not defined in authorized values
261 my @itypesloop;
262 foreach my $thisitemtype ( @sorted_itemtypes ) {
263 next if $hidingrules->{itype} && any { $_ eq $thisitemtype } @{$hidingrules->{itype}};
264 next if $hidingrules->{itemtype} && any { $_ eq $thisitemtype } @{$hidingrules->{itemtype}};
265 my %row =( number=>$cnt++,
266 ccl => "$itype_or_itemtype,phr",
267 code => $thisitemtype,
268 description => $itemtypes->{$thisitemtype}->{translated_description},
269 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
270 cat => $itemtypes->{$thisitemtype}->{'iscat'},
271 hideinopac => $itemtypes->{$thisitemtype}->{'hideinopac'},
272 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
274 if ( !$itemtypes->{$thisitemtype}->{'hideinopac'} ) {
275 push @itypesloop, \%row;
278 my %search_code = ( advanced_search_type => $advanced_srch_type,
279 code_loop => \@itypesloop );
280 push @advancedsearchesloop, \%search_code;
281 } else {
282 # covers all the other cases: non-itemtype authorized values
283 my $advsearchtypes = GetAuthorisedValues($advanced_srch_type, 'opac');
284 my @authvalueloop;
285 for my $thisitemtype (@$advsearchtypes) {
286 my $hiding_key = lc $thisitemtype->{category};
287 $hiding_key = "location" if $hiding_key eq 'loc';
288 next if $hidingrules->{$hiding_key} && any { $_ eq $thisitemtype->{authorised_value} } @{$hidingrules->{$hiding_key}};
289 my %row =(
290 number=>$cnt++,
291 ccl => $advanced_srch_type,
292 code => $thisitemtype->{authorised_value},
293 description => $thisitemtype->{'lib_opac'} || $thisitemtype->{'lib'},
294 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
295 imageurl => getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
297 push @authvalueloop, \%row;
299 my %search_code = ( advanced_search_type => $advanced_srch_type,
300 code_loop => \@authvalueloop );
301 push @advancedsearchesloop, \%search_code;
304 $template->param(advancedsearchesloop => \@advancedsearchesloop);
306 # The following should only be loaded if we're bringing up the advanced search template
307 if ( $template_type && $template_type eq 'advsearch' ) {
308 # load the servers (used for searching -- to do federated searching, etc.)
309 my $primary_servers_loop;# = displayPrimaryServers();
310 $template->param(outer_servers_loop => $primary_servers_loop,);
312 my $secondary_servers_loop;
313 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
315 # set the default sorting
316 if ( C4::Context->preference('OPACdefaultSortField')
317 && C4::Context->preference('OPACdefaultSortOrder') ) {
318 my $default_sort_by =
319 C4::Context->preference('OPACdefaultSortField') . '_'
320 . C4::Context->preference('OPACdefaultSortOrder');
321 $template->param( sort_by => $default_sort_by );
324 # determine what to display next to the search boxes (ie, boolean option
325 # shouldn't appear on the first one, scan indexes should, adding a new
326 # box should only appear on the last, etc.
327 my @search_boxes_array;
328 my $search_boxes_count = 3; # begin whith 3 boxes
329 $template->param( search_boxes_count => $search_boxes_count );
331 if ($cgi->cookie("num_paragraph")){
332 $search_boxes_count = $cgi->cookie("num_paragraph");
335 for (my $i=1;$i<=$search_boxes_count;$i++) {
336 # if it's the first one, don't display boolean option, but show scan indexes
337 if ($i==1) {
338 push @search_boxes_array,
340 scan_index => 1,
344 # if it's the last one, show the 'add field' box
345 elsif ($i==$search_boxes_count) {
346 push @search_boxes_array,
348 boolean => 1,
349 add_field => 1,
352 else {
353 push @search_boxes_array,
355 boolean => 1,
361 my @advsearch_limits = split /,/, C4::Context->preference('OpacAdvSearchOptions');
362 my @advsearch_more_limits = split /,/,
363 C4::Context->preference('OpacAdvSearchMoreOptions');
364 $template->param(
365 uc( C4::Context->preference("marcflavour") ) => 1, # we already did this for UNIMARC
366 advsearch => 1,
367 search_boxes_loop => \@search_boxes_array,
368 OpacAdvSearchOptions => \@advsearch_limits,
369 OpacAdvSearchMoreOptions => \@advsearch_more_limits,
372 # use the global setting by default
373 if ( C4::Context->preference("expandedSearchOption") == 1 ) {
374 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
376 # but let the user override it
377 if (defined $cgi->param('expanded_options')) {
378 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
379 $template->param( expanded_options => scalar $cgi->param('expanded_options'));
383 if (C4::Context->preference('OPACNumbersPreferPhrase')) {
384 $template->param('numbersphr' => 1);
387 output_html_with_http_headers $cgi, $cookie, $template->output;
388 exit;
391 ### OK, if we're this far, we're performing an actual search
393 # Fetch the paramater list as a hash in scalar context:
394 # * returns paramater list as tied hash ref
395 # * we can edit the values by changing the key
396 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
397 my $params = $cgi->Vars;
398 my $tag;
399 if ( $params->{tag} ) {
400 $tag = $params->{tag};
401 $template->param( tag => $tag );
404 # String with params with the search criteria for the paging in opac-detail
405 # param value is URI encoded and params separator is HTML encode (&amp;)
406 my $pasarParams = '';
407 my $j = 0;
408 for (keys %$params) {
409 my @pasarParam = $cgi->multi_param($_);
410 for my $paramValue(@pasarParam) {
411 $pasarParams .= '&amp;' if ($j > 0);
412 $pasarParams .= $_ . '=' . uri_escape_utf8($paramValue);
413 $j++;
417 # Params that can have more than one value
418 # sort by is used to sort the query
419 # in theory can have more than one but generally there's just one
420 my @sort_by;
421 my $default_sort_by;
422 if ( C4::Context->preference('OPACdefaultSortField')
423 && C4::Context->preference('OPACdefaultSortOrder') ) {
424 $default_sort_by =
425 C4::Context->preference('OPACdefaultSortField') . '_'
426 . C4::Context->preference('OPACdefaultSortOrder');
429 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/;
430 @sort_by = $cgi->multi_param('sort_by');
431 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
432 foreach my $sort (@sort_by) {
433 if ( grep { /^$sort$/ } @allowed_sortby ) {
434 $template->param($sort => 1);
437 $template->param('sort_by' => $sort_by[0]);
439 # Use the servers defined, or just search our local catalog(default)
440 my @servers = $cgi->multi_param('server');
441 unless (@servers) {
442 #FIXME: this should be handled using Context.pm
443 @servers = ("biblioserver");
444 # @servers = C4::Context->config("biblioserver");
447 # operators include boolean and proximity operators and are used
448 # to evaluate multiple operands
449 my @operators = $cgi->multi_param('op');
450 @operators = map { uri_unescape($_) } @operators;
452 # indexes are query qualifiers, like 'title', 'author', etc. They
453 # can be single or multiple parameters separated by comma: kw,right-Truncation
454 my @indexes = $cgi->multi_param('idx');
455 @indexes = map { uri_unescape($_) } @indexes;
457 # if a simple index (only one) display the index used in the top search box
458 if ($indexes[0] && !$indexes[1]) {
459 $template->param("ms_".$indexes[0] => 1);
461 # an operand can be a single term, a phrase, or a complete ccl query
462 my @operands = $cgi->multi_param('q');
463 @operands = map { uri_unescape($_) } @operands;
465 $template->{VARS}->{querystring} = join(' ', @operands);
467 # if a simple search, display the value in the search box
468 if ($operands[0] && !$operands[1]) {
469 my $ms_query = $operands[0];
470 $ms_query =~ s/ #\S+//;
471 $template->param(ms_value => $ms_query);
474 # limits are use to limit to results to a pre-defined category such as branch or language
475 my @limits = $cgi->multi_param('limit');
476 @limits = map { uri_unescape($_) } @limits;
477 my @nolimits = $cgi->multi_param('nolimit');
478 @nolimits = map { uri_unescape($_) } @nolimits;
479 my %is_nolimit = map { $_ => 1 } @nolimits;
480 @limits = grep { not $is_nolimit{$_} } @limits;
482 if (@searchCategories > 0) {
483 my @tabcat;
484 foreach my $typecategory (@searchCategories) {
485 my @itemtypes = Koha::ItemTypes->search({ searchcategory => $typecategory });
486 push @tabcat, $_->itemtype for @itemtypes;
489 foreach my $itemtypeInCategory (@tabcat) {
490 push (@limits, "mc-$itype_or_itemtype,phr:".$itemtypeInCategory);
494 @limits = map { uri_unescape($_) } @limits;
496 if($params->{'multibranchlimit'}) {
497 my $search_group = Koha::Library::Groups->find( $params->{multibranchlimit} );
498 my @libraries = $search_group->all_libraries;
499 my $multibranch = '('.join( " or ", map { 'branch: ' . $_->id } @libraries ) .')';
500 push @limits, $multibranch if ($multibranch ne '()');
503 my $available;
504 foreach my $limit(@limits) {
505 if ($limit =~/available/) {
506 $available = 1;
509 $template->param(available => $available);
511 # append year limits if they exist
512 if ($params->{'limit-yr'}) {
513 if ($params->{'limit-yr'} =~ /\d{4}/) {
514 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
516 else {
517 #FIXME: Should return a error to the user, incorect date format specified
521 # Params that can only have one value
522 my $scan = $params->{'scan'};
523 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
524 my $countRSS = C4::Context->preference('numSearchRSSResults') || 50;
525 my $results_per_page = $params->{'count'} || $count;
526 my $offset = $params->{'offset'} || 0;
527 $offset = 0 if $offset < 0;
528 my $page = $cgi->param('page') || 1;
529 $offset = ($page-1)*$results_per_page if $page>1;
530 my $hits;
531 my $expanded_facet = $params->{'expand'};
533 # Define some global variables
534 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
536 my @results;
538 my $suppress = 0;
539 if (C4::Context->preference('OpacSuppression')) {
540 # OPAC suppression by IP address
541 if (C4::Context->preference('OpacSuppressionByIPRange')) {
542 my $IPAddress = $ENV{'REMOTE_ADDR'};
543 my $IPRange = C4::Context->preference('OpacSuppressionByIPRange');
544 $suppress = ($IPAddress !~ /^$IPRange/);
546 else {
547 $suppress = 1;
551 ## I. BUILD THE QUERY
552 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type)
553 = $builder->build_query_compat(
554 \@operators,
555 \@operands,
556 \@indexes,
557 \@limits,
558 \@sort_by,
560 $lang,
561 { expanded_facet => $expanded_facet, suppress => $suppress }
564 sub _input_cgi_parse {
565 my @elements;
566 my $query_cgi = shift or return @elements;
567 for my $this_cgi ( split('&',$query_cgi) ) {
568 next unless $this_cgi;
569 $this_cgi =~ /(.*?)=(.*)/;
570 push @elements, { input_name => $1, input_value => Encode::decode_utf8( uri_unescape($2) ) };
572 return @elements;
575 ## parse the query_cgi string and put it into a form suitable for <input>s
576 my @query_inputs = _input_cgi_parse($query_cgi);
577 $template->param ( QUERY_INPUTS => \@query_inputs );
579 ## parse the limit_cgi string and put it into a form suitable for <input>s
580 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
582 $template->param ( LIMIT_INPUTS => \@limit_inputs );
583 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
585 ## II. DO THE SEARCH AND GET THE RESULTS
586 my $total = 0; # the total results for the whole set
587 my $facets; # this object stores the faceted results that display on the left-hand of the results page
588 my @results_array;
589 my $results_hashref;
590 my @coins;
592 if ($tag) {
593 $query_cgi = "tag=" .$tag . "&" . $query_cgi;
594 my $taglist = get_tags({term=>$tag, approved=>1});
595 $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
596 my @marclist = map { C4::Biblio::GetXmlBiblio( $_->{biblionumber} ) } @$taglist;
597 $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
598 $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
599 # FIXME: tag search and standard search should work together, not exclusively
600 # FIXME: No facets for tags search.
601 } elsif ($build_grouped_results) {
602 eval {
603 ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,undef,$query_type,$scan);
605 } else {
606 $pasarParams .= '&amp;query=' . uri_escape_utf8($query);
607 $pasarParams .= '&amp;count=' . uri_escape_utf8($results_per_page);
608 $pasarParams .= '&amp;simple_query=' . uri_escape_utf8($simple_query);
609 $pasarParams .= '&amp;query_type=' . uri_escape_utf8($query_type) if ($query_type);
610 my $itemtypes_nocategory = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
611 eval {
612 ($error, $results_hashref, $facets) = $searcher->search_compat($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,undef,$itemtypes_nocategory,$query_type,$scan,1);
616 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
617 if (not $tag and ( $@ || $error)) {
618 $template->param(query_error => $error.$@);
619 output_html_with_http_headers $cgi, $cookie, $template->output;
620 exit;
623 # At this point, each server has given us a result set
624 # now we build that set for template display
625 my @sup_results_array;
626 for (my $i=0;$i<@servers;$i++) {
627 my $server = $servers[$i];
628 if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
629 $hits = $results_hashref->{$server}->{"hits"};
630 my $page = $cgi->param('page') || 0;
631 my @newresults;
632 if ($build_grouped_results) {
633 foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
634 # because pazGetRecords handles retieving only the records
635 # we want as specified by $offset and $results_per_page,
636 # we need to set the offset parameter of searchResults to 0
637 my @group_results = searchResults( 'opac', $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
638 $group->{"RECORDS"});
639 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
641 } else {
642 @newresults = searchResults('opac', $query_desc, $hits, $results_per_page, $offset, $scan,
643 $results_hashref->{$server}->{"RECORDS"});
645 $hits = 0 unless @newresults;
647 foreach my $res (@newresults) {
649 # must define a value for size if not present in DB
650 # in order to avoid problems generated by the default size value in TT
651 if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
652 # while we're checking each line, see if item is in the cart
653 if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
654 $res->{'incart'} = 1;
657 if (C4::Context->preference('COinSinOPACResults')) {
658 my $record = GetMarcBiblio({ biblionumber => $res->{'biblionumber'} });
659 $res->{coins} = GetCOinSBiblio($record);
661 if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
662 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
663 $isbn = $isbn->as_isbn13->as_string;
664 $isbn =~ s/-//g;
665 my $social_datas = C4::SocialData::get_data( $isbn );
666 if ( $social_datas ) {
667 for my $key ( keys %$social_datas ) {
668 $res->{$key} = $$social_datas{$key};
669 if ( $key eq 'score_avg' ){
670 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
677 if (C4::Context->preference('TagsEnabled') and
678 C4::Context->preference('TagsShowOnList')) {
679 if ( my $bibnum = $res->{biblionumber} ) {
680 $res->{itemsissued} = CountItemsIssued( $bibnum );
681 $res->{'TagLoop'} = get_tags({
682 biblionumber => $bibnum,
683 approved => 1,
684 sort => '-weight',
685 limit => C4::Context->preference('TagsShowOnList')
690 $res->{shelves} = Koha::Virtualshelves->get_shelves_containing_record(
692 biblionumber => $res->{biblionumber},
693 borrowernumber => $borrowernumber
697 if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
698 my $ratings = Koha::Ratings->search({ biblionumber => $res->{biblionumber} });
699 $res->{ratings} = $ratings;
700 $res->{my_rating} = $borrowernumber ? $ratings->search({ borrowernumber => $borrowernumber })->next : undef;
704 if ($results_hashref->{$server}->{"hits"}){
705 $total = $total + $hits;
708 # Opac search history
709 if (C4::Context->preference('EnableOpacSearchHistory')) {
710 unless ( $offset ) {
711 my $path_info = $cgi->url(-path_info=>1);
712 my $query_cgi_history = $cgi->url(-query=>1);
713 $query_cgi_history =~ s/^$path_info\?//;
714 $query_cgi_history =~ s/;/&/g;
715 my $query_desc_history = join ", ", grep { defined $_ } $query_desc, $limit_desc;
717 unless ( $borrowernumber ) {
718 my $new_searches = C4::Search::History::add_to_session({
719 cgi => $cgi,
720 query_desc => $query_desc_history,
721 query_cgi => $query_cgi_history,
722 total => $total,
723 type => "biblio",
725 } else {
726 # To the session (the user is logged in)
727 C4::Search::History::add({
728 userid => $borrowernumber,
729 sessionid => $cgi->cookie("CGISESSID"),
730 query_desc => $query_desc_history,
731 query_cgi => $query_cgi_history,
732 total => $total,
733 type => "biblio",
737 $template->param( EnableOpacSearchHistory => 1 );
740 ## If there's just one result, redirect to the detail page
741 if ($total == 1 && $format ne 'rss2'
742 && $format ne 'opensearchdescription' && $format ne 'atom') {
743 my $biblionumber=$newresults[0]->{biblionumber};
744 if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
745 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
746 } elsif (C4::Context->preference('BiblioDefaultView') eq 'marc') {
747 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
748 } else {
749 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
751 exit;
753 if ($hits) {
754 if ( !$build_grouped_results ) {
755 # We build the encrypted list of first OPACnumSearchResults biblios to pass with the search criteria for paging on opac-detail
756 $pasarParams .= '&amp;listBiblios=';
757 my $j = 0;
758 foreach (@newresults) {
759 my $bibnum = ($_->{biblionumber})?$_->{biblionumber}:0;
760 $pasarParams .= uri_escape_utf8($bibnum) . ',';
761 $j++;
762 last if ($j == $results_per_page);
764 chop $pasarParams if ($pasarParams =~ /,$/);
765 $pasarParams .= '&amp;total=' . uri_escape_utf8( int($total) ) if ($pasarParams !~ /total=(?:[0-9]+)?/);
766 if ($pasarParams) {
767 my $session = get_session($cgi->cookie("CGISESSID"));
768 $session->param('busc' => $pasarParams);
772 $template->param(total => $hits);
773 my $limit_cgi_not_availablity = $limit_cgi;
774 $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
775 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
776 $template->param(limit_cgi => $limit_cgi);
777 $template->param(countrss => $countRSS );
778 $template->param(query_cgi => $query_cgi);
779 $template->param(query_desc => $query_desc);
780 $template->param(limit_desc => $limit_desc);
781 $template->param(offset => $offset);
782 $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
783 if ($query_desc || $limit_desc) {
784 $template->param(searchdesc => 1);
786 $template->param(results_per_page => $results_per_page);
787 my $hide = C4::Context->preference('OpacHiddenItems');
788 $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
789 my $branch = '';
790 if (C4::Context->userenv){
791 $branch = C4::Context->userenv->{branch};
793 if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
794 if (
795 ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
797 C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
799 my $branchcode;
800 if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
801 $branchcode = $branch;
803 elsif ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
804 $branchcode = $ENV{'BRANCHCODE'};
807 foreach my $res ( @newresults ) {
808 my @new_loop;
809 my @top_loop;
810 my @old_loop = @{$res->{'available_items_loop'}};
811 foreach my $item ( @old_loop ) {
812 if ( $item->{'branchcode'} eq $branchcode ) {
813 $item->{'this_branch'} = 1;
814 push( @top_loop, $item );
815 } else {
816 push( @new_loop, $item );
819 my @complete_loop = ( @top_loop, @new_loop );
820 $res->{'available_items_loop'} = \@complete_loop;
825 $template->param(
826 SEARCH_RESULTS => \@newresults,
827 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
828 suppress_result_number => $hide,
830 if (C4::Context->preference("OPACLocalCoverImages")){
831 $template->param(OPACLocalCoverImages => 1);
832 $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
834 ## Build the page numbers on the bottom of the page
835 my @page_numbers;
836 # total number of pages there will be
837 my $pages = ceil($hits / $results_per_page);
838 my $last_page_offset = ( $pages - 1 ) * $results_per_page;
839 # default page number
840 my $current_page_number = 1;
841 if ($offset) {
842 $current_page_number = ( $offset / $results_per_page + 1 );
844 my $previous_page_offset;
845 if ( $offset >= $results_per_page ) {
846 $previous_page_offset = $offset - $results_per_page;
848 my $next_page_offset = $offset + $results_per_page;
849 # If we're within the first 10 pages, keep it simple
850 #warn "current page:".$current_page_number;
851 if ($current_page_number < 10) {
852 # just show the first 10 pages
853 # Loop through the pages
854 my $pages_to_show = 10;
855 $pages_to_show = $pages if $pages<10;
856 for ($i=1; $i<=$pages_to_show;$i++) {
857 # the offset for this page
858 my $this_offset = (($i*$results_per_page)-$results_per_page);
859 # the page number for this page
860 my $this_page_number = $i;
861 # put it in the array
862 push @page_numbers,
863 { offset => $this_offset,
864 pg => $this_page_number,
865 highlight => $this_page_number == $current_page_number,
866 sort_by => join ' ', @sort_by
872 # now, show twenty pages, with the current one smack in the middle
873 else {
874 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
875 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
876 my $this_page_number = $i-9;
877 if ( $this_page_number <= $pages ) {
878 push @page_numbers,
879 { offset => $this_offset,
880 pg => $this_page_number,
881 highlight => $this_page_number == $current_page_number,
882 sort_by => join ' ', @sort_by
888 $template->param( PAGE_NUMBERS => \@page_numbers,
889 last_page_offset => $last_page_offset,
890 previous_page_offset => $previous_page_offset) unless $pages < 2;
891 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
893 # no hits
894 else {
895 my $nohits = C4::Context->preference('OPACNoResultsFound');
896 if ($nohits and $nohits=~/{QUERY_KW}/){
897 # extracting keywords in case of relaunching search
898 (my $query_kw=$query_desc)=~s/ and|or / /g;
899 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^,:]|$)/g);
900 $query_kw=join('+',@query_kw);
901 $nohits=~s/{QUERY_KW}/$query_kw/g;
902 $template->param('OPACNoResultsFound' =>$nohits);
904 $template->param(
905 searchdesc => 1,
906 query_desc => $query_desc,
907 limit_desc => $limit_desc,
908 query_cgi => $query_cgi,
909 limit_cgi => $limit_cgi
912 } # end of the if local
913 # asynchronously search the authority server
914 elsif ($server && $server =~/authorityserver/) { # this is the local authority server
915 my @inner_sup_results_array;
916 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
917 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
918 my $title_field = $marc_record_object->field(100);
919 push @inner_sup_results_array, {
920 'title' => $title_field->subfield('a'),
921 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
924 my $servername = $server;
925 push @sup_results_array, { servername => $servername,
926 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
928 # FIXME: can add support for other targets as needed here
929 $template->param( outer_sup_results_loop => \@sup_results_array);
930 } #/end of the for loop
931 #$template->param(FEDERATED_RESULTS => \@results_array);
933 for my $facet ( @$facets ) {
934 for my $entry ( @{ $facet->{facets} } ) {
935 my $index = $entry->{type_link_value};
936 my $value = $entry->{facet_link_value};
937 $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
942 $template->param(
943 #classlist => $classlist,
944 total => $total,
945 opacfacets => 1,
946 facets_loop => $facets,
947 displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
948 scan => $scan,
949 search_error => $error,
952 if ($query_desc || $limit_desc) {
953 $template->param(searchdesc => 1);
956 # VI. BUILD THE TEMPLATE
957 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
959 borrowernumber => $borrowernumber,
960 add_allowed => 1,
961 category => 1,
964 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
966 borrowernumber => $borrowernumber,
967 add_allowed => 1,
968 category => 2,
972 $template->param(
973 add_to_some_private_shelves => $some_private_shelves,
974 add_to_some_public_shelves => $some_public_shelves,
977 my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
979 # If GoogleIndicTransliteration system preference is On Set parameter to load Google's javascript in OPAC search screens
980 if (C4::Context->preference('GoogleIndicTransliteration')) {
981 $template->param('GoogleIndicTransliteration' => 1);
984 $template->{VARS}->{DidYouMean} =
985 ( defined C4::Context->preference('OPACdidyoumean')
986 && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
987 $template->{VARS}->{IDreamBooksReviews} = C4::Context->preference('IDreamBooksReviews');
988 $template->{VARS}->{IDreamBooksReadometer} = C4::Context->preference('IDreamBooksReadometer');
989 $template->{VARS}->{IDreamBooksResults} = C4::Context->preference('IDreamBooksResults');
991 if ($offset == 0 && IsOverDriveEnabled()) {
992 $template->param(OverDriveEnabled => 1);
993 $template->param(OverDriveLibraryID => C4::Context->preference('OverDriveLibraryID'));
996 $template->param( borrowernumber => $borrowernumber);
997 output_with_http_headers $cgi, $cookie, $template->output, $content_type;