2 # Script to perform searching
3 # Mostly copied from search.pl, see POD there
4 use strict; # always use
6 ## STEP 1. Load things that are used in both search page and
7 # results page and decide which template to load, operations
12 use C4::Auth qw(:DEFAULT get_session);
14 use C4::Biblio; # GetBiblioData
16 use C4::Tags qw(get_tags);
17 use POSIX qw(ceil floor strftime);
18 use C4::Branch; # GetBranches
20 # create a new CGI object
21 # FIXME: no_undef_params needs to be tested
22 use CGI qw('-no_undef_params');
26 if (C4::Context->preference('BakerTaylorEnabled')) {
27 require C4::External::BakerTaylor;
28 import C4::External::BakerTaylor qw(&image_url &link_url);
32 my ($template,$borrowernumber,$cookie);
34 # decide which template to use
36 my $template_type = 'basic';
37 my @params = $cgi->param("limit");
39 my $format = $cgi->param("format") || '';
40 my $build_grouped_results = C4::Context->preference('OPACGroupResults');
41 if ($format =~ /(rss|atom|opensearchdescription)/) {
42 $template_name = 'opac-opensearch.tmpl';
44 elsif ($build_grouped_results) {
45 $template_name = 'opac-results-grouped.tmpl';
47 elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
48 $template_name = 'opac-results.tmpl';
51 $template_name = 'opac-advsearch.tmpl';
52 $template_type = 'advsearch';
55 ($template, $borrowernumber, $cookie) = get_template_and_user({
56 template_name => $template_name,
63 if ($format eq 'rss2' or $format eq 'opensearchdescription' or $format eq 'atom') {
64 $template->param($format => 1);
65 $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime)) if ($format eq 'atom');
66 # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
67 # entry, but not sure if that's worth an extra database query for each bib
69 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
70 $template->param('UNIMARC' => 1);
72 elsif (C4::Context->preference("marcflavour") eq "MARC21" ) {
73 $template->param('usmarc' => 1);
75 $template->param( 'AllowOnShelfHolds' => C4::Context->preference('AllowOnShelfHolds') );
77 if (C4::Context->preference('BakerTaylorEnabled')) {
79 BakerTaylorEnabled => 1,
80 BakerTaylorImageURL => &image_url(),
81 BakerTaylorLinkURL => &link_url(),
82 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
85 if (C4::Context->preference('TagsEnabled')) {
86 $template->param(TagsEnabled => 1);
87 foreach (qw(TagsShowOnList TagsInputOnList)) {
88 C4::Context->preference($_) and $template->param($_ => 1);
93 # Deprecated, but preserved because it's interesting :-)
94 # The same thing can be accomplished with mod_rewrite in
98 #my $uri = $cgi->url(-base => 1);
99 #my $relative_url = $cgi->url(-relative=>1);
100 #$uri.="/".$relative_url."?";
102 #my @cgi_params_list = $cgi->param();
103 #my $url_params = $cgi->Vars;
105 #for my $each_param_set (@cgi_params_list) {
106 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
108 #warn "New URI:$uri";
109 # Only re-write a URI if there are params or if it already hasn't been re-written
110 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
111 # print $cgi->redirect( -uri=>$uri."&r=1",
112 # -cookie => $cookie);
117 my $mybranch = ( C4::Context->preference('SearchMyLibraryFirst') && C4::Context->userenv && C4::Context->userenv->{branch} ) ? C4::Context->userenv->{branch} : '';
118 my $branches = GetBranches(); # used later in *getRecords, probably should be internalized by those functions after caching in C4::Branch is established
120 branchloop => GetBranchesLoop($mybranch, 0),
121 searchdomainloop => GetBranchCategories(undef,'searchdomain'),
124 # load the Type stuff
125 my $itemtypes = GetItemTypes;
126 # the index parameter is different for item-level itemtypes
127 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
131 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes");
133 if (!$advanced_search_types or $advanced_search_types eq 'itemtypes') {
134 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
135 my %row =( number=>$cnt++,
136 ccl => $itype_or_itemtype,
137 code => $thisitemtype,
138 selected => $selected,
139 description => $itemtypes->{$thisitemtype}->{'description'},
141 imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
143 $selected = 0; # set to zero after first pass through
144 push @itemtypesloop, \%row;
147 my $advsearchtypes = GetAuthorisedValues($advanced_search_types);
148 for my $thisitemtype (@$advsearchtypes) {
151 ccl => $advanced_search_types,
152 code => $thisitemtype->{authorised_value},
153 selected => $selected,
154 description => $thisitemtype->{'lib'},
156 imageurl=> getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
158 push @itemtypesloop, \%row;
161 $template->param(itemtypeloop => \@itemtypesloop);
163 # # load the itypes (Called item types in the template -- just authorized values for searching)
164 # my ($itypecount,@itype_loop) = GetCcodes();
165 # $template->param(itypeloop=>\@itype_loop,);
167 # The following should only be loaded if we're bringing up the advanced search template
168 if ( $template_type eq 'advsearch' ) {
170 # load the servers (used for searching -- to do federated searching, etc.)
171 my $primary_servers_loop;# = displayPrimaryServers();
172 $template->param(outer_servers_loop => $primary_servers_loop,);
174 my $secondary_servers_loop;# = displaySecondaryServers();
175 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
177 # set the default sorting
178 my $default_sort_by = C4::Context->preference('OPACdefaultSortField')."_".C4::Context->preference('OPACdefaultSortOrder')
179 if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
180 $template->param($default_sort_by => 1);
182 # determine what to display next to the search boxes (ie, boolean option
183 # shouldn't appear on the first one, scan indexes should, adding a new
184 # box should only appear on the last, etc.
185 my @search_boxes_array;
186 my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") || 3;
187 for (my $i=1;$i<=$search_boxes_count;$i++) {
188 # if it's the first one, don't display boolean option, but show scan indexes
190 push @search_boxes_array,
196 # if it's the last one, show the 'add field' box
197 elsif ($i==$search_boxes_count) {
198 push @search_boxes_array,
205 push @search_boxes_array,
212 $template->param(uc(C4::Context->preference("marcflavour")) => 1, # we already did this for UNIMARC
214 search_boxes_loop => \@search_boxes_array);
216 # use the global setting by default
217 if ( C4::Context->preference("expandedSearchOption") == 1 ) {
218 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
220 # but let the user override it
221 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
222 $template->param( expanded_options => $cgi->param('expanded_options'));
225 output_html_with_http_headers $cgi, $cookie, $template->output;
229 ### OK, if we're this far, we're performing an actual search
231 # Fetch the paramater list as a hash in scalar context:
232 # * returns paramater list as tied hash ref
233 # * we can edit the values by changing the key
234 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
235 my $params = $cgi->Vars;
237 $tag = $params->{tag} if $params->{tag};
239 # Params that can have more than one value
240 # sort by is used to sort the query
241 # in theory can have more than one but generally there's just one
243 my $default_sort_by = C4::Context->preference('OPACdefaultSortField')."_".C4::Context->preference('OPACdefaultSortOrder')
244 if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
246 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
247 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
248 foreach my $sort (@sort_by) {
249 $template->param($sort => 1); # FIXME: security hole. can set any TMPL_VAR here
251 $template->param('sort_by' => $sort_by[0]);
253 # Use the servers defined, or just search our local catalog(default)
255 @servers = split("\0",$params->{'server'}) if $params->{'server'};
257 #FIXME: this should be handled using Context.pm
258 @servers = ("biblioserver");
259 # @servers = C4::Context->config("biblioserver");
262 # operators include boolean and proximity operators and are used
263 # to evaluate multiple operands
265 @operators = split("\0",$params->{'op'}) if $params->{'op'};
267 # indexes are query qualifiers, like 'title', 'author', etc. They
268 # can be single or multiple parameters separated by comma: kw,right-Truncation
269 my @indexes = exists($params->{'idx'}) ? split("\0",$params->{'idx'}) : ();
271 # if a simple index (only one) display the index used in the top search box
272 if ($indexes[0] && !$indexes[1]) {
273 $template->param("ms_".$indexes[0] => 1);
275 # an operand can be a single term, a phrase, or a complete ccl query
277 @operands = split("\0",$params->{'q'}) if $params->{'q'};
279 # if a simple search, display the value in the search box
280 if ($operands[0] && !$operands[1]) {
281 $template->param(ms_value => $operands[0]);
284 # limits are use to limit to results to a pre-defined category such as branch or language
286 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
288 if($params->{'multibranchlimit'}) {
289 push @limits, join(" or ", map { "branch: $_ "} @{GetBranchesInCategory($params->{'multibranchlimit'})}) ;
293 foreach my $limit(@limits) {
294 if ($limit =~/available/) {
298 $template->param(available => $available);
300 # append year limits if they exist
301 if ($params->{'limit-yr'}) {
302 if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
303 my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
304 push @limits, "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
306 elsif ($params->{'limit-yr'} =~ /\d{4}/) {
307 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
310 #FIXME: Should return a error to the user, incorect date format specified
314 # Params that can only have one value
315 my $scan = $params->{'scan'};
316 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
317 my $results_per_page = $params->{'count'} || $count;
318 my $offset = $params->{'offset'} || 0;
319 my $page = $cgi->param('page') || 1;
320 $offset = ($page-1)*$results_per_page if $page>1;
322 my $expanded_facet = $params->{'expand'};
324 # Define some global variables
325 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
329 ## I. BUILD THE QUERY
330 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by);
332 sub _input_cgi_parse ($) {
334 for my $this_cgi ( split('&',shift) ) {
335 next unless $this_cgi;
336 $this_cgi =~ /(.*?)=(.*)/;
337 push @elements, { input_name => $1, input_value => $2 };
342 ## parse the query_cgi string and put it into a form suitable for <input>s
343 my @query_inputs = _input_cgi_parse($query_cgi);
344 $template->param ( QUERY_INPUTS => \@query_inputs );
346 ## parse the limit_cgi string and put it into a form suitable for <input>s
347 my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
349 # add OPAC 'hidelostitems'
350 if (C4::Context->preference('hidelostitems') == 1) {
351 # either lost ge 0 or no value in the lost register
352 $query ="($query) and ( (lost,st-numeric <= 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='') )";
355 # add OPAC suppression - requires at least one item indexed with Suppress
356 if (C4::Context->preference('OpacSuppression')) {
357 $query = "($query) not Suppress=1";
360 $template->param ( LIMIT_INPUTS => \@limit_inputs );
362 ## II. DO THE SEARCH AND GET THE RESULTS
363 my $total = 0; # the total results for the whole set
364 my $facets; # this object stores the faceted results that display on the left-hand of the results page
369 $query_cgi = "tag=" .$tag . "&" . $query_cgi;
370 my $taglist = get_tags({term=>$tag, approved=>1});
371 $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
372 my @biblist = (map {GetBiblioData($_->{biblionumber})} @$taglist);
373 my @marclist = (map {$_->{marc}} @biblist );
374 $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
375 $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
376 # FIXME: tag search and standard search should work together, not exclusively
377 # FIXME: No facets for tags search.
379 elsif (C4::Context->preference('NoZebra')) {
381 ($error, $results_hashref, $facets) = NZgetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
383 } elsif ($build_grouped_results) {
385 ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
389 ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
392 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
394 $template->param(query_error => $error.$@);
395 output_html_with_http_headers $cgi, $cookie, $template->output;
399 # At this point, each server has given us a result set
400 # now we build that set for template display
401 my @sup_results_array;
402 for (my $i=0;$i<=@servers;$i++) {
403 my $server = $servers[$i];
404 if ($server =~/biblioserver/) { # this is the local bibliographic server
405 $hits = $results_hashref->{$server}->{"hits"};
406 my $page = $cgi->param('page') || 0;
408 if ($build_grouped_results) {
409 foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
410 # because pazGetRecords handles retieving only the records
411 # we want as specified by $offset and $results_per_page,
412 # we need to set the offset parameter of searchResults to 0
413 my @group_results = searchResults( $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
414 @{ $group->{"RECORDS"} });
415 push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
418 @newresults = searchResults( $query_desc,$hits,$results_per_page,$offset,$scan,@{$results_hashref->{$server}->{"RECORDS"}});
421 if (C4::Context->preference('TagsEnabled') and
422 $tag_quantity = C4::Context->preference('TagsShowOnList')) {
423 foreach (@newresults) {
424 my $bibnum = $_->{biblionumber} or next;
425 $_->{itemsissued} = CountItemsIssued( $bibnum );
426 $_ ->{'TagLoop'} = get_tags({biblionumber=>$bibnum, approved=>1, 'sort'=>'-weight',
427 limit=>$tag_quantity });
430 foreach (@newresults) {
431 $_->{'coins'} = GetCOinSBiblio($_->{'biblionumber'});
432 my $clean = $_->{isbn} or next;
434 $clean =~ /\b(\d{13})\b/ or
435 $clean =~ /\b(\d{10})\b/ or
436 $clean =~ /\b(\d{9}X)\b/i
440 $_ ->{'clean_isbn'} = $1;
443 if ($results_hashref->{$server}->{"hits"}){
444 $total = $total + $results_hashref->{$server}->{"hits"};
446 ## If there's just one result, redirect to the detail page
448 my $biblionumber=$newresults[0]->{biblionumber};
449 if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
450 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
451 } elsif (C4::Context->preference('BiblioDefaultView') eq 'marc') {
452 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
454 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
459 $template->param(total => $hits);
460 my $limit_cgi_not_availablity = $limit_cgi;
461 $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
462 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
463 $template->param(limit_cgi => $limit_cgi);
464 $template->param(query_cgi => $query_cgi);
465 $template->param(query_desc => $query_desc);
466 $template->param(limit_desc => $limit_desc);
467 if ($query_desc || $limit_desc) {
468 $template->param(searchdesc => 1);
470 $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
471 $template->param(results_per_page => $results_per_page);
472 $template->param(SEARCH_RESULTS => \@newresults,
473 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay") eq "itemdetails"?1:0),
475 ## Build the page numbers on the bottom of the page
477 # total number of pages there will be
478 my $pages = ceil($hits / $results_per_page);
479 # default page number
480 my $current_page_number = 1;
481 $current_page_number = ($offset / $results_per_page + 1) if $offset;
482 my $previous_page_offset = $offset - $results_per_page unless ($offset - $results_per_page <0);
483 my $next_page_offset = $offset + $results_per_page;
484 # If we're within the first 10 pages, keep it simple
485 #warn "current page:".$current_page_number;
486 if ($current_page_number < 10) {
487 # just show the first 10 pages
488 # Loop through the pages
489 my $pages_to_show = 10;
490 $pages_to_show = $pages if $pages<10;
491 for ($i=1; $i<=$pages_to_show;$i++) {
492 # the offset for this page
493 my $this_offset = (($i*$results_per_page)-$results_per_page);
494 # the page number for this page
495 my $this_page_number = $i;
496 # it should only be highlighted if it's the current page
497 my $highlight = 1 if ($this_page_number == $current_page_number);
498 # put it in the array
499 push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
504 # now, show twenty pages, with the current one smack in the middle
506 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
507 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
508 my $this_page_number = $i-9;
509 my $highlight = 1 if ($this_page_number == $current_page_number);
510 if ($this_page_number <= $pages) {
511 push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
516 $template->param( PAGE_NUMBERS => \@page_numbers,
517 previous_page_offset => $previous_page_offset) unless $pages < 2;
518 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
522 $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
524 } # end of the if local
525 # asynchronously search the authority server
526 elsif ($server =~/authorityserver/) { # this is the local authority server
527 my @inner_sup_results_array;
528 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
529 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
530 my $title_field = $marc_record_object->field(100);
531 warn "Authority Found: ".$marc_record_object->as_formatted();
532 push @inner_sup_results_array, {
533 'title' => $title_field->subfield('a'),
534 'link' => "&idx=an&q=".$marc_record_object->field('001')->as_string(),
537 my $servername = $server;
538 push @sup_results_array, { servername => $servername,
539 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
541 # FIXME: can add support for other targets as needed here
542 $template->param( outer_sup_results_loop => \@sup_results_array);
543 } #/end of the for loop
544 #$template->param(FEDERATED_RESULTS => \@results_array);
547 #classlist => $classlist,
550 facets_loop => $facets,
552 search_error => $error,
555 if ($query_desc || $limit_desc) {
556 $template->param(searchdesc => 1);
559 # VI. BUILD THE TEMPLATE
560 # NOTE: not using application/atom+xml or application/rss+xml beccause of Internet Explorer 6;
562 my $content_type = ($cgi->param('format') && $cgi->param('format') =~ /rss|atom/) ? "application/xml" :
565 # Build drop-down list for 'Add To:' menu...
566 my $session = get_session($cgi->cookie("CGISESSID"));
568 my $pubshelves = $session->param('pubshelves');
569 my $barshelves = $session->param('barshelves');
570 foreach my $shelf (@$pubshelves) {
571 next if ( ($shelf->{'owner'} != ($borrowernumber ? $borrowernumber : -1)) && ($shelf->{'category'} < 3) );
572 push (@addpubshelves, $shelf);
575 if (@addpubshelves) {
576 $template->param( addpubshelves => scalar (@addpubshelves));
577 $template->param( addpubshelvesloop => \@addpubshelves);
580 if (defined $barshelves) {
581 $template->param( addbarshelves => scalar (@$barshelves));
582 $template->param( addbarshelvesloop => $barshelves);
585 my $content_type = ($format eq 'rss' or $format eq 'atom') ? $format : 'html';
587 output_html_with_http_headers $cgi, $cookie, $template->output, $content_type;