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
26 ## STEP 1. Load things that are used in both search page and
27 # results page and decide which template to load, operations
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'});
45 use C4::Auth qw(:DEFAULT get_session);
46 use C4::Languages qw(getLanguages);
48 use C4::Search::History;
49 use C4::Biblio; # Unused here?
51 use C4::Tags qw(get_tags);
53 use C4::External::OverDrive;
54 use C4::Borrowers qw(GetMember);
58 use Koha::Virtualshelves;
59 use Koha::Library::Groups;
62 use POSIX qw(ceil floor strftime);
64 use JSON qw/decode_json encode_json/;
67 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
68 # create a new CGI object
69 # FIXME: no_undef_params needs to be tested
70 use CGI qw('-no_undef_params' -utf8);
73 my $branch_group_limit = $cgi->param("branch_group_limit");
74 if ( $branch_group_limit ) {
75 if ( $branch_group_limit =~ /^multibranchlimit-/ ) {
76 # For search groups we are going to convert this branch_group_limit CGI
77 # parameter into a multibranchlimit CGI parameter for the purposes of
78 # actually performing the query
80 -name => 'multibranchlimit',
81 -values => substr($branch_group_limit, 17)
86 -values => [ $branch_group_limit ]
92 if (C4::Context->preference('BakerTaylorEnabled')) {
93 require C4::External::BakerTaylor;
94 import C4::External::BakerTaylor qw(&image_url &link_url);
98 my ($template,$borrowernumber,$cookie);
99 # decide which template to use
101 my $template_type = 'basic';
102 my @params = $cgi->multi_param("limit");
103 my @searchCategories = $cgi->multi_param('searchcat');
105 my $format = $cgi->param("format") || '';
106 my $build_grouped_results = C4::Context->preference('OPACGroupResults');
107 if ($format =~ /(rss|atom|opensearchdescription)/) {
108 $template_name = 'opac-opensearch.tt';
110 elsif (@params && $build_grouped_results) {
111 $template_name = 'opac-results-grouped.tt';
113 elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) || @searchCategories ) {
114 $template_name = 'opac-results.tt';
117 $template_name = 'opac-advsearch.tt';
118 $template_type = 'advsearch';
121 ($template, $borrowernumber, $cookie) = get_template_and_user({
122 template_name => $template_name,
125 authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
129 my $lang = C4::Languages::getlanguage($cgi);
131 if ($template_name eq 'opac-results.tt') {
132 $template->param('COinSinOPACResults' => C4::Context->preference('COinSinOPACResults'));
135 # get biblionumbers stored in the cart
138 if($cgi->cookie("bib_list")){
139 my $cart_list = $cgi->cookie("bib_list");
140 @cart_list = split(/\//, $cart_list);
143 if ($format eq 'rss2' or $format eq 'opensearchdescription' or $format eq 'atom') {
144 $template->param($format => 1);
145 $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime)) if ($format eq 'atom');
146 # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
147 # entry, but not sure if that's worth an extra database query for each bib
149 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
150 $template->param('UNIMARC' => 1);
152 elsif (C4::Context->preference("marcflavour") eq "MARC21" ) {
153 $template->param('usmarc' => 1);
156 $template->param( 'OPACNoResultsFound' => C4::Context->preference('OPACNoResultsFound') );
159 OpacStarRatings => C4::Context->preference("OpacStarRatings") );
161 if (C4::Context->preference('BakerTaylorEnabled')) {
163 BakerTaylorEnabled => 1,
164 BakerTaylorImageURL => &image_url(),
165 BakerTaylorLinkURL => &link_url(),
166 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
170 if (C4::Context->preference('TagsEnabled')) {
171 $template->param(TagsEnabled => 1);
172 foreach (qw(TagsShowOnList TagsInputOnList)) {
173 C4::Context->preference($_) and $template->param($_ => 1);
178 # Deprecated, but preserved because it's interesting :-)
179 # The same thing can be accomplished with mod_rewrite in
183 #my $uri = $cgi->url(-base => 1);
184 #my $relative_url = $cgi->url(-relative=>1);
185 #$uri.="/".$relative_url."?";
187 #my @cgi_params_list = $cgi->param();
188 #my $url_params = $cgi->Vars;
190 #for my $each_param_set (@cgi_params_list) {
191 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
193 #warn "New URI:$uri";
194 # Only re-write a URI if there are params or if it already hasn't been re-written
195 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
196 # print $cgi->redirect( -uri=>$uri."&r=1",
197 # -cookie => $cookie);
203 if ($cgi->param("returntosearch")) {
204 $template->param('ReturnToSearch' => 1);
206 if ($cgi->cookie("search_path_code")) {
207 my $pathcode = $cgi->cookie("search_path_code");
208 if ($pathcode eq '"ads"') {
209 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?returntosearch=1');
211 elsif ($pathcode eq '"exs"') {
212 $template->param('ReturnPath' => '/cgi-bin/koha/opac-search.pl?expanded_options=1&returntosearch=1');
215 warn "ReturnPath switch error";
219 my @search_groups = Koha::Library::Groups->get_search_groups();
220 $template->param( search_groups => \@search_groups );
222 # load the language limits (for search)
223 my $languages_limit_loop = getLanguages($lang, 1);
224 $template->param(search_languages_loop => $languages_limit_loop,);
226 # load the Type stuff
227 my $itemtypes = GetItemTypesCategorized;
228 # add translated_description to itemtypes
229 foreach my $itemtype ( keys %{$itemtypes} ) {
230 # Itemtypes search categories don't have (yet) translated descriptions, they are auth values (and could still have no descriptions too BZ 18400)
231 # If 'iscat' (see ITEMTYPECAT) then there is no itemtype and the description is not translated
232 my $translated_description = $itemtypes->{$itemtype}->{iscat}
233 ? $itemtypes->{$itemtype}->{description}
234 : Koha::ItemTypes->find($itemtype)->translated_description;
235 $itemtypes->{$itemtype}->{translated_description} = $translated_description || $itemtypes->{$itemtype}->{description} || q{};
238 # the index parameter is different for item-level itemtypes
239 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
240 my @advancedsearchesloop;
242 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes") || "itemtypes";
243 my @advanced_search_types = split(/\|/, $advanced_search_types);
245 my $hidingrules = {};
246 my $yaml = C4::Context->preference('OpacHiddenItems');
247 if ( $yaml =~ /\S/ ) {
248 $yaml = "$yaml\n\n"; # YAML expects trailing newline. Surplus does not hurt.
250 $hidingrules = YAML::Load($yaml);
253 warn "Unable to parse OpacHiddenItems syspref : $@";
257 my @sorted_itemtypes = sort { $itemtypes->{$a}->{translated_description} cmp $itemtypes->{$b}->{translated_description} } keys %$itemtypes;
258 foreach my $advanced_srch_type (@advanced_search_types) {
259 $advanced_srch_type =~ s/^\s*//;
260 $advanced_srch_type =~ s/\s*$//;
261 if ($advanced_srch_type eq 'itemtypes') {
262 # itemtype is a special case, since it's not defined in authorized values
264 foreach my $thisitemtype ( @sorted_itemtypes ) {
265 next if $hidingrules->{itype} && any { $_ eq $thisitemtype } @{$hidingrules->{itype}};
266 next if $hidingrules->{itemtype} && any { $_ eq $thisitemtype } @{$hidingrules->{itemtype}};
267 my %row =( number=>$cnt++,
268 ccl => "$itype_or_itemtype,phr",
269 code => $thisitemtype,
270 description => $itemtypes->{$thisitemtype}->{translated_description},
271 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
272 cat => $itemtypes->{$thisitemtype}->{'iscat'},
273 hideinopac => $itemtypes->{$thisitemtype}->{'hideinopac'},
274 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
276 if ( !$itemtypes->{$thisitemtype}->{'hideinopac'} ) {
277 push @itypesloop, \%row;
280 my %search_code = ( advanced_search_type => $advanced_srch_type,
281 code_loop => \@itypesloop );
282 push @advancedsearchesloop, \%search_code;
284 # covers all the other cases: non-itemtype authorized values
285 my $advsearchtypes = GetAuthorisedValues($advanced_srch_type, 'opac');
287 for my $thisitemtype (@$advsearchtypes) {
288 my $hiding_key = lc $thisitemtype->{category};
289 $hiding_key = "location" if $hiding_key eq 'loc';
290 next if $hidingrules->{$hiding_key} && any { $_ eq $thisitemtype->{authorised_value} } @{$hidingrules->{$hiding_key}};
293 ccl => $advanced_srch_type,
294 code => $thisitemtype->{authorised_value},
295 description => $thisitemtype->{'lib_opac'} || $thisitemtype->{'lib'},
296 searchcategory => $itemtypes->{$thisitemtype}->{'searchcategory'},
297 imageurl => getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
299 push @authvalueloop, \%row;
301 my %search_code = ( advanced_search_type => $advanced_srch_type,
302 code_loop => \@authvalueloop );
303 push @advancedsearchesloop, \%search_code;
306 $template->param(advancedsearchesloop => \@advancedsearchesloop);
308 # The following should only be loaded if we're bringing up the advanced search template
309 if ( $template_type && $template_type eq 'advsearch' ) {
310 # load the servers (used for searching -- to do federated searching, etc.)
311 my $primary_servers_loop;# = displayPrimaryServers();
312 $template->param(outer_servers_loop => $primary_servers_loop,);
314 my $secondary_servers_loop;
315 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
317 # set the default sorting
318 if ( C4::Context->preference('OPACdefaultSortField')
319 && C4::Context->preference('OPACdefaultSortOrder') ) {
320 my $default_sort_by =
321 C4::Context->preference('OPACdefaultSortField') . '_'
322 . C4::Context->preference('OPACdefaultSortOrder');
323 $template->param( sort_by => $default_sort_by );
326 # determine what to display next to the search boxes (ie, boolean option
327 # shouldn't appear on the first one, scan indexes should, adding a new
328 # box should only appear on the last, etc.
329 my @search_boxes_array;
330 my $search_boxes_count = 3; # begin whith 3 boxes
331 $template->param( search_boxes_count => $search_boxes_count );
333 if ($cgi->cookie("num_paragraph")){
334 $search_boxes_count = $cgi->cookie("num_paragraph");
337 for (my $i=1;$i<=$search_boxes_count;$i++) {
338 # if it's the first one, don't display boolean option, but show scan indexes
340 push @search_boxes_array,
346 # if it's the last one, show the 'add field' box
347 elsif ($i==$search_boxes_count) {
348 push @search_boxes_array,
355 push @search_boxes_array,
363 my @advsearch_limits = split /,/, C4::Context->preference('OpacAdvSearchOptions');
364 my @advsearch_more_limits = split /,/,
365 C4::Context->preference('OpacAdvSearchMoreOptions');
367 uc( C4::Context->preference("marcflavour") ) => 1, # we already did this for UNIMARC
369 search_boxes_loop => \@search_boxes_array,
370 OpacAdvSearchOptions => \@advsearch_limits,
371 OpacAdvSearchMoreOptions => \@advsearch_more_limits,
374 # use the global setting by default
375 if ( C4::Context->preference("expandedSearchOption") == 1 ) {
376 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
378 # but let the user override it
379 if (defined $cgi->param('expanded_options')) {
380 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
381 $template->param( expanded_options => scalar $cgi->param('expanded_options'));
386 output_html_with_http_headers $cgi, $cookie, $template->output;
390 ### OK, if we're this far, we're performing an actual search
392 # Fetch the paramater list as a hash in scalar context:
393 # * returns paramater list as tied hash ref
394 # * we can edit the values by changing the key
395 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
396 my $params = $cgi->Vars;
398 if ( $params->{tag} ) {
399 $tag = $params->{tag};
400 $template->param( tag => $tag );
403 # String with params with the search criteria for the paging in opac-detail
404 # param value is URI encoded and params separator is HTML encode (&)
405 my $pasarParams = '';
407 for (keys %$params) {
408 my @pasarParam = $cgi->multi_param($_);
409 for my $paramValue(@pasarParam) {
410 $pasarParams .= '&' if ($j > 0);
411 $pasarParams .= $_ . '=' . uri_escape_utf8($paramValue);
416 # Params that can have more than one value
417 # sort by is used to sort the query
418 # in theory can have more than one but generally there's just one
421 if ( C4::Context->preference('OPACdefaultSortField')
422 && C4::Context->preference('OPACdefaultSortOrder') ) {
424 C4::Context->preference('OPACdefaultSortField') . '_'
425 . C4::Context->preference('OPACdefaultSortOrder');
428 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/;
429 @sort_by = $cgi->multi_param('sort_by');
430 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
431 foreach my $sort (@sort_by) {
432 if ( grep { /^$sort$/ } @allowed_sortby ) {
433 $template->param($sort => 1);
436 $template->param('sort_by' => $sort_by[0]);
438 # Use the servers defined, or just search our local catalog(default)
439 my @servers = $cgi->multi_param('server');
441 #FIXME: this should be handled using Context.pm
442 @servers = ("biblioserver");
443 # @servers = C4::Context->config("biblioserver");
446 # operators include boolean and proximity operators and are used
447 # to evaluate multiple operands
448 my @operators = $cgi->multi_param('op');
449 @operators = map { uri_unescape($_) } @operators;
451 # indexes are query qualifiers, like 'title', 'author', etc. They
452 # can be single or multiple parameters separated by comma: kw,right-Truncation
453 my @indexes = $cgi->multi_param('idx');
454 @indexes = map { uri_unescape($_) } @indexes;
456 # if a simple index (only one) display the index used in the top search box
457 if ($indexes[0] && !$indexes[1]) {
458 $template->param("ms_".$indexes[0] => 1);
460 # an operand can be a single term, a phrase, or a complete ccl query
461 my @operands = $cgi->multi_param('q');
462 @operands = map { uri_unescape($_) } @operands;
464 $template->{VARS}->{querystring} = join(' ', @operands);
466 # if a simple search, display the value in the search box
467 if ($operands[0] && !$operands[1]) {
468 my $ms_query = $operands[0];
469 $ms_query =~ s/ #\S+//;
470 $template->param(ms_value => $ms_query);
473 # limits are use to limit to results to a pre-defined category such as branch or language
474 my @limits = $cgi->multi_param('limit');
475 @limits = map { uri_unescape($_) } @limits;
476 my @nolimits = $cgi->multi_param('nolimit');
477 @nolimits = map { uri_unescape($_) } @nolimits;
478 my %is_nolimit = map { $_ => 1 } @nolimits;
479 @limits = grep { not $is_nolimit{$_} } @limits;
481 if (@searchCategories > 0) {
483 foreach my $typecategory (@searchCategories) {
484 my @itemtypes = Koha::ItemTypes->search({ searchcategory => $typecategory });
485 push @tabcat, $_->itemtype for @itemtypes;
488 foreach my $itemtypeInCategory (@tabcat) {
489 push (@limits, "mc-$itype_or_itemtype,phr:".$itemtypeInCategory);
493 @limits = map { uri_unescape($_) } @limits;
495 if($params->{'multibranchlimit'}) {
496 my $search_group = Koha::Library::Groups->find( $params->{multibranchlimit} );
497 my @libraries = $search_group->all_libraries;
498 my $multibranch = '('.join( " or ", map { 'branch: ' . $_->branchcode } @libraries ) .')';
499 push @limits, $multibranch if ($multibranch ne '()');
503 foreach my $limit(@limits) {
504 if ($limit =~/available/) {
508 $template->param(available => $available);
510 # append year limits if they exist
511 if ($params->{'limit-yr'}) {
512 if ($params->{'limit-yr'} =~ /\d{4}/) {
513 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
516 #FIXME: Should return a error to the user, incorect date format specified
520 # Params that can only have one value
521 my $scan = $params->{'scan'};
522 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
523 my $countRSS = C4::Context->preference('numSearchRSSResults') || 50;
524 my $results_per_page = $params->{'count'} || $count;
525 my $offset = $params->{'offset'} || 0;
526 $offset = 0 if $offset < 0;
527 my $page = $cgi->param('page') || 1;
528 $offset = ($page-1)*$results_per_page if $page>1;
530 my $expanded_facet = $params->{'expand'};
532 # Define some global variables
533 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type);
538 if (C4::Context->preference('OpacSuppression')) {
539 # OPAC suppression by IP address
540 if (C4::Context->preference('OpacSuppressionByIPRange')) {
541 my $IPAddress = $ENV{'REMOTE_ADDR'};
542 my $IPRange = C4::Context->preference('OpacSuppressionByIPRange');
543 $suppress = ($IPAddress !~ /^$IPRange/);
550 ## I. BUILD THE QUERY
551 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type)
552 = $builder->build_query_compat(
560 { expanded_facet => $expanded_facet, suppress => $suppress }
563 sub _input_cgi_parse {
565 my $query_cgi = shift or return @elements;
566 for my $this_cgi ( split('&',$query_cgi) ) {
567 next unless $this_cgi;
568 $this_cgi =~ /(.*?)=(.*)/;
569 push @elements, { input_name => $1, input_value => Encode::decode_utf8( uri_unescape($2) ) };
574 ## parse the query_cgi string and put it into a form suitable for <input>s
575 my @query_inputs = _input_cgi_parse($query_cgi);
576 $template->param ( QUERY_INPUTS => \@query_inputs );
578 ## parse the limit_cgi string and put it into a form suitable for <input>s
579 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
581 $template->param ( LIMIT_INPUTS => \@limit_inputs );
582 $template->param ( OPACResultsSidebar => C4::Context->preference('OPACResultsSidebar'));
584 ## II. DO THE SEARCH AND GET THE RESULTS
585 my $total = 0; # the total results for the whole set
586 my $facets; # this object stores the faceted results that display on the left-hand of the results page
592 $query_cgi = "tag=" .$tag . "&" . $query_cgi;
593 my $taglist = get_tags({term=>$tag, approved=>1});
594 $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
595 my @marclist = map { C4::Biblio::GetXmlBiblio( $_->{biblionumber} ) } @$taglist;
596 $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
597 $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
598 # FIXME: tag search and standard search should work together, not exclusively
599 # FIXME: No facets for tags search.
600 } elsif ($build_grouped_results) {
602 ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,undef,$query_type,$scan);
605 $pasarParams .= '&query=' . uri_escape_utf8($query);
606 $pasarParams .= '&count=' . uri_escape_utf8($results_per_page);
607 $pasarParams .= '&simple_query=' . uri_escape_utf8($simple_query);
608 $pasarParams .= '&query_type=' . uri_escape_utf8($query_type) if ($query_type);
609 my $itemtypes_nocategory = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
611 ($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);
615 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
616 if (not $tag and ( $@ || $error)) {
617 $template->param(query_error => $error.$@);
618 output_html_with_http_headers $cgi, $cookie, $template->output;
622 # At this point, each server has given us a result set
623 # now we build that set for template display
624 my @sup_results_array;
625 my $search_context = {};
626 $search_context->{'interface'} = 'opac';
627 if (C4::Context->preference('OpacHiddenItemsExceptions')){
628 # we need to fetch the borrower info here, so we can pass the category
629 my $borrower = GetMember( borrowernumber => $borrowernumber );
630 $search_context->{'category'} = $borrower->{'categorycode'};
633 for (my $i=0;$i<@servers;$i++) {
634 my $server = $servers[$i];
635 if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
636 $hits = $results_hashref->{$server}->{"hits"};
637 my $page = $cgi->param('page') || 0;
639 if ($build_grouped_results) {
640 foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
641 # because pazGetRecords handles retieving only the records
642 # we want as specified by $offset and $results_per_page,
643 # we need to set the offset parameter of searchResults to 0
644 my @group_results = searchResults( $search_context, $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
645 $group->{"RECORDS"});
646 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
649 @newresults = searchResults( $search_context, $query_desc, $hits, $results_per_page, $offset, $scan,
650 $results_hashref->{$server}->{"RECORDS"});
652 $hits = 0 unless @newresults;
655 if( C4::Context->preference('ArticleRequests') ) {
656 my $patron = $borrowernumber ? Koha::Patrons->find( $borrowernumber ) : undef;
657 $art_req_itypes = Koha::IssuingRules->guess_article_requestable_itemtypes({ $patron ? ( categorycode => $patron->categorycode ) : () });
660 foreach my $res (@newresults) {
662 # must define a value for size if not present in DB
663 # in order to avoid problems generated by the default size value in TT
664 if ( not exists $res->{'size'} ) { $res->{'size'} = "" }
665 # while we're checking each line, see if item is in the cart
666 if ( grep {$_ eq $res->{'biblionumber'}} @cart_list) {
667 $res->{'incart'} = 1;
670 if (C4::Context->preference('COinSinOPACResults')) {
671 my $record = GetMarcBiblio({ biblionumber => $res->{'biblionumber'} });
672 $res->{coins} = GetCOinSBiblio($record);
674 if ( C4::Context->preference( "Babeltheque" ) and $res->{normalized_isbn} ) {
675 if( my $isbn = Business::ISBN->new( $res->{normalized_isbn} ) ) {
676 $isbn = $isbn->as_isbn13->as_string;
678 my $social_datas = C4::SocialData::get_data( $isbn );
679 if ( $social_datas ) {
680 for my $key ( keys %$social_datas ) {
681 $res->{$key} = $$social_datas{$key};
682 if ( $key eq 'score_avg' ){
683 $res->{score_int} = sprintf("%.0f", $$social_datas{score_avg} );
690 if (C4::Context->preference('TagsEnabled') and
691 C4::Context->preference('TagsShowOnList')) {
692 if ( my $bibnum = $res->{biblionumber} ) {
693 $res->{itemsissued} = CountItemsIssued( $bibnum );
694 $res->{'TagLoop'} = get_tags({
695 biblionumber => $bibnum,
698 limit => C4::Context->preference('TagsShowOnList')
703 $res->{shelves} = Koha::Virtualshelves->get_shelves_containing_record(
705 biblionumber => $res->{biblionumber},
706 borrowernumber => $borrowernumber
710 if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
711 my $ratings = Koha::Ratings->search({ biblionumber => $res->{biblionumber} });
712 $res->{ratings} = $ratings;
713 $res->{my_rating} = $borrowernumber ? $ratings->search({ borrowernumber => $borrowernumber })->next : undef;
716 # BZ17530: 'Intelligent' guess if result can be article requested
717 $res->{artreqpossible} = ( $art_req_itypes->{ $res->{itemtype} // q{} } || $art_req_itypes->{ '*' } ) ? 1 : q{};
720 if ($results_hashref->{$server}->{"hits"}){
721 $total = $total + $hits;
724 # Opac search history
725 if (C4::Context->preference('EnableOpacSearchHistory')) {
727 my $path_info = $cgi->url(-path_info=>1);
728 my $query_cgi_history = $cgi->url(-query=>1);
729 $query_cgi_history =~ s/^$path_info\?//;
730 $query_cgi_history =~ s/;/&/g;
731 my $query_desc_history = join ", ", grep { defined $_ } $query_desc, $limit_desc;
733 unless ( $borrowernumber ) {
734 my $new_searches = C4::Search::History::add_to_session({
736 query_desc => $query_desc_history,
737 query_cgi => $query_cgi_history,
742 # To the session (the user is logged in)
743 C4::Search::History::add({
744 userid => $borrowernumber,
745 sessionid => $cgi->cookie("CGISESSID"),
746 query_desc => $query_desc_history,
747 query_cgi => $query_cgi_history,
753 $template->param( EnableOpacSearchHistory => 1 );
756 ## If there's just one result, redirect to the detail page
757 if ($total == 1 && $format ne 'rss2'
758 && $format ne 'opensearchdescription' && $format ne 'atom') {
759 my $biblionumber=$newresults[0]->{biblionumber};
760 if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
761 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
762 } elsif (C4::Context->preference('BiblioDefaultView') eq 'marc') {
763 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
765 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
770 if ( !$build_grouped_results ) {
771 # We build the encrypted list of first OPACnumSearchResults biblios to pass with the search criteria for paging on opac-detail
772 $pasarParams .= '&listBiblios=';
774 foreach (@newresults) {
775 my $bibnum = ($_->{biblionumber})?$_->{biblionumber}:0;
776 $pasarParams .= uri_escape_utf8($bibnum) . ',';
778 last if ($j == $results_per_page);
780 chop $pasarParams if ($pasarParams =~ /,$/);
781 $pasarParams .= '&total=' . uri_escape_utf8( int($total) ) if ($pasarParams !~ /total=(?:[0-9]+)?/);
783 my $session = get_session($cgi->cookie("CGISESSID"));
784 $session->param('busc' => $pasarParams);
788 $template->param(total => $hits);
789 my $limit_cgi_not_availablity = $limit_cgi;
790 $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
791 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
792 $template->param(limit_cgi => $limit_cgi);
793 $template->param(countrss => $countRSS );
794 $template->param(query_cgi => $query_cgi);
795 $template->param(query_desc => $query_desc);
796 $template->param(limit_desc => $limit_desc);
797 $template->param(offset => $offset);
798 $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
799 if ($query_desc || $limit_desc) {
800 $template->param(searchdesc => 1);
802 $template->param(results_per_page => $results_per_page);
803 my $hide = C4::Context->preference('OpacHiddenItems');
804 $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
806 if (C4::Context->userenv){
807 $branch = C4::Context->userenv->{branch};
809 if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
811 ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
813 C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
816 if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
817 $branchcode = $branch;
819 elsif ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
820 $branchcode = $ENV{'BRANCHCODE'};
823 foreach my $res ( @newresults ) {
826 my @old_loop = @{$res->{'available_items_loop'}};
827 foreach my $item ( @old_loop ) {
828 if ( $item->{'branchcode'} eq $branchcode ) {
829 $item->{'this_branch'} = 1;
830 push( @top_loop, $item );
832 push( @new_loop, $item );
835 my @complete_loop = ( @top_loop, @new_loop );
836 $res->{'available_items_loop'} = \@complete_loop;
842 SEARCH_RESULTS => \@newresults,
843 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
844 suppress_result_number => $hide,
846 if (C4::Context->preference("OPACLocalCoverImages")){
847 $template->param(OPACLocalCoverImages => 1);
848 $template->param(OPACLocalCoverImagesPriority => C4::Context->preference("OPACLocalCoverImagesPriority"));
850 ## Build the page numbers on the bottom of the page
852 my $max_result_window = $searcher->max_result_window;
853 my $hits_to_paginate = ($max_result_window && $max_result_window < $hits) ? $max_result_window : $hits;
854 $template->param( hits_to_paginate => $hits_to_paginate );
855 # total number of pages there will be
856 my $pages = ceil($hits_to_paginate / $results_per_page);
857 my $last_page_offset = ( $pages - 1 ) * $results_per_page;
858 # default page number
859 my $current_page_number = 1;
861 $current_page_number = ( $offset / $results_per_page + 1 );
863 my $previous_page_offset;
864 if ( $offset >= $results_per_page ) {
865 $previous_page_offset = $offset - $results_per_page;
867 my $next_page_offset = $offset + $results_per_page;
868 # If we're within the first 10 pages, keep it simple
869 #warn "current page:".$current_page_number;
870 if ($current_page_number < 10) {
871 # just show the first 10 pages
872 # Loop through the pages
873 my $pages_to_show = 10;
874 $pages_to_show = $pages if $pages<10;
875 for ($i=1; $i<=$pages_to_show;$i++) {
876 # the offset for this page
877 my $this_offset = (($i*$results_per_page)-$results_per_page);
878 # the page number for this page
879 my $this_page_number = $i;
880 # put it in the array
882 { offset => $this_offset,
883 pg => $this_page_number,
884 highlight => $this_page_number == $current_page_number,
885 sort_by => join ' ', @sort_by
891 # now, show twenty pages, with the current one smack in the middle
893 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
894 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
895 my $this_page_number = $i-9;
896 if ( $this_page_number <= $pages ) {
898 { offset => $this_offset,
899 pg => $this_page_number,
900 highlight => $this_page_number == $current_page_number,
901 sort_by => join ' ', @sort_by
907 $template->param( PAGE_NUMBERS => \@page_numbers,
908 last_page_offset => $last_page_offset,
909 previous_page_offset => $previous_page_offset) unless $pages < 2;
910 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
914 my $nohits = C4::Context->preference('OPACNoResultsFound');
915 if ($nohits and $nohits=~/{QUERY_KW}/){
916 # extracting keywords in case of relaunching search
917 (my $query_kw=$query_desc)=~s/ and|or / /g;
918 my @query_kw=($query_kw=~ /([-\w]+\b)(?:[^,:]|$)/g);
919 $query_kw=join('+',@query_kw);
920 $nohits=~s/{QUERY_KW}/$query_kw/g;
921 $template->param('OPACNoResultsFound' =>$nohits);
925 query_desc => $query_desc,
926 limit_desc => $limit_desc,
927 query_cgi => $query_cgi,
928 limit_cgi => $limit_cgi
931 } # end of the if local
932 # asynchronously search the authority server
933 elsif ($server && $server =~/authorityserver/) { # this is the local authority server
934 my @inner_sup_results_array;
935 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
936 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
937 my $title_field = $marc_record_object->field(100);
938 push @inner_sup_results_array, {
939 'title' => $title_field->subfield('a'),
940 'link' => "&idx=an&q=".$marc_record_object->field('001')->as_string(),
943 my $servername = $server;
944 push @sup_results_array, { servername => $servername,
945 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
947 # FIXME: can add support for other targets as needed here
948 $template->param( outer_sup_results_loop => \@sup_results_array);
949 } #/end of the for loop
950 #$template->param(FEDERATED_RESULTS => \@results_array);
952 for my $facet ( @$facets ) {
953 for my $entry ( @{ $facet->{facets} } ) {
954 my $index = $entry->{type_link_value};
955 my $value = $entry->{facet_link_value};
956 $entry->{active} = grep { $_->{input_value} eq qq{$index:$value} } @limit_inputs;
962 #classlist => $classlist,
965 facets_loop => $facets,
966 displayFacetCount=> C4::Context->preference('displayFacetCount')||0,
968 search_error => $error,
971 if ($query_desc || $limit_desc) {
972 $template->param(searchdesc => 1);
975 # VI. BUILD THE TEMPLATE
976 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
978 borrowernumber => $borrowernumber,
983 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
985 borrowernumber => $borrowernumber,
992 add_to_some_private_shelves => $some_private_shelves,
993 add_to_some_public_shelves => $some_public_shelves,
996 my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
998 # If GoogleIndicTransliteration system preference is On Set parameter to load Google's javascript in OPAC search screens
999 if (C4::Context->preference('GoogleIndicTransliteration')) {
1000 $template->param('GoogleIndicTransliteration' => 1);
1003 $template->{VARS}->{DidYouMean} =
1004 ( defined C4::Context->preference('OPACdidyoumean')
1005 && C4::Context->preference('OPACdidyoumean') =~ m/enable/ );
1006 $template->{VARS}->{IDreamBooksReviews} = C4::Context->preference('IDreamBooksReviews');
1007 $template->{VARS}->{IDreamBooksReadometer} = C4::Context->preference('IDreamBooksReadometer');
1008 $template->{VARS}->{IDreamBooksResults} = C4::Context->preference('IDreamBooksResults');
1011 if (IsOverDriveEnabled()) {
1012 $template->param(OverDriveEnabled => 1);
1013 $template->param(OverDriveLibraryID => C4::Context->preference('OverDriveLibraryID'));
1015 $template->param(RecordedBooksEnabled => C4::Context->preference( 'RecordedBooksClientSecret' ) && C4::Context->preference( 'RecordedBooksLibraryID' ));
1018 $template->param( borrowernumber => $borrowernumber);
1019 output_with_http_headers $cgi, $cookie, $template->output, $content_type;