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
15 use POSIX qw(ceil floor);
16 use C4::Branch; # GetBranches
18 # create a new CGI object
19 # FIXME: no_undef_params needs to be tested
20 use CGI qw('-no_undef_params');
23 my ($template,$borrowernumber,$cookie);
25 # decide which template to use
28 my @params = $cgi->param("limit");
29 if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
30 $template_name = 'opac-results.tmpl';
33 $template_name = 'opac-advsearch.tmpl';
34 $template_type = 'advsearch';
37 ($template, $borrowernumber, $cookie) = get_template_and_user({
38 template_name => $template_name,
44 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
45 $template->param('UNIMARC' => 1);
49 # Deprecated, but preserved because it's interesting :-)
50 # The same thing can be accomplished with mod_rewrite in
54 #my $uri = $cgi->url(-base => 1);
55 #my $relative_url = $cgi->url(-relative=>1);
56 #$uri.="/".$relative_url."?";
58 #my @cgi_params_list = $cgi->param();
59 #my $url_params = $cgi->Vars;
61 #for my $each_param_set (@cgi_params_list) {
62 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
65 # Only re-write a URI if there are params or if it already hasn't been re-written
66 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
67 # print $cgi->redirect( -uri=>$uri."&r=1",
68 # -cookie => $cookie);
73 my $branches = GetBranches();
76 for my $branch_hash (sort keys %$branches) {
77 push @branch_loop, {value => "$branch_hash" , branchname => $branches->{$branch_hash}->{'branchname'}, };
80 my $categories = GetBranchCategories(undef,'searchdomain');
82 $template->param(branchloop => \@branch_loop, searchdomainloop => $categories);
85 my $itemtypes = GetItemTypes;
89 my $imgdir = getitemtypeimagesrc();
90 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
91 my %row =( number=>$cnt++,
92 imageurl=> $itemtypes->{$thisitemtype}->{'imageurl'}?($imgdir."/".$itemtypes->{$thisitemtype}->{'imageurl'}):"",
93 code => $thisitemtype,
94 selected => $selected,
95 description => $itemtypes->{$thisitemtype}->{'description'},
98 $selected = 0 if ($selected) ;
99 push @itemtypesloop, \%row;
101 $template->param(itemtypeloop => \@itemtypesloop);
103 # # load the itypes (Called item types in the template -- just authorized values for searching)
104 # my ($itypecount,@itype_loop) = GetCcodes();
105 # $template->param(itypeloop=>\@itype_loop,);
107 # The following should only be loaded if we're bringing up the advanced search template
108 if ( $template_type eq 'advsearch' ) {
110 # load the servers (used for searching -- to do federated searching, etc.)
111 my $primary_servers_loop;# = displayPrimaryServers();
112 $template->param(outer_servers_loop => $primary_servers_loop,);
114 my $secondary_servers_loop;# = displaySecondaryServers();
115 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
117 # determine what to display next to the search boxes (ie, boolean option
118 # shouldn't appear on the first one, scan indexes should, adding a new
119 # box should only appear on the last, etc.
120 my @search_boxes_array;
121 my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") | 3; # FIXME: should be a syspref
122 for (my $i=1;$i<=$search_boxes_count;$i++) {
123 # if it's the first one, don't display boolean option, but show scan indexes
125 push @search_boxes_array,
131 # if it's the last one, show the 'add field' box
132 elsif ($i==$search_boxes_count) {
133 push @search_boxes_array,
140 push @search_boxes_array,
147 $template->param(uc(C4::Context->preference("marcflavour")) => 1,
149 search_boxes_loop => \@search_boxes_array);
151 # use the global setting by default
152 if ( C4::Context->preference("expandedSearchOption") == 1) {
153 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
155 # but let the user override it
156 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
157 $template->param( expanded_options => $cgi->param('expanded_options'));
160 output_html_with_http_headers $cgi, $cookie, $template->output;
164 ### OK, if we're this far, we're performing an actual search
166 # Fetch the paramater list as a hash in scalar context:
167 # * returns paramater list as tied hash ref
168 # * we can edit the values by changing the key
169 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
170 my $params = $cgi->Vars;
172 # Params that can have more than one value
173 # sort by is used to sort the query
174 # in theory can have more than one but generally there's just one
176 my $default_sort_by = C4::Context->preference('OPACdefaultSortField')."_".C4::Context->preference('OPACdefaultSortOrder')
177 if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
179 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
180 $sort_by[0] = $default_sort_by unless $sort_by[0];
181 foreach my $sort (@sort_by) {
182 $template->param($sort => 1);
184 $template->param('sort_by' => $sort_by[0]);
186 # Use the servers defined, or just search our local catalog(default)
188 @servers = split("\0",$params->{'server'}) if $params->{'server'};
190 #FIXME: this should be handled using Context.pm
191 @servers = ("biblioserver");
192 # @servers = C4::Context->config("biblioserver");
195 # operators include boolean and proximity operators and are used
196 # to evaluate multiple operands
198 @operators = split("\0",$params->{'op'}) if $params->{'op'};
200 # indexes are query qualifiers, like 'title', 'author', etc. They
201 # can be single or multiple parameters separated by comma: kw,right-Truncation
202 my @indexes = split("\0",$params->{'idx'});
204 # if a simple index (only one) display the index used in the top search box
205 if ($indexes[0] && !$indexes[1]) {
206 $template->param("ms_".$indexes[0] => 1);
208 # an operand can be a single term, a phrase, or a complete ccl query
210 @operands = split("\0",$params->{'q'}) if $params->{'q'};
212 # if a simple search, display the value in the search box
213 if ($operands[0] && !$operands[1]) {
214 $template->param(ms_value => $operands[0]);
217 # limits are use to limit to results to a pre-defined category such as branch or language
219 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
221 if($params->{'multibranchlimit'}) {
222 push @limits, join(" or ", map { "branch: $_ "} @{GetBranchesInCategory($params->{'multibranchlimit'})}) ;
226 foreach my $limit(@limits) {
227 if ($limit =~/available/) {
231 $template->param(available => $available);
233 # append year limits if they exist
234 if ($params->{'limit-yr'}) {
235 if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
236 my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
237 push @limits, "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
239 elsif ($params->{'limit-yr'} =~ /\d{4}/) {
240 push @limits, "yr,st-numeric=$params->{'limit-yr'}";
243 #FIXME: Should return a error to the user, incorect date format specified
247 # Params that can only have one value
248 my $scan = $params->{'scan'};
249 my $count = C4::Context->preference('OPACnumSearchResults') || 20;
250 my $results_per_page = $params->{'count'} || $count;
251 my $offset = $params->{'offset'} || 0;
252 my $page = $cgi->param('page') || 1;
253 #my $offset = ($page-1)*$results_per_page;
255 my $expanded_facet = $params->{'expand'};
257 # Define some global variables
258 my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
262 ## I. BUILD THE QUERY
263 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by);
265 sub _input_cgi_parse ($) {
267 for my $this_cgi ( split('&',shift) ) {
268 next unless $this_cgi;
269 $this_cgi =~ /(.*)=(.*)/;
271 my $input_value = $2;
272 push @elements, { input_name => $input_name, input_value => $input_value };
277 ## parse the query_cgi string and put it into a form suitable for <input>s
278 my @query_inputs = _input_cgi_parse($query_cgi);
279 $template->param ( QUERY_INPUTS => \@query_inputs );
281 ## parse the limit_cgi string and put it into a form suitable for <input>s
282 my @limit_inputs = _input_cgi_parse($limit_cgi);
284 # add OPAC 'hidelostitems'
285 if (C4::Context->preference('hidelostitems') == 1) {
286 # either lost ge 0 or no value in the lost register
287 $query ="($query) and ( (lost,st-numeric <= 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='') )";
290 # add OPAC suppression - requires at least one item indexed with Suppress
291 if (C4::Context->preference('OpacSuppression')) {
292 $query = "($query) not Suppress=1";
295 $template->param ( LIMIT_INPUTS => \@limit_inputs );
297 ## II. DO THE SEARCH AND GET THE RESULTS
298 my $total; # the total results for the whole set
299 my $facets; # this object stores the faceted results that display on the left-hand of the results page
303 if (C4::Context->preference('NoZebra')) {
305 ($error, $results_hashref, $facets) = NZgetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
309 ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
313 $template->param(query_error => $error.$@);
314 output_html_with_http_headers $cgi, $cookie, $template->output;
318 # At this point, each server has given us a result set
319 # now we build that set for template display
320 my @sup_results_array;
321 for (my $i=0;$i<=@servers;$i++) {
322 my $server = $servers[$i];
323 if ($server =~/biblioserver/) { # this is the local bibliographic server
324 $hits = $results_hashref->{$server}->{"hits"};
325 my $page = $cgi->param('page') || 0;
326 my @newresults = searchResults( $query_desc,$hits,$results_per_page,$offset,@{$results_hashref->{$server}->{"RECORDS"}});
327 $total = $total + $results_hashref->{$server}->{"hits"};
329 $template->param(total => $hits);
330 my $limit_cgi_not_availablity = $limit_cgi;
331 $limit_cgi_not_availablity =~ s/&limit=available//g;
332 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
333 $template->param(limit_cgi => $limit_cgi);
334 $template->param(query_cgi => $query_cgi);
335 $template->param(query_desc => $query_desc);
336 $template->param(limit_desc => $limit_desc);
337 if ($query_desc || $limit_desc) {
338 $template->param(searchdesc => 1);
340 $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
341 $template->param(results_per_page => $results_per_page);
342 $template->param(SEARCH_RESULTS => \@newresults,
343 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay") eq "itemdetails"?1:0),
345 ## Build the page numbers on the bottom of the page
347 # total number of pages there will be
348 my $pages = ceil($hits / $results_per_page);
349 # default page number
350 my $current_page_number = 1;
351 $current_page_number = ($offset / $results_per_page + 1) if $offset;
352 my $previous_page_offset = $offset - $results_per_page unless ($offset - $results_per_page <0);
353 my $next_page_offset = $offset + $results_per_page;
354 # If we're within the first 10 pages, keep it simple
355 #warn "current page:".$current_page_number;
356 if ($current_page_number < 10) {
357 # just show the first 10 pages
358 # Loop through the pages
359 my $pages_to_show = 10;
360 $pages_to_show = $pages if $pages<10;
361 for ($i=1; $i<=$pages_to_show;$i++) {
362 # the offset for this page
363 my $this_offset = (($i*$results_per_page)-$results_per_page);
364 # the page number for this page
365 my $this_page_number = $i;
366 # it should only be highlighted if it's the current page
367 my $highlight = 1 if ($this_page_number == $current_page_number);
368 # put it in the array
369 push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
374 # now, show twenty pages, with the current one smack in the middle
376 for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
377 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
378 my $this_page_number = $i-9;
379 my $highlight = 1 if ($this_page_number == $current_page_number);
380 if ($this_page_number <= $pages) {
381 push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
386 $template->param( PAGE_NUMBERS => \@page_numbers,
387 previous_page_offset => $previous_page_offset) unless $pages < 2;
388 $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
392 $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
394 } # end of the if local
395 # asynchronously search the authority server
396 elsif ($server =~/authorityserver/) { # this is the local authority server
397 my @inner_sup_results_array;
398 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
399 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
400 my $title_field = $marc_record_object->field(100);
401 warn "Authority Found: ".$marc_record_object->as_formatted();
402 push @inner_sup_results_array, {
403 'title' => $title_field->subfield('a'),
404 'link' => "&idx=an&q=".$marc_record_object->field('001')->as_string(),
407 my $servername = $server;
408 push @sup_results_array, { servername => $servername,
409 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
411 # FIXME: can add support for other targets as needed here
412 $template->param( outer_sup_results_loop => \@sup_results_array);
413 } #/end of the for loop
414 #$template->param(FEDERATED_RESULTS => \@results_array);
417 #classlist => $classlist,
420 facets_loop => $facets,
422 search_error => $error,
425 if ($query_desc || $limit_desc) {
426 $template->param(searchdesc => 1);
429 ## Now let's find out if we have any supplemental data to show the user
430 # and in the meantime, save the current query for statistical purposes, etc.
431 my $koha_spsuggest; # a flag to tell if we've got suggestions coming from Koha
432 my @koha_spsuggest; # place we store the suggestions to be returned to the template as LOOP
433 my $phrases = $query_desc;
436 if ( C4::Context->preference("kohaspsuggest") ) {
437 my ($suggest_host, $suggest_dbname, $suggest_user, $suggest_pwd) = split(':', C4::Context->preference("kohaspsuggest"));
439 my $koha_spsuggest_dbh;
440 # FIXME: this needs to be moved to Context.pm
442 $koha_spsuggest_dbh=DBI->connect("DBI:mysql:$suggest_dbname:$suggest_host","$suggest_user","$suggest_pwd");
445 warn "can't connect to spsuggest db";
448 my $koha_spsuggest_insert = "INSERT INTO phrase_log(phr_phrase,phr_resultcount,phr_ip) VALUES(?,?,?)";
449 my $koha_spsuggest_query = "SELECT display FROM distincts WHERE strcmp(soundex(suggestion), soundex(?)) = 0 order by soundex(suggestion) limit 0,5";
450 my $koha_spsuggest_sth = $koha_spsuggest_dbh->prepare($koha_spsuggest_query);
451 $koha_spsuggest_sth->execute($phrases);
452 while (my $spsuggestion = $koha_spsuggest_sth->fetchrow_array) {
453 $spsuggestion =~ s/(:|\/)//g;
455 $line{spsuggestion} = $spsuggestion;
456 push @koha_spsuggest,\%line;
460 # Now save the current query
461 $koha_spsuggest_sth=$koha_spsuggest_dbh->prepare($koha_spsuggest_insert);
462 #$koha_spsuggest_sth->execute($phrases,$results_per_page,$ipaddress);
463 $koha_spsuggest_sth->finish;
465 $template->param( koha_spsuggest => $koha_spsuggest ) unless $hits;
466 $template->param( SPELL_SUGGEST => \@koha_spsuggest,
471 warn "Kohaspsuggest failure:".$@;
475 # VI. BUILD THE TEMPLATE
476 output_html_with_http_headers $cgi, $cookie, $template->output;