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 qw(:DEFAULT get_session);
 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 { $branches->{$a}->{branchname} cmp $branches->{$b}->{branchname} } 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 Type stuff
 220 # load the Type stuff
 221 my $itemtypes = GetItemTypes;
 222 # the index parameter is different for item-level itemtypes
 223 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
 224 my @itemtypesloop;
 225 my $selected=1;
 226 my $cnt;
 227 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes");
 228
 229 if (!$advanced_search_types or $advanced_search_types eq 'itemtypes') {                                                                 foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
 230     my %row =(  number=>$cnt++,
 231                 ccl => $itype_or_itemtype,
 232                 code => $thisitemtype,
 233                 selected => $selected,
 234                 description => $itemtypes->{$thisitemtype}->{'description'},
 235                 count5 => $cnt % 4,
 236                 imageurl=> getitemtypeimagelocation( 'intranet', $itemtypes->{$thisitemtype}->{'imageurl'} ),
 237             );
 238         $selected = 0 if ($selected) ;
 239         push @itemtypesloop, \%row;
 240     }
 241     $template->param(itemtypeloop => \@itemtypesloop);
 242 } else {
 243     my $advsearchtypes = GetAuthorisedValues($advanced_search_types);
 244     for my $thisitemtype (@$advsearchtypes) {
 245         my %row =(
 246                 number=>$cnt++,
 247                 ccl => $advanced_search_types,
 248                 code => $thisitemtype->{authorised_value},
 249                 selected => $selected,
 250                 description => $thisitemtype->{'lib'},
 251                 count5 => $cnt % 4,
 252                 imageurl=> getitemtypeimagelocation( 'intranet', $thisitemtype->{'imageurl'} ),
 253             );
 254         push @itemtypesloop, \%row;
 255     }
 256     $template->param(itemtypeloop => \@itemtypesloop);
 257 }
 258
 259 # The following should only be loaded if we're bringing up the advanced search template
 260 if ( $template_type eq 'advsearch' ) {
 261
 262     # load the servers (used for searching -- to do federated searching, etc.)
 263     my $primary_servers_loop;# = displayPrimaryServers();
 264     $template->param(outer_servers_loop =>  $primary_servers_loop,);
 265
 266     my $secondary_servers_loop;# = displaySecondaryServers();
 267     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
 268
 269     # set the default sorting
 270     my $default_sort_by = C4::Context->preference('defaultSortField')."_".C4::Context->preference('defaultSortOrder')
 271         if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
 272     $template->param($default_sort_by => 1);
 273
 274     # determine what to display next to the search boxes (ie, boolean option
 275     # shouldn't appear on the first one, scan indexes should, adding a new
 276     # box should only appear on the last, etc.
 277     my @search_boxes_array;
 278     my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") | 3; # FIXME: should be a syspref
 279     for (my $i=1;$i<=$search_boxes_count;$i++) {
 280         # if it's the first one, don't display boolean option, but show scan indexes
 281         if ($i==1) {
 282             push @search_boxes_array,
 283                 {
 284                 scan_index => 1,
 285                 };
 286
 287         }
 288         # if it's the last one, show the 'add field' box
 289         elsif ($i==$search_boxes_count) {
 290             push @search_boxes_array,
 291                 {
 292                 boolean => 1,
 293                 add_field => 1,
 294                 };
 295         }
 296         else {
 297             push @search_boxes_array,
 298                 {
 299                 boolean => 1,
 300                 };
 301         }
 302
 303     }
 304     $template->param(uc(C4::Context->preference("marcflavour")) => 1,
 305                       search_boxes_loop => \@search_boxes_array);
 306
 307     # load the language limits (for search)
 308     my $languages_limit_loop = getAllLanguages();
 309     $template->param(search_languages_loop => $languages_limit_loop,);
 310
 311     # use the global setting by default
 312     if ( C4::Context->preference("expandedSearchOption") == 1) {
 313         $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
 314     }
 315     # but let the user override it
 316     if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
 317         $template->param( expanded_options => $cgi->param('expanded_options'));
 318     }
 319
 320     $template->param(virtualshelves => C4::Context->preference("virtualshelves"));
 321
 322     output_html_with_http_headers $cgi, $cookie, $template->output;
 323     exit;
 324 }
 325
 326 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
 327
 328 # Fetch the paramater list as a hash in scalar context:
 329 #  * returns paramater list as tied hash ref
 330 #  * we can edit the values by changing the key
 331 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 332 my $params = $cgi->Vars;
 333
 334 # Params that can have more than one value
 335 # sort by is used to sort the query
 336 # in theory can have more than one but generally there's just one
 337 my @sort_by;
 338 my $default_sort_by = C4::Context->preference('defaultSortField')."_".C4::Context->preference('defaultSortOrder')
 339     if (C4::Context->preference('defaultSortField') && C4::Context->preference('defaultSortOrder'));
 340
 341 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
 342 $sort_by[0] = $default_sort_by unless $sort_by[0];
 343 foreach my $sort (@sort_by) {
 344     $template->param($sort => 1);
 345 }
 346 $template->param('sort_by' => $sort_by[0]);
 347
 348 # Use the servers defined, or just search our local catalog(default)
 349 my @servers;
 350 @servers = split("\0",$params->{'server'}) if $params->{'server'};
 351 unless (@servers) {
 352     #FIXME: this should be handled using Context.pm
 353     @servers = ("biblioserver");
 354     # @servers = C4::Context->config("biblioserver");
 355 }
 356 # operators include boolean and proximity operators and are used
 357 # to evaluate multiple operands
 358 my @operators;
 359 @operators = split("\0",$params->{'op'}) if $params->{'op'};
 360
 361 # indexes are query qualifiers, like 'title', 'author', etc. They
 362 # can be single or multiple parameters separated by comma: kw,right-Truncation
 363 my @indexes;
 364 @indexes = split("\0",$params->{'idx'});
 365
 366 # if a simple index (only one)  display the index used in the top search box
 367 if ($indexes[0] && !$indexes[1]) {
 368     $template->param("ms_".$indexes[0] => 1);}
 369
 370
 371 # an operand can be a single term, a phrase, or a complete ccl query
 372 my @operands;
 373 @operands = split("\0",$params->{'q'}) if $params->{'q'};
 374
 375 # limits are use to limit to results to a pre-defined category such as branch or language
 376 my @limits;
 377 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
 378
 379 if($params->{'multibranchlimit'}) {
 380 push @limits, join(" or ", map { "branch: $_ "}  @{GetBranchesInCategory($params->{'multibranchlimit'})}) ;
 381 }
 382
 383 my $available;
 384 foreach my $limit(@limits) {
 385     if ($limit =~/available/) {
 386         $available = 1;
 387     }
 388 }
 389 $template->param(available => $available);
 390
 391 # append year limits if they exist
 392 my $limit_yr;
 393 my $limit_yr_value;
 394 if ($params->{'limit-yr'}) {
 395     if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
 396         my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
 397         $limit_yr = "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
 398         $limit_yr_value = "$yr1-$yr2";
 399     }
 400     elsif ($params->{'limit-yr'} =~ /\d{4}/) {
 401         $limit_yr = "yr,st-numeric=$params->{'limit-yr'}";
 402         $limit_yr_value = $params->{'limit-yr'};
 403     }
 404     push @limits,$limit_yr;
 405     #FIXME: Should return a error to the user, incorect date format specified
 406 }
 407
 408 # convert indexes and operands to corresponding parameter names for the z3950 search
 409 # $ %z3950p will be a hash ref if the indexes are present (advacned search), otherwise undef
 410 my $z3950par;
 411 my $indexes2z3950 = {
 412         kw=>'title', au=>'author', 'au,phr'=>'author', nb=>'isbn', ns=>'issn',
 413         'lcn,phr'=>'dewey', su=>'subject', 'su,phr'=>'subject',
 414         ti=>'title', 'ti,phr'=>'title', se=>'title'
 415 };
 416 for (my $ii = 0; $ii < @operands; ++$ii)
 417 {
 418         my $name = $indexes2z3950->{$indexes[$ii]};
 419         if (defined $name && defined $operands[$ii])
 420         {
 421                 $z3950par ||= {};
 422                 $z3950par->{$name} = $operands[$ii] if !exists $z3950par->{$name};
 423         }
 424 }
 425
 426
 427 # Params that can only have one value
 428 my $scan = $params->{'scan'};
 429 my $count = C4::Context->preference('numSearchResults') || 20;
 430 my $results_per_page = $params->{'count'} || $count;
 431 my $offset = $params->{'offset'} || 0;
 432 my $page = $cgi->param('page') || 1;
 433 #my $offset = ($page-1)*$results_per_page;
 434 my $hits;
 435 my $expanded_facet = $params->{'expand'};
 436
 437 # Define some global variables
 438 my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
 439
 440 my @results;
 441
 442 ## I. BUILD THE QUERY
 443 my $lang = C4::Output::getlanguagecookie($cgi);
 444 ( $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,$lang);
 445
 446 ## parse the query_cgi string and put it into a form suitable for <input>s
 447 my @query_inputs;
 448 my $scan_index_to_use;
 449
 450 for my $this_cgi ( split('&',$query_cgi) ) {
 451     next unless $this_cgi;
 452     $this_cgi =~ m/(.*=)(.*)/;
 453     my $input_name = $1;
 454     my $input_value = $2;
 455     $input_name =~ s/=$//;
 456     push @query_inputs, { input_name => $input_name, input_value => $input_value };
 457         if ($input_name eq 'idx') {
 458         $scan_index_to_use = $input_value; # unless $scan_index_to_use;
 459         }
 460 }
 461 $template->param ( QUERY_INPUTS => \@query_inputs,
 462                    scan_index_to_use => $scan_index_to_use );
 463
 464 ## parse the limit_cgi string and put it into a form suitable for <input>s
 465 my @limit_inputs;
 466 for my $this_cgi ( split('&',$limit_cgi) ) {
 467     next unless $this_cgi;
 468     # handle special case limit-yr
 469     if ($this_cgi =~ /yr,st-numeric/) {
 470         push @limit_inputs, { input_name => 'limit-yr', input_value => $limit_yr_value };
 471         next;
 472     }
 473     $this_cgi =~ m/(.*=)(.*)/;
 474     my $input_name = $1;
 475     my $input_value = $2;
 476     $input_name =~ s/=$//;
 477     push @limit_inputs, { input_name => $input_name, input_value => $input_value };
 478 }
 479 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 480
 481 ## II. DO THE SEARCH AND GET THE RESULTS
 482 my $total; # the total results for the whole set
 483 my $facets; # this object stores the faceted results that display on the left-hand of the results page
 484 my @results_array;
 485 my $results_hashref;
 486
 487 if (C4::Context->preference('NoZebra')) {
 488     $query=~s/yr(:|=)\s*([\d]{1,4})-([\d]{1,4})/(yr>=$2 and yr<=$3)/g;
 489     $simple_query=~s/yr\s*(:|=)([\d]{1,4})-([\d]{1,4})/(yr>=$2 and yr<=$3)/g;
 490     warn $query;
 491     eval {
 492         ($error, $results_hashref, $facets) = NZgetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
 493     };
 494 } else {
 495     eval {
 496         ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
 497     };
 498 }
 499 if ($@ || $error) {
 500     $template->param(query_error => $error.$@);
 501
 502     output_html_with_http_headers $cgi, $cookie, $template->output;
 503     exit;
 504 }
 505
 506 # At this point, each server has given us a result set
 507 # now we build that set for template display
 508 my @sup_results_array;
 509 for (my $i=0;$i<@servers;$i++) {
 510     my $server = $servers[$i];
 511     if ($server =~/biblioserver/) { # this is the local bibliographic server
 512         $hits = $results_hashref->{$server}->{"hits"};
 513         my $page = $cgi->param('page') || 0;
 514         my @newresults = searchResults( $query_desc,$hits,$results_per_page,$offset,$scan,@{$results_hashref->{$server}->{"RECORDS"}});
 515         $total = $total + $results_hashref->{$server}->{"hits"};
 516         ## If there's just one result, redirect to the detail page
 517         if ($total == 1) {
 518             my $biblionumber=@newresults[0]->{biblionumber};
 519                         my $defaultview = C4::Context->preference('IntranetBiblioDefaultView');
 520                         my $views = { C4::Search::enabled_staff_search_views };
 521             if ($defaultview eq 'isbd' && $views->{can_view_ISBD}) {
 522                 print $cgi->redirect("/cgi-bin/koha/catalogue/ISBDdetail.pl?biblionumber=$biblionumber");
 523             } elsif  ($defaultview eq 'marc' && $views->{can_view_MARC}) {
 524                 print $cgi->redirect("/cgi-bin/koha/catalogue/MARCdetail.pl?biblionumber=$biblionumber");
 525             } elsif  ($defaultview eq 'labeled_marc' && $views->{can_view_labeledMARC}) {
 526                 print $cgi->redirect("/cgi-bin/koha/catalogue/labeledMARCdetail.pl?biblionumber=$biblionumber");
 527             } else {
 528                 print $cgi->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber");
 529             }
 530             exit;
 531         }
 532
 533
 534
 535         if ($hits) {
 536             $template->param(total => $hits);
 537             my $limit_cgi_not_availablity = $limit_cgi;
 538             $limit_cgi_not_availablity =~ s/&limit=available//g;
 539             $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
 540             $template->param(limit_cgi => $limit_cgi);
 541             $template->param(query_cgi => $query_cgi);
 542             $template->param(query_desc => $query_desc);
 543             $template->param(limit_desc => $limit_desc);
 544                         $template->param (z3950_search_params => C4::Search::z3950_search_args($query_desc));
 545             if ($query_desc || $limit_desc) {
 546                 $template->param(searchdesc => 1);
 547             }
 548             $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
 549             $template->param(results_per_page =>  $results_per_page);
 550             $template->param(SEARCH_RESULTS => \@newresults);
 551
 552             ## FIXME: add a global function for this, it's better than the current global one
 553             ## Build the page numbers on the bottom of the page
 554             my @page_numbers;
 555             # total number of pages there will be
 556             my $pages = ceil($hits / $results_per_page);
 557             # default page number
 558             my $current_page_number = 1;
 559             $current_page_number = ($offset / $results_per_page + 1) if $offset;
 560             my $previous_page_offset = $offset - $results_per_page unless ($offset - $results_per_page <0);
 561             my $next_page_offset = $offset + $results_per_page;
 562             # If we're within the first 10 pages, keep it simple
 563             #warn "current page:".$current_page_number;
 564             if ($current_page_number < 10) {
 565                 # just show the first 10 pages
 566                 # Loop through the pages
 567                 my $pages_to_show = 10;
 568                 $pages_to_show = $pages if $pages<10;
 569                 for (my $i=1; $i<=$pages_to_show;$i++) {
 570                     # the offset for this page
 571                     my $this_offset = (($i*$results_per_page)-$results_per_page);
 572                     # the page number for this page
 573                     my $this_page_number = $i;
 574                     # it should only be highlighted if it's the current page
 575                     my $highlight = 1 if ($this_page_number == $current_page_number);
 576                     # put it in the array
 577                     push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
 578
 579                 }
 580
 581             }
 582
 583
 584
 585             # now, show twenty pages, with the current one smack in the middle
 586             else {
 587                 for (my $i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
 588                     my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
 589                     my $this_page_number = $i-9;
 590                     my $highlight = 1 if ($this_page_number == $current_page_number);
 591                     if ($this_page_number <= $pages) {
 592                         push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
 593                     }
 594                 }
 595
 596             }
 597             # FIXME: no previous_page_offset when pages < 2
 598             $template->param(   PAGE_NUMBERS => \@page_numbers,
 599                                 previous_page_offset => $previous_page_offset) unless $pages < 2;
 600             $template->param(   next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
 601         }
 602
 603
 604
 605
 606
 607         # no hits
 608         else {
 609             $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
 610                         $template->param (z3950_search_params => C4::Search::z3950_search_args($z3950par || $query_desc));
 611         }
 612
 613
 614
 615
 616
 617     } # end of the if local
 618
 619     # asynchronously search the authority server
 620     elsif ($server =~/authorityserver/) { # this is the local authority server
 621         my @inner_sup_results_array;
 622         for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
 623             my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
 624             # warn "Authority Found: ".$marc_record_object->as_formatted();
 625             push @inner_sup_results_array, {
 626                 'title' => $marc_record_object->field(100)->subfield('a'),
 627                 'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
 628             };
 629         }
 630         my $servername = $server;
 631         push @sup_results_array, {  servername => $servername,
 632                                     inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
 633     }
 634     # FIXME: can add support for other targets as needed here
 635     $template->param(           outer_sup_results_loop => \@sup_results_array);
 636 } #/end of the for loop
 637 #$template->param(FEDERATED_RESULTS => \@results_array);
 638
 639
 640 $template->param(
 641             #classlist => $classlist,
 642             total => $total,
 643             opacfacets => 1,
 644             facets_loop => $facets,
 645             scan => $scan,
 646             search_error => $error,
 647 );
 648
 649 if ($query_desc || $limit_desc) {
 650     $template->param(searchdesc => 1);
 651 }
 652
 653 ## Now let's find out if we have any supplemental data to show the user
 654 #  and in the meantime, save the current query for statistical purposes, etc.
 655 my $koha_spsuggest; # a flag to tell if we've got suggestions coming from Koha
 656 my @koha_spsuggest; # place we store the suggestions to be returned to the template as LOOP
 657 my $phrases = $query_desc;
 658 my $ipaddress;
 659
 660 if ( C4::Context->preference("kohaspsuggest") ) {
 661         my ($suggest_host, $suggest_dbname, $suggest_user, $suggest_pwd) = split(':', C4::Context->preference("kohaspsuggest"));
 662         eval {
 663             my $koha_spsuggest_dbh;
 664             # FIXME: this needs to be moved to Context.pm
 665             eval {
 666                 $koha_spsuggest_dbh=DBI->connect("DBI:mysql:$suggest_dbname:$suggest_host","$suggest_user","$suggest_pwd");
 667             };
 668             if ($@) {
 669                 warn "can't connect to spsuggest db";
 670             }
 671             else {
 672                 my $koha_spsuggest_insert = "INSERT INTO phrase_log(phr_phrase,phr_resultcount,phr_ip) VALUES(?,?,?)";
 673                 my $koha_spsuggest_query = "SELECT display FROM distincts WHERE strcmp(soundex(suggestion), soundex(?)) = 0 order by soundex(suggestion) limit 0,5";
 674                 my $koha_spsuggest_sth = $koha_spsuggest_dbh->prepare($koha_spsuggest_query);
 675                 $koha_spsuggest_sth->execute($phrases);
 676                 while (my $spsuggestion = $koha_spsuggest_sth->fetchrow_array) {
 677                     $spsuggestion =~ s/(:|\/)//g;
 678                     my %line;
 679                     $line{spsuggestion} = $spsuggestion;
 680                     push @koha_spsuggest,\%line;
 681                     $koha_spsuggest = 1;
 682                 }
 683
 684                 # Now save the current query
 685                 $koha_spsuggest_sth=$koha_spsuggest_dbh->prepare($koha_spsuggest_insert);
 686                 #$koha_spsuggest_sth->execute($phrases,$results_per_page,$ipaddress);
 687                 $koha_spsuggest_sth->finish;
 688
 689                 $template->param( koha_spsuggest => $koha_spsuggest ) unless $hits;
 690                 $template->param( SPELL_SUGGEST => \@koha_spsuggest,
 691                 );
 692             }
 693     };
 694     if ($@) {
 695             warn "Kohaspsuggest failure:".$@;
 696     }
 697 }
 698
 699 # VI. BUILD THE TEMPLATE
 700
 701 # Build drop-down list for 'Add To:' menu...
 702 my $session = get_session($cgi->cookie("CGISESSID"));
 703 my @addpubshelves;
 704 my $pubshelves = $session->param('pubshelves');
 705 my $barshelves = $session->param('barshelves');
 706 foreach my $shelf (@$pubshelves) {
 707         next if ( ($shelf->{'owner'} != ($borrowernumber ? $borrowernumber : -1)) && ($shelf->{'category'} < 3) );
 708         push (@addpubshelves, $shelf);
 709 }
 710
 711 if (@addpubshelves) {
 712         $template->param( addpubshelves     => scalar (@addpubshelves));
 713         $template->param( addpubshelvesloop => \@addpubshelves);
 714 }
 715
 716 if (defined $barshelves) {
 717         $template->param( addbarshelves     => scalar (@$barshelves));
 718         $template->param( addbarshelvesloop => $barshelves);
 719 }
 720
 721
 722
 723 output_html_with_http_headers $cgi, $cookie, $template->output;