installer (part 1): started major changes
[koha_fer] / opac / opac-search.pl
index d57a2b3..fb0e46d 100755 (executable)
 #!/usr/bin/perl
-use strict;
-require Exporter;
+# Script to perform searching
+# For documentation try 'perldoc /path/to/search'
+#
+# $Header$
+#
+# Copyright 2006 LibLime
+#
+# This file is part of Koha
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
+# Suite 330, Boston, MA  02111-1307 USA
 
-use C4::Auth;
-use C4::Interface::CGI::Output;
+=head1 NAME
+
+search - a search script for finding records in a Koha system (Version 3.0)
+
+=head1 OVERVIEW
+
+This script contains a new search API for Koha 3.0. It is designed to be 
+simple to use and configure, yet capable of performing feats like stemming,
+field weighting, relevance ranking, support for multiple  query language
+formats (CCL, CQL, PQF), full or nearly full support for the
+bib1 attribute set, extended attribute sets defined in Zebra profiles, access
+to the full range of Z39.50 query options, federated searches on Z39.50
+targets, etc.
+
+I believe the API as represented in this script is mostly sound, even if the
+individual functions in Search.pm and Koha.pm need to be cleaned up. Of course,
+you are free to disagree :-)
+
+I will attempt to describe what is happening at each part of this script.
+-- JF
+
+=head2 INTRO
+
+This script performs two functions:
+
+=over 
+
+=item 1. interacts with Koha to retrieve and display the results of a search
+
+=item 2. loads the advanced search page
+
+=back
+
+These two functions share many of the same variables and modules, so the first
+task is to load what they have in common and determine which template to use.
+Once determined, proceed to only load the variables and procedures necessary
+for that function.
+
+=head2 THE ADVANCED SEARCH PAGE
+
+If we're loading the advanced search page this script will call a number of
+display* routines which populate objects that are sent to the template for 
+display of things like search indexes, languages, search limits, branches,
+etc. These are not stored in the template for two reasons:
+
+=over
+
+=item 1. Efficiency - we have more control over objects inside the script, 
+and it's possible to not duplicate things like indexes (if the search indexes 
+were stored in the template they would need to be repeated)
+
+=item 2. Customization - if these elements were moved to the sql database it 
+would allow a simple librarian to determine which fields to display on the page 
+without editing any html (also how the fields should behave when being searched).
+
+=back
+
+However, they create one problem : the strings aren't translated. I have an idea
+for how to do this that I will purusue soon.
+
+=head2 PERFORMING A SEARCH
+
+If we're performing a search, this script  performs three primary
+operations:
+
+=over 
+
+=item 1. builds query strings (yes, plural)
+
+=item 2. perform the search and return the results array
+
+=item 3. build the HTML for output to the template
+
+=back
+
+There are several additional secondary functions performed that I will
+not cover in detail.
+
+=head3 1. Building Query Strings
+    
+There are several types of queries needed in the process of search and retrieve:
+
+=over
+
+=item 1 Koha query - the query that is passed to Zebra
+
+This is the most complex query that needs to be built. The original design goal 
+was to use a custom CCL2PQF query parser to translate an incoming CCL query into
+a multi-leaf query to pass to Zebra. It needs to be multi-leaf to allow field 
+weighting, koha-specific relevance ranking, and stemming. When I have a chance 
+I'll try to flesh out this section to better explain.
+
+This query incorporates query profiles that aren't compatible with non-Zebra 
+Z39.50 targets to acomplish the field weighting and relevance ranking.
+
+=item 2 Federated query - the query that is passed to other Z39.50 targets
+
+This query is just the user's query expressed in CCL CQL, or PQF for passing to a 
+non-zebra Z39.50 target (one that doesn't support the extended profile that Zebra does).
+
+=item 3 Search description - passed to the template / saved for future refinements of 
+the query (by user)
+
+This is a simple string that completely expresses the query in a way that can be parsed 
+by Koha for future refinements of the query or as a part of a history feature. It differs
+from the human search description:
+
+1. it does not contain commas or = signs
+
+=item 4 Human search description - what the user sees in the search_desc area
+
+This is a simple string nearly identical to the Search description, but more human 
+readable. It will contain = signs or commas, etc.
+
+=back
+
+=head3 2. Perform the Search
+
+This section takes the query strings and performs searches on the named servers, including
+the Koha Zebra server, stores the results in a deeply nested object, builds 'faceted results',
+and returns these objects.
+
+=head3 3. Build HTML
+
+The final major section of this script takes the objects collected thusfar and builds the
+HTML for output to the template and user.
+
+=head3 Additional Notes
+
+Not yet completed...
+
+=cut
+
+use strict;            # always use
+
+## STEP 1. Load things that are used in both search page and
+# results page and decide which template to load, operations 
+# to perform, etc.
+## load Koha modules
 use C4::Context;
-use CGI;
-use C4::Database;
-use HTML::Template;
-use C4::SearchMarc;
-use C4::Acquisition;
-use C4::Biblio;
+use C4::Output;
+use C4::Auth;
 use C4::Search;
+use C4::Languages; # getAllLanguages
+use C4::Koha;
+use POSIX qw(ceil floor);
+use C4::Branch; # GetBranches
+# create a new CGI object
+# not sure undef_params option is working, need to test
+use CGI qw('-no_undef_params');
+my $cgi = new CGI;
 
-my $classlist='';
+my ($template,$borrowernumber,$cookie);
 
-my $dbh=C4::Context->dbh;
-my $sth=$dbh->prepare("select description,itemtype from itemtypes order by description");
-$sth->execute;
-while (my ($description,$itemtype) = $sth->fetchrow) {
-    $classlist.="<option value=\"$itemtype\">$description</option>\n";
+# decide which template to use
+my $template_name;
+my $template_type;
+my @params = $cgi->param("limit");
+if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
+    $template_name = 'opac-results.tmpl';
+}
+else {
+    $template_name = 'opac-advsearch.tmpl';
+       $template_type = 'advsearch';
+}
+# load the template
+($template, $borrowernumber, $cookie) = get_template_and_user({
+    template_name => $template_name,
+    query => $cgi,
+    type => "opac",
+    authnotrequired => 1,
+    }
+);
+if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
+       $template->param('UNIMARC' => 1);
 }
 
+=head1 BUGS and FIXMEs
 
-my $query = new CGI;
-my $op = $query->param("op");
-my $type=$query->param('type');
+There are many, most are documented in the code. The one that
+isn't fully documented, but referred to is the need for a full
+query parser.
 
-my $startfrom=$query->param('startfrom');
-$startfrom=0 if(!defined $startfrom);
-my ($template, $loggedinuser, $cookie);
-my $resultsperpage;
+=cut
 
-if ($op eq "do_search") {
-       my @marclist = $query->param('marclist');
-       my @and_or = $query->param('and_or');
-       my @excluding = $query->param('excluding');
-       my @operator = $query->param('operator');
-       my @value = $query->param('value');
+## URI Re-Writing
+# Deprecated, but preserved because it's interesting :-)
+#my $rewrite_flag;
+#my $uri = $cgi->url(-base => 1);
+#my $relative_url = $cgi->url(-relative=>1);
+#$uri.="/".$relative_url."?";
+#warn "URI:$uri";
+#my @cgi_params_list = $cgi->param();
+#my $url_params = $cgi->Vars;
+#
+#for my $each_param_set (@cgi_params_list) {
+#    $uri.= join "",  map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
+#}
+#warn "New URI:$uri";
+# Only re-write a URI if there are params or if it already hasn't been re-written
+#unless (($cgi->param('r')) || (!$cgi->param()) ) {
+#    print $cgi->redirect(     -uri=>$uri."&r=1",
+#                            -cookie => $cookie);
+#    exit;
+#}
 
-       $resultsperpage= $query->param('resultsperpage');
-       $resultsperpage = 19 if(!defined $resultsperpage);
-       my $orderby = $query->param('orderby');
+# load the branches
+my $branches = GetBranches();
+my @branch_loop;
+#push @branch_loop, {value => "", branchname => "All Branches", };
+for my $branch_hash (sort keys %$branches) {
+    push @branch_loop, {value => "$branch_hash" , branchname => $branches->{$branch_hash}->{'branchname'}, };
+}
 
-       # builds tag and subfield arrays
-       my @tags;
+my $categories = GetBranchCategories(undef,'searchdomain');
 
-       foreach my $marc (@marclist) {
-               if ($marc) {
-                       my ($tag,$subfield) = MARCfind_marc_from_kohafield($dbh,$marc);
-                       if ($tag) {
-                               push @tags,$dbh->quote("$tag$subfield");
-                       } else {
-                               push @tags, $dbh->quote(substr($marc,0,4));
-                       }
-               } else {
-                       push @tags, "";
+$template->param(branchloop => \@branch_loop, searchdomainloop => $categories);
+
+# load the itemtypes
+my $itemtypes = GetItemTypes;
+my @itemtypesloop;
+my $selected=1;
+my $cnt;
+my $imgdir = getitemtypeimagesrc();
+foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
+    my %row =(  number=>$cnt++,
+                imageurl=> $itemtypes->{$thisitemtype}->{'imageurl'}?($imgdir."/".$itemtypes->{$thisitemtype}->{'imageurl'}):"",
+                code => $thisitemtype,
+                selected => $selected,
+                description => $itemtypes->{$thisitemtype}->{'description'},
+                count5 => $cnt % 4,
+            );
+    $selected = 0 if ($selected) ;
+    push @itemtypesloop, \%row;
+}
+$template->param(itemtypeloop => \@itemtypesloop);
+
+# # load the itypes (Called item types in the template -- just authorized values for searching)
+# my ($itypecount,@itype_loop) = GetCcodes();
+# $template->param(itypeloop=>\@itype_loop,);
+
+# load the languages ( for switching from one template to another )
+$template->param(languages_loop => getTranslatedLanguages('intranet','prog'));
+
+# The following should only be loaded if we're bringing up the advanced search template
+if ( $template_type eq 'advsearch' ) {
+    # load the servers (used for searching -- to do federated searching, etc.)
+    my $primary_servers_loop;# = displayPrimaryServers();
+    $template->param(outer_servers_loop =>  $primary_servers_loop,);
+    
+    my $secondary_servers_loop;# = displaySecondaryServers();
+    $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
+    
+    # determine what to display next to the search boxes (ie, boolean option
+    # shouldn't appear on the first one, scan indexes should, adding a new
+    # box should only appear on the last, etc.
+    my @search_boxes_array;
+    my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") | 3; # FIXME: should be a syspref
+    for (my $i=1;$i<=$search_boxes_count;$i++) {
+               # if it's the first one, don't display boolean option, but show scan indexes
+        if ($i==1) {
+            push @search_boxes_array,
+                {
+                scan_index => 1,
+                };
+        
+        }
+               # if it's the last one, show the 'add field' box
+        elsif ($i==$search_boxes_count) {
+            push @search_boxes_array,
+                {
+                               boolean => 1,
+                add_field => 1,
+                               };
+        }
+               else {
+                       push @search_boxes_array,
+                               {
+                               boolean => 1,
+                               };
                }
+
+    }
+    $template->param(uc(C4::Context->preference("marcflavour")) => 1,
+                      search_boxes_loop => \@search_boxes_array);
+
+    # load the language limits (for search)
+    my $languages_limit_loop = getAllLanguages();
+    $template->param(search_languages_loop => $languages_limit_loop,);
+
+       # use the global setting by default
+       if ( C4::Context->preference("expandedSearchOption") == 1) {
+               $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
        }
-       findseealso($dbh,\@tags);
-       my ($results,$total) = catalogsearch($dbh, \@tags,\@and_or,
-                                                                               \@excluding, \@operator, \@value,
-                                                                               $startfrom*$resultsperpage, $resultsperpage,$orderby);
-
-       ($template, $loggedinuser, $cookie)
-               = get_template_and_user({template_name => "opac-searchresults.tmpl",
-                               query => $query,
-                               type => 'opac',
-                               authnotrequired => 1,
-                               debug => 1,
-                               });
-
-       # multi page display gestion
-       my $displaynext=0;
-       my $displayprev=$startfrom;
-       if(($total - (($startfrom+1)*($resultsperpage))) > 0 ){
-               $displaynext = 1;
+       # but let the user override it
+       if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
+       $template->param( expanded_options => $cgi->param('expanded_options'));
        }
 
-       my @field_data = ();
+    output_html_with_http_headers $cgi, $cookie, $template->output;
+    exit;
+}
 
+### OK, if we're this far, we're performing an actual search
 
-       for(my $i = 0 ; $i <= $#marclist ; $i++)
-       {
-               push @field_data, { term => "marclist", val=>$marclist[$i] };
-               push @field_data, { term => "and_or", val=>$and_or[$i] };
-               push @field_data, { term => "excluding", val=>$excluding[$i] };
-               push @field_data, { term => "operator", val=>$operator[$i] };
-               push @field_data, { term => "value", val=>$value[$i] };
-       }
+# Fetch the paramater list as a hash in scalar context:
+#  * returns paramater list as tied hash ref
+#  * we can edit the values by changing the key
+#  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
+my $params = $cgi->Vars;
 
-       my @numbers = ();
-
-       if ($total>$resultsperpage)
-       {
-               for (my $i=1; $i<$total/$resultsperpage+1; $i++)
-               {
-                       if ($i<16)
-                       {
-                       my $highlight=0;
-                       ($startfrom==($i-1)) && ($highlight=1);
-                       push @numbers, { number => $i,
-                                       highlight => $highlight ,
-                                       searchdata=> \@field_data,
-                                       startfrom => ($i-1)};
-                       }
-       }
-       }
+# Params that can have more than one value
+# sort by is used to sort the query
+# in theory can have more than one but generally there's just one
+my $default_sort_by = C4::Context->preference('OPACdefaultSortField')."_".C4::Context->preference('OPACdefaultSortOrder') 
+    if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
+
+my @sort_by;
+@sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
+$sort_by[0] = $default_sort_by unless $sort_by[0];
+foreach my $sort (@sort_by) {
+       $template->param($sort => 1);
+}
+$template->param('sort_by' => $sort_by[0]);
+
+# Use the servers defined, or just search our local catalog(default)
+my @servers;
+@servers = split("\0",$params->{'server'}) if $params->{'server'};
+unless (@servers) {
+    #FIXME: this should be handled using Context.pm
+    @servers = ("biblioserver");
+    # @servers = C4::Context->config("biblioserver");
+}
+
+# operators include boolean and proximity operators and are used
+# to evaluate multiple operands
+my @operators;
+@operators = split("\0",$params->{'op'}) if $params->{'op'};
+
+# indexes are query qualifiers, like 'title', 'author', etc. They
+# can be single or multiple parameters separated by comma: kw,right-Truncation 
+my @indexes = split("\0",$params->{'idx'});
+
+# if a simple index (only one)  display the index used in the top search box
+if ($indexes[0] && !$indexes[1]) {
+       $template->param("ms_".$indexes[0] => 1);
+}
+# an operand can be a single term, a phrase, or a complete ccl query
+my @operands;
+@operands = split("\0",$params->{'q'}) if $params->{'q'};
+
+# if a simple search, display the value in the search box
+if ($operands[0] && !$operands[1]) {
+    $template->param(ms_value => $operands[0]);
+}
+
+# limits are use to limit to results to a pre-defined category such as branch or language
+my @limits;
+@limits = split("\0",$params->{'limit'}) if $params->{'limit'};
+
+if($params->{'multibranchlimit'}) {
+push @limits, join(" or ", map { "branch: $_ "}  @{GetBranchesInCategory($params->{'multibranchlimit'})}) ;
+}
+
+my $available;
+foreach my $limit(@limits) {
+    if ($limit =~/available/) {
+        $available = 1;
+    }
+}
+$template->param(available => $available);
+
+# append year limits if they exist
+push @limits, map "yr:".$_, split("\0",$params->{'limit-yr'}) if $params->{'limit-yr'};
+
+# Params that can only have one value
+my $scan = $params->{'scan'};
+my $count = C4::Context->preference('OPACnumSearchResults') || 20;
+my $results_per_page = $params->{'count'} || $count;
+my $offset = $params->{'offset'} || 0;
+my $page = $cgi->param('page') || 1;
+#my $offset = ($page-1)*$results_per_page;
+my $hits;
+my $expanded_facet = $params->{'expand'};
 
-       my $from = $startfrom*$resultsperpage+1;
-       my $to;
+# Define some global variables
+my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
 
-       if($total < (($startfrom+1)*$resultsperpage))
-       {
-               $to = $total;
-       } else {
-               $to = (($startfrom+1)*$resultsperpage);
+my @results;
+
+## I. BUILD THE QUERY
+( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by);
+
+sub _input_cgi_parse ($) { 
+       my @elements;
+       for my $this_cgi ( split('&',shift) ) {
+               next unless $this_cgi;
+               $this_cgi =~ /(.*)=(.*)/;
+               my $input_name = $1;
+               my $input_value = $2;
+               push @elements, { input_name => $input_name, input_value => $input_value };
        }
-       $template->param(results => $results,
-                                                       startfrom=> $startfrom,
-                                                       displaynext=> $displaynext,
-                                                       displayprev=> $displayprev,
-                                                       resultsperpage => $resultsperpage,
-                                                       orderby => $orderby,
-                                                       startfromnext => $startfrom+1,
-                                                       startfromprev => $startfrom-1,
-                                                       searchdata=>\@field_data,
-                                                       total=>$total,
-                                                       from=>$from,
-                                                       to=>$to,
-                                                       numbers=>\@numbers,
-                                                       );
+       return @elements;
+}
+
+## parse the query_cgi string and put it into a form suitable for <input>s
+my @query_inputs = _input_cgi_parse($query_cgi);
+$template->param ( QUERY_INPUTS => \@query_inputs );
+
+## parse the limit_cgi string and put it into a form suitable for <input>s
+my @limit_inputs = _input_cgi_parse($query_cgi);
+
+# add OPAC 'hidelostitems'
+# not items with 
+if (C4::Context->preference('hidelostitems') == 1) {
+       $query ="($query) not ((lost,st-numeric gt 0) or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches=''))";
+       warn "Q".$query;
+}
+# add OPAC suppression - requires at least one item indexed with Suppress
+if (C4::Context->preference('OpacSuppression')) {
+    $query = "($query) not Suppress=1";
+}
+$template->param ( LIMIT_INPUTS => \@limit_inputs );
+
+## II. DO THE SEARCH AND GET THE RESULTS
+my $total; # the total results for the whole set
+my $facets; # this object stores the faceted results that display on the left-hand of the results page
+my @results_array;
+my $results_hashref;
 
+if (C4::Context->preference('NoZebra')) {
+    eval {
+        ($error, $results_hashref, $facets) = NZgetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
+    };
 } else {
-       ($template, $loggedinuser, $cookie)
-               = get_template_and_user({template_name => "opac-search.tmpl",
-                                       query => $query,
-                                       type => "opac",
-                                       authnotrequired => 1,
-                               });
-       
-       
-       $sth=$dbh->prepare("Select itemtype,description from itemtypes order by description");
-       $sth->execute;
-       my  @itemtype;
-       my %itemtypes;
-       push @itemtype, "";
-       $itemtypes{''} = "";
-       while (my ($value,$lib) = $sth->fetchrow_array) {
-               push @itemtype, $value;
-               $itemtypes{$value}=$lib;
-       }
-       
-       my $CGIitemtype=CGI::scrolling_list( -name     => 'value',
-                               -values   => \@itemtype,
-                               -labels   => \%itemtypes,
-                               -size     => 1,
-                               -multiple => 0 );
-       $sth->finish;
-       
-       my @branches;
-       my @select_branch;
-       my %select_branches;
-       my ($count2,@branches)=branches();
-       push @select_branch, "";
-       $select_branches{''} = "";
-       for (my $i=0;$i<$count2;$i++){
-               push @select_branch, $branches[$i]->{'branchcode'};#
-               $select_branches{$branches[$i]->{'branchcode'}} = $branches[$i]->{'branchname'};
+    eval {
+        ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
+    };
+}
+if ($@ || $error) {
+    $template->param(query_error => $error.$@);
+    output_html_with_http_headers $cgi, $cookie, $template->output;
+    exit;
+}
+
+# FIXME: This belongs in tools/ not in the primary search results page
+my $op=$cgi->param("operation");
+if ($op eq "bulkedit"){
+       my ($countchanged,$listunchanged)=
+       ModBiblios($results_hashref->{'biblioserver'}->{"RECORDS"},
+                      $params->{"tagsubfield"},
+                      $params->{"inputvalue"},
+                      $params->{"targetvalue"},
+                      $params->{"test"}
+                      );
+       $template->param(bulkeditresults=>1,
+                      tagsubfield=>$params->{"tagsubfield"},
+                      inputvalue=>$params->{"inputvalue"},
+                      targetvalue=>$params->{"targetvalue"},
+                      countchanged=>$countchanged,
+                      countunchanged=>scalar(@$listunchanged),
+                      listunchanged=>$listunchanged);
+
+       if (C4::Context->userenv->{'flags'}==1 ||(C4::Context->userenv->{'flags'} & ( 2**9 ) )){
+       #Edit Catalogue Permissions
+               $template->param(bulkedit => 1);
+               $template->param(tagsubfields=>GetManagedTagSubfields());
        }
-       my $CGIbranch=CGI::scrolling_list( -name     => 'value',
-                               -values   => \@select_branch,
-                               -labels   => \%select_branches,
-                               -size     => 1,
-                               -multiple => 0 );
-       $sth->finish;
-        my @options;
-    my $counter=0;
-        foreach my $language (getalllanguages()) {
-                            next if $language eq 'images';
-                            my $selected='0';
-#                            next if $currently_selected_languages->{$language};
-                            push @options, { language => $language, counter => $counter };
-                            $counter++;
-                    }
-    
-       $template->param(classlist => $classlist,
-                                       CGIitemtype => $CGIitemtype,
-                                       CGIbranch => $CGIbranch,
-                                       languages => \@options,
-       );
+}
+# At this point, each server has given us a result set
+# now we build that set for template display
+my @sup_results_array;
+for (my $i=0;$i<=@servers;$i++) {
+    my $server = $servers[$i];
+    if ($server =~/biblioserver/) { # this is the local bibliographic server
+        $hits = $results_hashref->{$server}->{"hits"};
+        my $page = $cgi->param('page') || 0;
+        my @newresults = searchResults( $query_desc,$hits,$results_per_page,$offset,@{$results_hashref->{$server}->{"RECORDS"}});
+        $total = $total + $results_hashref->{$server}->{"hits"};
+        if ($hits) {
+            $template->param(total => $hits);
+                       my $limit_cgi_not_availablity = $limit_cgi;
+                       $limit_cgi_not_availablity =~ s/&limit=available//g;
+                       $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
+                       $template->param(limit_cgi => $limit_cgi);
+                       $template->param(query_cgi => $query_cgi);
+                       $template->param(query_desc => $query_desc);
+                       $template->param(limit_desc => $limit_desc);
+                       if ($query_desc || $limit_desc) {
+               $template->param(searchdesc => 1);
+                       }
+                       $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
+            $template->param(results_per_page =>  $results_per_page);
+            $template->param(SEARCH_RESULTS => \@newresults);
+                       ## Build the page numbers on the bottom of the page
+                       my @page_numbers;
+                       # total number of pages there will be
+                       my $pages = ceil($hits / $results_per_page);
+                       # default page number
+                       my $current_page_number = 1;
+                       $current_page_number = ($offset / $results_per_page + 1) if $offset;
+                       my $previous_page_offset = $offset - $results_per_page unless ($offset - $results_per_page <0);
+                       my $next_page_offset = $offset + $results_per_page;
+                       # If we're within the first 10 pages, keep it simple
+                       #warn "current page:".$current_page_number;
+                       if ($current_page_number < 10) {
+                               # just show the first 10 pages
+                               # Loop through the pages
+                               my $pages_to_show = 10;
+                               $pages_to_show = $pages if $pages<10;
+                               for ($i=1; $i<=$pages_to_show;$i++) {
+                                       # the offset for this page
+                                       my $this_offset = (($i*$results_per_page)-$results_per_page);
+                                       # the page number for this page
+                                       my $this_page_number = $i;
+                                       # it should only be highlighted if it's the current page
+                                       my $highlight = 1 if ($this_page_number == $current_page_number);
+                                       # put it in the array
+                                       push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
+                                
+                               }
+                        
+                       }
+                       # now, show twenty pages, with the current one smack in the middle
+                       else {
+                               for ($i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
+                    my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
+                    my $this_page_number = $i-9;
+                    my $highlight = 1 if ($this_page_number == $current_page_number);
+                                       if ($this_page_number <= $pages) {
+                       push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
+                                       }
+                }
+                        
+                       }
+                       $template->param(       PAGE_NUMBERS => \@page_numbers,
+                                                               previous_page_offset => $previous_page_offset) unless $pages < 2;
+                       $template->param(next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
+         }
+         else {
+            # Here we must handle cases where no results are returned otherwise the template gives a malformed message. -fbcit
+            $template->param(query_desc => $query_desc);
+         }
+    } # end of the if local
+    else {
+        # check if it's a z3950 or opensearch source
+        my $zed3950 = 0;  # FIXME :: Hardcoded value.
+        if ($zed3950) {
+            my @inner_sup_results_array;
+            for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
+                my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
+                my $control_number = $marc_record_object->field('010')->subfield('a') if $marc_record_object->field('010');
+                $control_number =~ s/^ //g;
+                my $link = "http://catalog.loc.gov/cgi-bin/Pwebrecon.cgi?SAB1=".$control_number."&BOOL1=all+of+these&FLD1=LC+Control+Number+LCCN+%28K010%29+%28K010%29&GRP1=AND+with+next+set&SAB2=&BOOL2=all+of+these&FLD2=Keyword+Anywhere+%28GKEY%29+%28GKEY%29&PID=6211&SEQ=20060816121838&CNT=25&HIST=1";
+                my $title = $marc_record_object->title();
+                push @inner_sup_results_array, {
+                    'title' => $title,
+                    'link' => $link,
+                };
+            }
+            my $servername = $server;
+            push @sup_results_array, { servername => $servername, inner_sup_results_loop => \@inner_sup_results_array};
+            $template->param(outer_sup_results_loop => \@sup_results_array);
+        }
+    }
+
+} #/end of the for loop
+#$template->param(FEDERATED_RESULTS => \@results_array);
+
+
+$template->param(
+            #classlist => $classlist,
+            total => $total,
+            opacfacets => 1,
+            facets_loop => $facets,
+            scan => $scan,
+            search_error => $error,
+);
+
+if ($query_desc || $limit_desc) {
+       $template->param(searchdesc => 1);
+}
+
+## Now let's find out if we have any supplemental data to show the user
+#  and in the meantime, save the current query for statistical purposes, etc.
+my $koha_spsuggest; # a flag to tell if we've got suggestions coming from Koha
+my @koha_spsuggest; # place we store the suggestions to be returned to the template as LOOP
+my $phrases = $query_desc;
+my $ipaddress;
+
+if ( C4::Context->preference("kohaspsuggest") ) {
+               my ($suggest_host, $suggest_dbname, $suggest_user, $suggest_pwd) = split(':', C4::Context->preference("kohaspsuggest"));
+        eval {
+            my $koha_spsuggest_dbh;
+            # FIXME: this needs to be moved to Context.pm
+            eval {
+                $koha_spsuggest_dbh=DBI->connect("DBI:mysql:$suggest_dbname:$suggest_host","$suggest_user","$suggest_pwd");
+            };
+            if ($@) { 
+                warn "can't connect to spsuggest db";
+            }
+            else {
+                my $koha_spsuggest_insert = "INSERT INTO phrase_log(phr_phrase,phr_resultcount,phr_ip) VALUES(?,?,?)";
+                my $koha_spsuggest_query = "SELECT display FROM distincts WHERE strcmp(soundex(suggestion), soundex(?)) = 0 order by soundex(suggestion) limit 0,5";
+                my $koha_spsuggest_sth = $koha_spsuggest_dbh->prepare($koha_spsuggest_query);
+                $koha_spsuggest_sth->execute($phrases);
+                while (my $spsuggestion = $koha_spsuggest_sth->fetchrow_array) {
+                    $spsuggestion =~ s/(:|\/)//g;
+                    my %line;
+                    $line{spsuggestion} = $spsuggestion;
+                    push @koha_spsuggest,\%line;
+                    $koha_spsuggest = 1;
+                }
+
+                # Now save the current query
+                $koha_spsuggest_sth=$koha_spsuggest_dbh->prepare($koha_spsuggest_insert);
+                #$koha_spsuggest_sth->execute($phrases,$results_per_page,$ipaddress);
+                $koha_spsuggest_sth->finish;
+
+                $template->param( koha_spsuggest => $koha_spsuggest ) unless $hits;
+                $template->param( SPELL_SUGGEST => \@koha_spsuggest,
+                );
+            }
+    };
+    if ($@) {
+            warn "Kohaspsuggest failure:".$@;
+    }
 }
 
-output_html_with_http_headers $query, $cookie, $template->output;
+# VI. BUILD THE TEMPLATE
+output_html_with_http_headers $cgi, $cookie, $template->output;