2 # Script to perform searching
3 # Mostly copied from search.pl, see POD there
4 use strict
; # always use
7 ## STEP 1. Load things that are used in both search page and
8 # results page and decide which template to load, operations
13 use C4
::Auth
qw(:DEFAULT get_session);
15 use C4
::Biblio
; # GetBiblioData
17 use C4
::Tags
qw(get_tags);
18 use POSIX
qw(ceil floor strftime);
19 use C4
::Branch
; # GetBranches
21 # create a new CGI object
22 # FIXME: no_undef_params needs to be tested
23 use CGI
qw('-no_undef_params');
27 if (C4
::Context
->preference('BakerTaylorEnabled')) {
28 require C4
::External
::BakerTaylor
;
29 import C4
::External
::BakerTaylor
qw(&image_url &link_url);
33 my ($template,$borrowernumber,$cookie);
35 # decide which template to use
37 my $template_type = 'basic';
38 my @params = $cgi->param("limit");
40 my $format = $cgi->param("format") || '';
41 my $build_grouped_results = C4
::Context
->preference('OPACGroupResults');
42 if ($format =~ /(rss|atom|opensearchdescription)/) {
43 $template_name = 'opac-opensearch.tmpl';
45 elsif ($build_grouped_results) {
46 $template_name = 'opac-results-grouped.tmpl';
48 elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
49 $template_name = 'opac-results.tmpl';
52 $template_name = 'opac-advsearch.tmpl';
53 $template_type = 'advsearch';
56 ($template, $borrowernumber, $cookie) = get_template_and_user
({
57 template_name
=> $template_name,
64 if ($format eq 'rss2' or $format eq 'opensearchdescription' or $format eq 'atom') {
65 $template->param($format => 1);
66 $template->param(timestamp
=> strftime
("%Y-%m-%dT%H:%M:%S-00:00", gmtime)) if ($format eq 'atom');
67 # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
68 # entry, but not sure if that's worth an extra database query for each bib
70 if (C4
::Context
->preference("marcflavour") eq "UNIMARC" ) {
71 $template->param('UNIMARC' => 1);
73 elsif (C4
::Context
->preference("marcflavour") eq "MARC21" ) {
74 $template->param('usmarc' => 1);
76 $template->param( 'AllowOnShelfHolds' => C4
::Context
->preference('AllowOnShelfHolds') );
78 if (C4
::Context
->preference('BakerTaylorEnabled')) {
80 BakerTaylorEnabled
=> 1,
81 BakerTaylorImageURL
=> &image_url
(),
82 BakerTaylorLinkURL
=> &link_url
(),
83 BakerTaylorBookstoreURL
=> C4
::Context
->preference('BakerTaylorBookstoreURL'),
86 if (C4
::Context
->preference('TagsEnabled')) {
87 $template->param(TagsEnabled
=> 1);
88 foreach (qw(TagsShowOnList TagsInputOnList)) {
89 C4
::Context
->preference($_) and $template->param($_ => 1);
94 # Deprecated, but preserved because it's interesting :-)
95 # The same thing can be accomplished with mod_rewrite in
99 #my $uri = $cgi->url(-base => 1);
100 #my $relative_url = $cgi->url(-relative=>1);
101 #$uri.="/".$relative_url."?";
103 #my @cgi_params_list = $cgi->param();
104 #my $url_params = $cgi->Vars;
106 #for my $each_param_set (@cgi_params_list) {
107 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
109 #warn "New URI:$uri";
110 # Only re-write a URI if there are params or if it already hasn't been re-written
111 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
112 # print $cgi->redirect( -uri=>$uri."&r=1",
113 # -cookie => $cookie);
118 my $mybranch = ( C4
::Context
->preference('SearchMyLibraryFirst') && C4
::Context
->userenv && C4
::Context
->userenv->{branch
} ) ? C4
::Context
->userenv->{branch
} : '';
119 my $branches = GetBranches
(); # used later in *getRecords, probably should be internalized by those functions after caching in C4::Branch is established
121 branchloop
=> GetBranchesLoop
($mybranch, 0),
122 searchdomainloop
=> GetBranchCategories
(undef,'searchdomain'),
125 # load the Type stuff
126 my $itemtypes = GetItemTypes
;
127 # the index parameter is different for item-level itemtypes
128 my $itype_or_itemtype = (C4
::Context
->preference("item-level_itypes"))?
'itype':'itemtype';
132 my $advanced_search_types = C4
::Context
->preference("AdvancedSearchTypes");
134 if (!$advanced_search_types or $advanced_search_types eq 'itemtypes') {
135 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
136 my %row =( number
=>$cnt++,
137 ccl
=> $itype_or_itemtype,
138 code
=> $thisitemtype,
139 selected
=> $selected,
140 description
=> $itemtypes->{$thisitemtype}->{'description'},
142 imageurl
=> getitemtypeimagelocation
( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
144 $selected = 0; # set to zero after first pass through
145 push @itemtypesloop, \
%row;
148 my $advsearchtypes = GetAuthorisedValues
($advanced_search_types);
149 for my $thisitemtype (sort {$a->{'lib'} cmp $b->{'lib'}} @
$advsearchtypes) {
152 ccl
=> $advanced_search_types,
153 code
=> $thisitemtype->{authorised_value
},
154 selected
=> $selected,
155 description
=> $thisitemtype->{'lib'},
157 imageurl
=> getitemtypeimagelocation
( 'opac', $thisitemtype->{'imageurl'} ),
159 push @itemtypesloop, \
%row;
162 $template->param(itemtypeloop
=> \
@itemtypesloop);
164 # # load the itypes (Called item types in the template -- just authorized values for searching)
165 # my ($itypecount,@itype_loop) = GetCcodes();
166 # $template->param(itypeloop=>\@itype_loop,);
168 # The following should only be loaded if we're bringing up the advanced search template
169 if ( $template_type && $template_type eq 'advsearch' ) {
171 # load the servers (used for searching -- to do federated searching, etc.)
172 my $primary_servers_loop;# = displayPrimaryServers();
173 $template->param(outer_servers_loop
=> $primary_servers_loop,);
175 my $secondary_servers_loop;# = displaySecondaryServers();
176 $template->param(outer_sup_servers_loop
=> $secondary_servers_loop,);
178 # set the default sorting
179 my $default_sort_by = C4
::Context
->preference('OPACdefaultSortField')."_".C4
::Context
->preference('OPACdefaultSortOrder')
180 if (C4
::Context
->preference('OPACdefaultSortField') && C4
::Context
->preference('OPACdefaultSortOrder'));
181 $template->param($default_sort_by => 1);
183 # determine what to display next to the search boxes (ie, boolean option
184 # shouldn't appear on the first one, scan indexes should, adding a new
185 # box should only appear on the last, etc.
186 my @search_boxes_array;
187 my $search_boxes_count = C4
::Context
->preference("OPACAdvSearchInputCount") || 3;
188 for (my $i=1;$i<=$search_boxes_count;$i++) {
189 # if it's the first one, don't display boolean option, but show scan indexes
191 push @search_boxes_array,
197 # if it's the last one, show the 'add field' box
198 elsif ($i==$search_boxes_count) {
199 push @search_boxes_array,
206 push @search_boxes_array,
213 $template->param(uc(C4
::Context
->preference("marcflavour")) => 1, # we already did this for UNIMARC
215 search_boxes_loop
=> \
@search_boxes_array);
217 # use the global setting by default
218 if ( C4
::Context
->preference("expandedSearchOption") == 1 ) {
219 $template->param( expanded_options
=> C4
::Context
->preference("expandedSearchOption") );
221 # but let the user override it
222 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
223 $template->param( expanded_options
=> $cgi->param('expanded_options'));
226 output_html_with_http_headers
$cgi, $cookie, $template->output;
230 ### OK, if we're this far, we're performing an actual search
232 # Fetch the paramater list as a hash in scalar context:
233 # * returns paramater list as tied hash ref
234 # * we can edit the values by changing the key
235 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
236 my $params = $cgi->Vars;
238 $tag = $params->{tag
} if $params->{tag
};
240 # Params that can have more than one value
241 # sort by is used to sort the query
242 # in theory can have more than one but generally there's just one
244 my $default_sort_by = C4
::Context
->preference('OPACdefaultSortField')."_".C4
::Context
->preference('OPACdefaultSortOrder')
245 if (C4
::Context
->preference('OPACdefaultSortField') && C4
::Context
->preference('OPACdefaultSortOrder'));
247 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
248 $sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
249 foreach my $sort (@sort_by) {
250 $template->param($sort => 1); # FIXME: security hole. can set any TMPL_VAR here
252 $template->param('sort_by' => $sort_by[0]);
254 # Use the servers defined, or just search our local catalog(default)
256 @servers = split("\0",$params->{'server'}) if $params->{'server'};
258 #FIXME: this should be handled using Context.pm
259 @servers = ("biblioserver");
260 # @servers = C4::Context->config("biblioserver");
263 # operators include boolean and proximity operators and are used
264 # to evaluate multiple operands
266 @operators = split("\0",$params->{'op'}) if $params->{'op'};
268 # indexes are query qualifiers, like 'title', 'author', etc. They
269 # can be single or multiple parameters separated by comma: kw,right-Truncation
271 @indexes = split("\0",$params->{'idx'}) if $params->{'idx'};
273 # if a simple index (only one) display the index used in the top search box
274 if ($indexes[0] && !$indexes[1]) {
275 $template->param("ms_".$indexes[0] => 1);
277 # an operand can be a single term, a phrase, or a complete ccl query
279 @operands = split("\0",$params->{'q'}) if $params->{'q'};
281 # if a simple search, display the value in the search box
282 if ($operands[0] && !$operands[1]) {
283 $template->param(ms_value
=> $operands[0]);
286 # limits are use to limit to results to a pre-defined category such as branch or language
288 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
290 if($params->{'multibranchlimit'}) {
291 push @limits, join(" or ", map { "branch: $_ "} @
{GetBranchesInCategory
($params->{'multibranchlimit'})}) ;
295 foreach my $limit(@limits) {
296 if ($limit =~/available/) {
300 $template->param(available
=> $available);
302 # append year limits if they exist
303 if ($params->{'limit-yr'}) {
304 if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
305 my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
306 push @limits, "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
308 elsif ($params->{'limit-yr'} =~ /\d{4}/) {
309 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
312 #FIXME: Should return a error to the user, incorect date format specified
316 # Params that can only have one value
317 my $scan = $params->{'scan'};
318 my $count = C4
::Context
->preference('OPACnumSearchResults') || 20;
319 my $results_per_page = $params->{'count'} || $count;
320 my $offset = $params->{'offset'} || 0;
321 my $page = $cgi->param('page') || 1;
322 $offset = ($page-1)*$results_per_page if $page>1;
324 my $expanded_facet = $params->{'expand'};
326 # Define some global variables
327 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
331 ## I. BUILD THE QUERY
332 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type) = buildQuery
(\
@operators,\
@operands,\
@indexes,\
@limits,\
@sort_by);
334 sub _input_cgi_parse
($) {
336 for my $this_cgi ( split('&',shift) ) {
337 next unless $this_cgi;
338 $this_cgi =~ /(.*?)=(.*)/;
339 push @elements, { input_name
=> $1, input_value
=> $2 };
344 ## parse the query_cgi string and put it into a form suitable for <input>s
345 my @query_inputs = _input_cgi_parse
($query_cgi);
346 $template->param ( QUERY_INPUTS
=> \
@query_inputs );
348 ## parse the limit_cgi string and put it into a form suitable for <input>s
349 my @limit_inputs = $limit_cgi ? _input_cgi_parse
($limit_cgi) : ();
351 # add OPAC 'hidelostitems'
352 if (C4
::Context
->preference('hidelostitems') == 1) {
353 # either lost ge 0 or no value in the lost register
354 $query ="($query) and ( (lost,st-numeric <= 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='') )";
357 # add OPAC suppression - requires at least one item indexed with Suppress
358 if (C4
::Context
->preference('OpacSuppression')) {
359 $query = "($query) not Suppress=1";
362 $template->param ( LIMIT_INPUTS
=> \
@limit_inputs );
364 ## II. DO THE SEARCH AND GET THE RESULTS
365 my $total = 0; # the total results for the whole set
366 my $facets; # this object stores the faceted results that display on the left-hand of the results page
372 $query_cgi = "tag=" .$tag . "&" . $query_cgi;
373 my $taglist = get_tags
({term
=>$tag, approved
=>1});
374 $results_hashref->{biblioserver
}->{hits
} = scalar (@
$taglist);
375 my @biblist = (map {GetBiblioData
($_->{biblionumber
})} @
$taglist);
376 my @marclist = (map {$_->{marc
}} @biblist );
377 $DEBUG and printf STDERR
"taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@
$taglist), scalar(@marclist);
378 $results_hashref->{biblioserver
}->{RECORDS
} = \
@marclist;
379 # FIXME: tag search and standard search should work together, not exclusively
380 # FIXME: No facets for tags search.
382 elsif (C4
::Context
->preference('NoZebra')) {
384 ($error, $results_hashref, $facets) = NZgetRecords
($query,$simple_query,\
@sort_by,\
@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
386 } elsif ($build_grouped_results) {
388 ($error, $results_hashref, $facets) = C4
::Search
::pazGetRecords
($query,$simple_query,\
@sort_by,\
@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
392 ($error, $results_hashref, $facets) = getRecords
($query,$simple_query,\
@sort_by,\
@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
395 # use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
397 $template->param(query_error
=> $error.$@
);
398 output_html_with_http_headers
$cgi, $cookie, $template->output;
402 # At this point, each server has given us a result set
403 # now we build that set for template display
404 my @sup_results_array;
405 for (my $i=0;$i<=@servers;$i++) {
406 my $server = $servers[$i];
407 if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
408 $hits = $results_hashref->{$server}->{"hits"};
409 my $page = $cgi->param('page') || 0;
411 if ($build_grouped_results) {
412 foreach my $group (@
{ $results_hashref->{$server}->{"GROUPS"} }) {
413 # because pazGetRecords handles retieving only the records
414 # we want as specified by $offset and $results_per_page,
415 # we need to set the offset parameter of searchResults to 0
416 my @group_results = searchResults
( $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
417 @
{ $group->{"RECORDS"} });
418 push @newresults, { group_label
=> $group->{'group_label'}, GROUP_RESULTS
=> \
@group_results };
421 @newresults = searchResults
( $query_desc,$hits,$results_per_page,$offset,$scan,@
{$results_hashref->{$server}->{"RECORDS"}});
424 if (C4
::Context
->preference('TagsEnabled') and
425 $tag_quantity = C4
::Context
->preference('TagsShowOnList')) {
426 foreach (@newresults) {
427 my $bibnum = $_->{biblionumber
} or next;
428 $_->{itemsissued
} = CountItemsIssued
( $bibnum );
429 $_ ->{'TagLoop'} = get_tags
({biblionumber
=>$bibnum, approved
=>1, 'sort'=>'-weight',
430 limit
=>$tag_quantity });
433 foreach (@newresults) {
434 $_->{coins
} = GetCOinSBiblio
($_->{'biblionumber'});
437 if ($results_hashref->{$server}->{"hits"}){
438 $total = $total + $results_hashref->{$server}->{"hits"};
440 ## If there's just one result, redirect to the detail page
442 my $biblionumber=$newresults[0]->{biblionumber
};
443 if (C4
::Context
->preference('BiblioDefaultView') eq 'isbd') {
444 print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
445 } elsif (C4
::Context
->preference('BiblioDefaultView') eq 'marc') {
446 print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
448 print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
453 $template->param(total
=> $hits);
454 my $limit_cgi_not_availablity = $limit_cgi;
455 $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
456 $template->param(limit_cgi_not_availablity
=> $limit_cgi_not_availablity);
457 $template->param(limit_cgi
=> $limit_cgi);
458 $template->param(query_cgi
=> $query_cgi);
459 $template->param(query_desc
=> $query_desc);
460 $template->param(limit_desc
=> $limit_desc);
461 if ($query_desc || $limit_desc) {
462 $template->param(searchdesc
=> 1);
464 $template->param(stopwords_removed
=> "@$stopwords_removed") if $stopwords_removed;
465 $template->param(results_per_page
=> $results_per_page);
466 $template->param(SEARCH_RESULTS
=> \
@newresults,
467 OPACItemsResultsDisplay
=> (C4
::Context
->preference("OPACItemsResultsDisplay") eq "itemdetails"?
1:0),
469 ## Build the page numbers on the bottom of the page
471 # total number of pages there will be
472 my $pages = ceil
($hits / $results_per_page);
473 # default page number
474 my $current_page_number = 1;
475 $current_page_number = ($offset / $results_per_page + 1) if $offset;
476 my $previous_page_offset = $offset - $results_per_page unless ($offset - $results_per_page <0);
477 my $next_page_offset = $offset + $results_per_page;
478 # If we're within the first 10 pages, keep it simple
479 #warn "current page:".$current_page_number;
480 if ($current_page_number < 10) {
481 # just show the first 10 pages
482 # Loop through the pages
483 my $pages_to_show = 10;
484 $pages_to_show = $pages if $pages<10;
485 for ($i=1; $i<=$pages_to_show;$i++) {
486 # the offset for this page
487 my $this_offset = (($i*$results_per_page)-$results_per_page);
488 # the page number for this page
489 my $this_page_number = $i;
490 # it should only be highlighted if it's the current page
491 my $highlight = 1 if ($this_page_number == $current_page_number);
492 # put it in the array
493 push @page_numbers, { offset
=> $this_offset, pg
=> $this_page_number, highlight
=> $highlight, sort_by
=> join " ",@sort_by };
498 # now, show twenty pages, with the current one smack in the middle
500 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
501 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
502 my $this_page_number = $i-9;
503 my $highlight = 1 if ($this_page_number == $current_page_number);
504 if ($this_page_number <= $pages) {
505 push @page_numbers, { offset
=> $this_offset, pg
=> $this_page_number, highlight
=> $highlight, sort_by
=> join " ",@sort_by };
510 $template->param( PAGE_NUMBERS
=> \
@page_numbers,
511 previous_page_offset
=> $previous_page_offset) unless $pages < 2;
512 $template->param(next_page_offset
=> $next_page_offset) unless $pages eq $current_page_number;
516 $template->param(searchdesc
=> 1,query_desc
=> $query_desc,limit_desc
=> $limit_desc);
518 } # end of the if local
519 # asynchronously search the authority server
520 elsif ($server && $server =~/authorityserver/) { # this is the local authority server
521 my @inner_sup_results_array;
522 for my $sup_record ( @
{$results_hashref->{$server}->{"RECORDS"}} ) {
523 my $marc_record_object = MARC
::Record
->new_from_usmarc($sup_record);
524 my $title_field = $marc_record_object->field(100);
525 warn "Authority Found: ".$marc_record_object->as_formatted();
526 push @inner_sup_results_array, {
527 'title' => $title_field->subfield('a'),
528 'link' => "&idx=an&q=".$marc_record_object->field('001')->as_string(),
531 my $servername = $server;
532 push @sup_results_array, { servername
=> $servername,
533 inner_sup_results_loop
=> \
@inner_sup_results_array} if @inner_sup_results_array;
535 # FIXME: can add support for other targets as needed here
536 $template->param( outer_sup_results_loop
=> \
@sup_results_array);
537 } #/end of the for loop
538 #$template->param(FEDERATED_RESULTS => \@results_array);
541 #classlist => $classlist,
544 facets_loop
=> $facets,
546 search_error
=> $error,
549 if ($query_desc || $limit_desc) {
550 $template->param(searchdesc
=> 1);
553 # VI. BUILD THE TEMPLATE
554 # Build drop-down list for 'Add To:' menu...
555 my $session = get_session
($cgi->cookie("CGISESSID"));
557 my $pubshelves = $session->param('pubshelves');
558 my $barshelves = $session->param('barshelves');
559 foreach my $shelf (@
$pubshelves) {
560 next if ( ($shelf->{'owner'} != ($borrowernumber ?
$borrowernumber : -1)) && ($shelf->{'category'} < 3) );
561 push (@addpubshelves, $shelf);
564 if (@addpubshelves) {
565 $template->param( addpubshelves
=> scalar (@addpubshelves));
566 $template->param( addpubshelvesloop
=> \
@addpubshelves);
569 if (defined $barshelves) {
570 $template->param( addbarshelves
=> scalar (@
$barshelves));
571 $template->param( addbarshelvesloop
=> $barshelves);
574 my $content_type = ($format eq 'rss' or $format eq 'atom') ?
$format : 'html';
576 # If GoogleIndicTransliteration system preference is On Set paramter to load Google's javascript in OPAC search screens
577 if (C4
::Context
->preference('GoogleIndicTransliteration')) {
578 $template->param('GoogleIndicTransliteration' => 1);
581 output_with_http_headers
$cgi, $cookie, $template->output, $content_type;