catalogue/search.pl

   1 #!/usr/bin/perl
   2 # Script to perform searching
   3 # For documentation try 'perldoc /path/to/search'
   4 #
   5 # $Header$
   6 #
   7 # Copyright 2006 LibLime
   8 #
   9 # This file is part of Koha
  10 #
  11 # Koha is free software; you can redistribute it and/or modify it under the
  12 # terms of the GNU General Public License as published by the Free Software
  13 # Foundation; either version 2 of the License, or (at your option) any later
  14 # version.
  15 #
  16 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  17 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  18 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU General Public License along with
  21 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  22 # Suite 330, Boston, MA  02111-1307 USA
  23
  24 =head1 NAME
  25
  26 search - a search script for finding records in a Koha system (Version 3)
  27
  28 =head1 OVERVIEW
  29
  30 This script utilizes a new search API for Koha 3. It is designed to be
  31 simple to use and configure, yet capable of performing feats like stemming,
  32 field weighting, relevance ranking, support for multiple  query language
  33 formats (CCL, CQL, PQF), full support for the bib1 attribute set, extended
  34 attribute sets defined in Zebra profiles, access to the full range of Z39.50
  35 and SRU query options, federated searches on Z39.50/SRU targets, etc.
  36
  37 The API as represented in this script is mostly sound, even if the individual
  38 functions in Search.pm and Koha.pm need to be cleaned up. Of course, you are
  39 free to disagree :-)
  40
  41 I will attempt to describe what is happening at each part of this script.
  42 -- Joshua Ferraro <jmf AT liblime DOT com>
  43
  44 =head2 INTRO
  45
  46 This script performs two functions:
  47
  48 =over
  49
  50 =item 1. interacts with Koha to retrieve and display the results of a search
  51
  52 =item 2. loads the advanced search page
  53
  54 =back
  55
  56 These two functions share many of the same variables and modules, so the first
  57 task is to load what they have in common and determine which template to use.
  58 Once determined, proceed to only load the variables and procedures necessary
  59 for that function.
  60
  61 =head2 LOADING ADVANCED SEARCH PAGE
  62
  63 This is fairly straightforward, and I won't go into detail ;-)
  64
  65 =head2 PERFORMING A SEARCH
  66
  67 If we're performing a search, this script  performs three primary
  68 operations:
  69
  70 =over
  71
  72 =item 1. builds query strings (yes, plural)
  73
  74 =item 2. perform the search and return the results array
  75
  76 =item 3. build the HTML for output to the template
  77
  78 =back
  79
  80 There are several additional secondary functions performed that I will
  81 not cover in detail.
  82
  83 =head3 1. Building Query Strings
  84
  85 There are several types of queries needed in the process of search and retrieve:
  86
  87 =over
  88
  89 =item 1 $query - the fully-built query passed to zebra
  90
  91 This is the most complex query that needs to be built. The original design goal
  92 was to use a custom CCL2PQF query parser to translate an incoming CCL query into
  93 a multi-leaf query to pass to Zebra. It needs to be multi-leaf to allow field
  94 weighting, koha-specific relevance ranking, and stemming. When I have a chance
  95 I'll try to flesh out this section to better explain.
  96
  97 This query incorporates query profiles that aren't compatible with most non-Zebra
  98 Z39.50 targets to acomplish the field weighting and relevance ranking.
  99
 100 =item 2 $simple_query - a simple query that doesn't contain the field weighting,
 101 stemming, etc., suitable to pass off to other search targets
 102
 103 This query is just the user's query expressed in CCL CQL, or PQF for passing to a
 104 non-zebra Z39.50 target (one that doesn't support the extended profile that Zebra does).
 105
 106 =item 3 $query_cgi - passed to the template / saved for future refinements of
 107 the query (by user)
 108
 109 This is a simple string that completely expresses the query as a CGI string that
 110 can be used for future refinements of the query or as a part of a history feature.
 111
 112 =item 4 $query_desc - Human search description - what the user sees in search
 113 feedback area
 114
 115 This is a simple string that is human readable. It will contain '=', ',', etc.
 116
 117 =back
 118
 119 =head3 2. Perform the Search
 120
 121 This section takes the query strings and performs searches on the named servers,
 122 including the Koha Zebra server, stores the results in a deeply nested object,
 123 builds 'faceted results', and returns these objects.
 124
 125 =head3 3. Build HTML
 126
 127 The final major section of this script takes the objects collected thusfar and
 128 builds the HTML for output to the template and user.
 129
 130 =head3 Additional Notes
 131
 132 Not yet completed...
 133
 134 =cut
 135
 136 use strict;            # always use
 137
 138 ## STEP 1. Load things that are used in both search page and
 139 # results page and decide which template to load, operations
 140 # to perform, etc.
 141
 142 ## load Koha modules
 143 use C4::Context;
 144 use C4::Output;
 145 use C4::Auth;
 146 use C4::Search;
 147 use C4::Languages qw(getAllLanguages);
 148 use C4::Koha;
 149 use POSIX qw(ceil floor);
 150 use C4::Branch; # GetBranches
 151
 152 # create a new CGI object
 153 # FIXME: no_undef_params needs to be tested
 154 use CGI qw('-no_undef_params');
 155 my $cgi = new CGI;
 156
 157 my ($template,$borrowernumber,$cookie);
 158
 159 # decide which template to use
 160 my $template_name;
 161 my $template_type;
 162 my @params = $cgi->param("limit");
 163 if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
 164     $template_name = 'catalogue/results.tmpl';
 165 }
 166 else {
 167     $template_name = 'catalogue/advsearch.tmpl';
 168     $template_type = 'advsearch';
 169 }
 170 # load the template
 171 ($template, $borrowernumber, $cookie) = get_template_and_user({
 172     template_name => $template_name,
 173     query => $cgi,
 174     type => "intranet",
 175     authnotrequired => 0,
 176     flagsrequired   => { catalogue => 1 },
 177     }
 178 );
 179 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
 180     $template->param('UNIMARC' => 1);
 181 }
 182
 183 ## URI Re-Writing
 184 # Deprecated, but preserved because it's interesting :-)
 185 # The same thing can be accomplished with mod_rewrite in
 186 # a more elegant way
 187 #
 188 #my $rewrite_flag;
 189 #my $uri = $cgi->url(-base => 1);
 190 #my $relative_url = $cgi->url(-relative=>1);
 191 #$uri.="/".$relative_url."?";
 192 #warn "URI:$uri";
 193 #my @cgi_params_list = $cgi->param();
 194 #my $url_params = $cgi->Vars;
 195 #
 196 #for my $each_param_set (@cgi_params_list) {
 197 #    $uri.= join "",  map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
 198 #}
 199 #warn "New URI:$uri";
 200 # Only re-write a URI if there are params or if it already hasn't been re-written
 201 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
 202 #    print $cgi->redirect(     -uri=>$uri."&r=1",
 203 #                            -cookie => $cookie);
 204 #    exit;
 205 #}
 206
 207 # load the branches
 208 my $branches = GetBranches();
 209 my @branch_loop;
 210
 211 for my $branch_hash (sort keys %$branches) {
 212     push @branch_loop, {value => "$branch_hash" , branchname => $branches->{$branch_hash}->{'branchname'}, };
 213 }
 214
 215 my $categories = GetBranchCategories(undef,'searchdomain');
 216
 217 $template->param(branchloop => \@branch_loop, searchdomainloop => $categories);
 218
 219 # load the itemtypes
 220 my $itemtypes = GetItemTypes;
 221 my @itemtypesloop;
 222 my $selected=1;
 223 my $cnt;
 224 my $imgdir = getitemtypeimagesrc('intranet');
 225 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
 226     my %row =(  number=>$cnt++,
 227                 imageurl=> $itemtypes->{$thisitemtype}->{'imageurl'}?($imgdir."/".$itemtypes->{$thisitemtype}->{'imageurl'}):"",
 228                 code => $thisitemtype,
 229                 selected => $selected,
 230                 description => $itemtypes->{$thisitemtype}->{'description'},
 231                 count5 => $cnt % 4,
 232             );
 233     $selected = 0 if ($selected) ;
 234     push @itemtypesloop, \%row;
 235 }
 236 $template->param(itemtypeloop => \@itemtypesloop);
 237
 238 # load the ccodes
 239 # my ($ccodecount,@ccode_loop) = GetCcodes();
 240 # $template->param(ccodeloop=>\@ccode_loop,);
 241
 242 # The following should only be loaded if we're bringing up the advanced search template
 243 if ( $template_type eq 'advsearch' ) {
 244
 245     # load the servers (used for searching -- to do federated searching, etc.)
 246     my $primary_servers_loop;# = displayPrimaryServers();
 247     $template->param(outer_servers_loop =>  $primary_servers_loop,);
 248
 249     my $secondary_servers_loop;# = displaySecondaryServers();
 250     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 251
 252     # determine what to display next to the search boxes (ie, boolean option
 253     # shouldn't appear on the first one, scan indexes should, adding a new
 254     # box should only appear on the last, etc.
 255     my @search_boxes_array;
 256     my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") | 3; # FIXME: should be a syspref
 257     for (my $i=1;$i<=$search_boxes_count;$i++) {
 258         # if it's the first one, don't display boolean option, but show scan indexes
 259         if ($i==1) {
 260             push @search_boxes_array,
 261                 {
 262                 scan_index => 1,
 263                 };
 264
 265         }
 266         # if it's the last one, show the 'add field' box
 267         elsif ($i==$search_boxes_count) {
 268             push @search_boxes_array,
 269                 {
 270                 boolean => 1,
 271                 add_field => 1,
 272                 };
 273         }
 274         else {
 275             push @search_boxes_array,
 276                 {
 277                 boolean => 1,
 278                 };
 279         }
 280
 281     }
 282     $template->param(uc(C4::Context->preference("marcflavour")) => 1,
 283                       search_boxes_loop => \@search_boxes_array);
 284
 285     # load the language limits (for search)
 286     my $languages_limit_loop = getAllLanguages();
 287     $template->param(search_languages_loop => $languages_limit_loop,);
 288
 289     # use the global setting by default
 290     if ( C4::Context->preference("expandedSearchOption") == 1) {
 291         $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
 292     }
 293     # but let the user override it
 294     if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
 295         $template->param( expanded_options => $cgi->param('expanded_options'));
 296     }
 297
 298     output_html_with_http_headers $cgi, $cookie, $template->output;
 299     exit;
 300 }
 301
 302 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
 303
 304 # Fetch the paramater list as a hash in scalar context:
 305 #  * returns paramater list as tied hash ref
 306 #  * we can edit the values by changing the key
 307 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 308 my $params = $cgi->Vars;
 309
 310 # Params that can have more than one value
 311 # sort by is used to sort the query
 312 # in theory can have more than one but generally there's just one
 313 my @sort_by;
 314 my $default_sort_by = C4::Context->preference('defaultSortField')."_".C4::Context->preference('defaultSortOrder')
 315     if (C4::Context->preference('defaultSortField') && C4::Context->preference('defaultSortOrder'));
 316
 317 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
 318 $sort_by[0] = $default_sort_by unless $sort_by[0];
 319 foreach my $sort (@sort_by) {
 320     $template->param($sort => 1);
 321 }
 322 $template->param('sort_by' => $sort_by[0]);
 323
 324 # Use the servers defined, or just search our local catalog(default)
 325 my @servers;
 326 @servers = split("\0",$params->{'server'}) if $params->{'server'};
 327 unless (@servers) {
 328     #FIXME: this should be handled using Context.pm
 329     @servers = ("biblioserver");
 330     # @servers = C4::Context->config("biblioserver");
 331 }
 332 # operators include boolean and proximity operators and are used
 333 # to evaluate multiple operands
 334 my @operators;
 335 @operators = split("\0",$params->{'op'}) if $params->{'op'};
 336
 337 # indexes are query qualifiers, like 'title', 'author', etc. They
 338 # can be single or multiple parameters separated by comma: kw,right-Truncation
 339 my @indexes;
 340 @indexes = split("\0",$params->{'idx'});
 341
 342 # an operand can be a single term, a phrase, or a complete ccl query
 343 my @operands;
 344 @operands = split("\0",$params->{'q'}) if $params->{'q'};
 345
 346 # limits are use to limit to results to a pre-defined category such as branch or language
 347 my @limits;
 348 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
 349
 350 if($params->{'multibranchlimit'}) {
 351 push @limits, join(" or ", map { "branch: $_ "}  @{GetBranchesInCategory($params->{'multibranchlimit'})}) ;
 352 }
 353
 354 my $available;
 355 foreach my $limit(@limits) {
 356     if ($limit =~/available/) {
 357         $available = 1;
 358     }
 359 }
 360 $template->param(available => $available);
 361
 362 # append year limits if they exist
 363 my $limit_yr;
 364 my $limit_yr_value;
 365 if ($params->{'limit-yr'}) {
 366     if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
 367         my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
 368         $limit_yr = "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
 369         $limit_yr_value = "$yr1-$yr2";
 370     }
 371     elsif ($params->{'limit-yr'} =~ /\d{4}/) {
 372         $limit_yr = "yr,st-numeric=$params->{'limit-yr'}";
 373         $limit_yr_value = $params->{'limit-yr'};
 374     }
 375     push @limits,$limit_yr;
 376     #FIXME: Should return a error to the user, incorect date format specified
 377 }
 378
 379 # Params that can only have one value
 380 my $scan = $params->{'scan'};
 381 my $count = C4::Context->preference('numSearchResults') || 20;
 382 my $results_per_page = $params->{'count'} || $count;
 383 my $offset = $params->{'offset'} || 0;
 384 my $page = $cgi->param('page') || 1;
 385 #my $offset = ($page-1)*$results_per_page;
 386 my $hits;
 387 my $expanded_facet = $params->{'expand'};
 388
 389 # Define some global variables
 390 my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
 391
 392 my @results;
 393
 394 ## I. BUILD THE QUERY
 395 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by,$scan);
 396
 397 ## parse the query_cgi string and put it into a form suitable for <input>s
 398 my @query_inputs;
 399 for my $this_cgi ( split('&',$query_cgi) ) {
 400     next unless $this_cgi;
 401     $this_cgi =~ m/(.*=)(.*)/;
 402     my $input_name = $1;
 403     my $input_value = $2;
 404     $input_name =~ s/=$//;
 405     push @query_inputs, { input_name => $input_name, input_value => $input_value };
 406 }
 407 $template->param ( QUERY_INPUTS => \@query_inputs );
 408
 409 ## parse the limit_cgi string and put it into a form suitable for <input>s
 410 my @limit_inputs;
 411 for my $this_cgi ( split('&',$limit_cgi) ) {
 412     next unless $this_cgi;
 413     # handle special case limit-yr
 414     if ($this_cgi =~ /yr,st-numeric/) {
 415         push @limit_inputs, { input_name => 'limit-yr', input_value => $limit_yr_value };
 416         next;
 417     }
 418     $this_cgi =~ m/(.*=)(.*)/;
 419     my $input_name = $1;
 420     my $input_value = $2;
 421     $input_name =~ s/=$//;
 422     push @limit_inputs, { input_name => $input_name, input_value => $input_value };
 423 }
 424 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 425
 426 ## II. DO THE SEARCH AND GET THE RESULTS
 427 my $total; # the total results for the whole set
 428 my $facets; # this object stores the faceted results that display on the left-hand of the results page
 429 my @results_array;
 430 my $results_hashref;
 431
 432 if (C4::Context->preference('NoZebra')) {
 433     $query=~s/yr(:|=)\s*([\d]{1,4})-([\d]{1,4})/(yr>=$2 and yr<=$3)/g;
 434     $simple_query=~s/yr\s*(:|=)([\d]{1,4})-([\d]{1,4})/(yr>=$2 and yr<=$3)/g;
 435     warn $query;
 436     eval {
 437         ($error, $results_hashref, $facets) = NZgetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
 438     };
 439 } else {
 440     eval {
 441         ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
 442     };
 443 }
 444 if ($@ || $error) {
 445     $template->param(query_error => $error.$@);
 446
 447     output_html_with_http_headers $cgi, $cookie, $template->output;
 448     exit;
 449 }
 450
 451 # FIXME: This belongs in tools/ not in the primary search results page
 452 my $op=$cgi->param("operation");
 453 if ($op eq "bulkedit"){
 454     my ($countchanged,$listunchanged)=
 455     ModBiblios($results_hashref->{'biblioserver'}->{"RECORDS"},
 456                       $params->{"tagsubfield"},
 457                       $params->{"inputvalue"},
 458                       $params->{"targetvalue"},
 459                       $params->{"test"}
 460                       );
 461     $template->param(bulkeditresults=>1,
 462                       tagsubfield=>$params->{"tagsubfield"},
 463                       inputvalue=>$params->{"inputvalue"},
 464                       targetvalue=>$params->{"targetvalue"},
 465                       countchanged=>$countchanged,
 466                       countunchanged=>scalar(@$listunchanged),
 467                       listunchanged=>$listunchanged);
 468
 469     if (C4::Context->userenv->{'flags'}==1 ||(C4::Context->userenv->{'flags'} & ( 2**9 ) )){
 470     #Edit Catalogue Permissions
 471         my $editable_subfields = GetManagedTagSubfields();
 472         # change '--' to '&mdash;' to avoid escaping issues
 473         for (my $i = 0; $i <= $#{$editable_subfields}; $i++) {
 474             $editable_subfields->[$i]->{subfielddesc} =~ s/--/&mdash;/g;
 475             $editable_subfields->[$i]->{tagdesc} =~ s/--/&mdash;/g;
 476         }
 477         $template->param(bulkedit => 1);
 478         $template->param(tagsubfields=>$editable_subfields);
 479     }
 480 }
 481
 482 # At this point, each server has given us a result set
 483 # now we build that set for template display
 484 my @sup_results_array;
 485 for (my $i=0;$i<@servers;$i++) {
 486     my $server = $servers[$i];
 487     if ($server =~/biblioserver/) { # this is the local bibliographic server
 488         $hits = $results_hashref->{$server}->{"hits"};
 489         my $page = $cgi->param('page') || 0;
 490         my @newresults = searchResults( $query_desc,$hits,$results_per_page,$offset,@{$results_hashref->{$server}->{"RECORDS"}});
 491         $total = $total + $results_hashref->{$server}->{"hits"};
 492         ## If there's just one result, redirect to the detail page
 493         if ($total == 1) {
 494             my $biblionumber=@newresults[0]->{biblionumber};
 495             print $cgi->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber");
 496             exit;
 497         }
 498         if ($hits) {
 499             $template->param(total => $hits);
 500             my $limit_cgi_not_availablity = $limit_cgi;
 501             $limit_cgi_not_availablity =~ s/&limit=available//g;
 502             $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
 503             $template->param(limit_cgi => $limit_cgi);
 504             $template->param(query_cgi => $query_cgi);
 505             $template->param(query_desc => $query_desc);
 506             $template->param(limit_desc => $limit_desc);
 507             if ($query_desc || $limit_desc) {
 508                 $template->param(searchdesc => 1);
 509             }
 510             $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
 511             $template->param(results_per_page =>  $results_per_page);
 512             $template->param(SEARCH_RESULTS => \@newresults);
 513
 514             ## FIXME: add a global function for this, it's better than the current global one
 515             ## Build the page numbers on the bottom of the page
 516             my @page_numbers;
 517             # total number of pages there will be
 518             my $pages = ceil($hits / $results_per_page);
 519             # default page number
 520             my $current_page_number = 1;
 521             $current_page_number = ($offset / $results_per_page + 1) if $offset;
 522             my $previous_page_offset = $offset - $results_per_page unless ($offset - $results_per_page <0);
 523             my $next_page_offset = $offset + $results_per_page;
 524             # If we're within the first 10 pages, keep it simple
 525             #warn "current page:".$current_page_number;
 526             if ($current_page_number < 10) {
 527                 # just show the first 10 pages
 528                 # Loop through the pages
 529                 my $pages_to_show = 10;
 530                 $pages_to_show = $pages if $pages<10;
 531                 for (my $i=1; $i<=$pages_to_show;$i++) {
 532                     # the offset for this page
 533                     my $this_offset = (($i*$results_per_page)-$results_per_page);
 534                     # the page number for this page
 535                     my $this_page_number = $i;
 536                     # it should only be highlighted if it's the current page
 537                     my $highlight = 1 if ($this_page_number == $current_page_number);
 538                     # put it in the array
 539                     push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
 540
 541                 }
 542
 543             }
 544             # now, show twenty pages, with the current one smack in the middle
 545             else {
 546                 for (my $i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
 547                     my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
 548                     my $this_page_number = $i-9;
 549                     my $highlight = 1 if ($this_page_number == $current_page_number);
 550                     if ($this_page_number <= $pages) {
 551                         push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
 552                     }
 553                 }
 554
 555             }
 556             # FIXME: no previous_page_offset when pages < 2
 557             $template->param(   PAGE_NUMBERS => \@page_numbers,
 558                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
 559             $template->param(   next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
 560         }
 561         # no hits
 562         else {
 563             $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
 564         }
 565     } # end of the if local
 566
 567     # asynchronously search the authority server
 568     elsif ($server =~/authorityserver/) { # this is the local authority server
 569         my @inner_sup_results_array;
 570         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
 571             my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
 572             # warn "Authority Found: ".$marc_record_object->as_formatted();
 573             push @inner_sup_results_array, {
 574                 'title' => $marc_record_object->field(100)->subfield('a'),
 575                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
 576             };
 577         }
 578         my $servername = $server;
 579         push @sup_results_array, {  servername => $servername,
 580                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
 581     }
 582     # FIXME: can add support for other targets as needed here
 583     $template->param(           outer_sup_results_loop => \@sup_results_array);
 584 } #/end of the for loop
 585 #$template->param(FEDERATED_RESULTS => \@results_array);
 586
 587
 588 $template->param(
 589             #classlist => $classlist,
 590             total => $total,
 591             opacfacets => 1,
 592             facets_loop => $facets,
 593             scan => $scan,
 594             search_error => $error,
 595 );
 596
 597 if ($query_desc || $limit_desc) {
 598     $template->param(searchdesc => 1);
 599 }
 600
 601 ## Now let's find out if we have any supplemental data to show the user
 602 #  and in the meantime, save the current query for statistical purposes, etc.
 603 my $koha_spsuggest; # a flag to tell if we've got suggestions coming from Koha
 604 my @koha_spsuggest; # place we store the suggestions to be returned to the template as LOOP
 605 my $phrases = $query_desc;
 606 my $ipaddress;
 607
 608 if ( C4::Context->preference("kohaspsuggest") ) {
 609         my ($suggest_host, $suggest_dbname, $suggest_user, $suggest_pwd) = split(':', C4::Context->preference("kohaspsuggest"));
 610         eval {
 611             my $koha_spsuggest_dbh;
 612             # FIXME: this needs to be moved to Context.pm
 613             eval {
 614                 $koha_spsuggest_dbh=DBI->connect("DBI:mysql:$suggest_dbname:$suggest_host","$suggest_user","$suggest_pwd");
 615             };
 616             if ($@) {
 617                 warn "can't connect to spsuggest db";
 618             }
 619             else {
 620                 my $koha_spsuggest_insert = "INSERT INTO phrase_log(phr_phrase,phr_resultcount,phr_ip) VALUES(?,?,?)";
 621                 my $koha_spsuggest_query = "SELECT display FROM distincts WHERE strcmp(soundex(suggestion), soundex(?)) = 0 order by soundex(suggestion) limit 0,5";
 622                 my $koha_spsuggest_sth = $koha_spsuggest_dbh->prepare($koha_spsuggest_query);
 623                 $koha_spsuggest_sth->execute($phrases);
 624                 while (my $spsuggestion = $koha_spsuggest_sth->fetchrow_array) {
 625                     $spsuggestion =~ s/(:|\/)//g;
 626                     my %line;
 627                     $line{spsuggestion} = $spsuggestion;
 628                     push @koha_spsuggest,\%line;
 629                     $koha_spsuggest = 1;
 630                 }
 631
 632                 # Now save the current query
 633                 $koha_spsuggest_sth=$koha_spsuggest_dbh->prepare($koha_spsuggest_insert);
 634                 #$koha_spsuggest_sth->execute($phrases,$results_per_page,$ipaddress);
 635                 $koha_spsuggest_sth->finish;
 636
 637                 $template->param( koha_spsuggest => $koha_spsuggest ) unless $hits;
 638                 $template->param( SPELL_SUGGEST => \@koha_spsuggest,
 639                 );
 640             }
 641     };
 642     if ($@) {
 643             warn "Kohaspsuggest failure:".$@;
 644     }
 645 }
 646
 647 # VI. BUILD THE TEMPLATE
 648 output_html_with_http_headers $cgi, $cookie, $template->output;