refactoring how limits are built, first working version

Signed-off-by: Chris Cormack <crc@liblime.com>
Signed-off-by: Joshua Ferraro <jmf@liblime.com>

diff --git a/C4/Search.pm b/C4/Search.pm
index 4177490..a53cadf 100644 (file)
--- a/C4/Search.pm
+++ b/C4/Search.pm
@@ -27,7 +27,7 @@ use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
 
 # set the version for version checking
 $VERSION = 3.00;
-$DEBUG=0;
+$DEBUG=1;
 
 =head1 NAME
 
@@ -675,34 +675,35 @@ sub buildQuery {
     my @sort_by   = @$sort_by   if $sort_by;
 
     my $stemming      = C4::Context->preference("QueryStemming")     || 0;
-
-    # only turn on field weighting in simple searches
-    my $weight_fields;
-   # if (@operands==1) {
-        $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
-    #}
+    my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
     my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
 
-    my $human_search_desc;      # a human-readable query
-    my $machine_search_desc;    #a machine-readable query
-
     my $query = $operands[0];
+       my $query_cgi;
+       my $query_search_desc;
+
+       my $limit;
+       my $limit_cgi;
+       my $limit_desc;
+
 # STEP I: determine if this is a form-based / simple query or if it's complex (if complex,
 # pass it off to zebra directly)
 
 # check if this is a known query language query, if it is, return immediately,
 # the user is responsible for constructing valid syntax:
     if ( $query =~ /^ccl=/ ) {
-        return ( undef, $', $', $', 'ccl' );
+        return ( undef, $', $', $', '', '', '', 'ccl' );
     }
     if ( $query =~ /^cql=/ ) {
-        return ( undef, $', $', $', 'cql' );
+        return ( undef, $', $', $', '', '', '', 'cql' );
     }
     if ( $query =~ /^pqf=/ ) {
-        return ( undef, $', $', $', 'pqf' );
+        return ( undef, $', $', $', '', '', '', 'pqf' );
     }
+
+# FIXME: this is bound to be broken now
     if ( $query =~ /(\(|\)|:|=)/ ) {    # sorry, too complex, assume CCL
-        return ( undef, $query, $query, $query, 'ccl' );
+        return ( undef, $query, $query_cgi, $query_search_desc, $limit, $limit_cgi, $limit_desc, 'ccl' );
     }
 
 # form-based queries are limited to non-nested at a specific depth, so we can easily
@@ -782,10 +783,11 @@ sub buildQuery {
 
                     # user-specified operator
                     if ( $operators[$i-1] ) {
-                        $human_search_desc .=" $operators[$i-1] $index_plus $operands[$i]";
                         $query .= " $operators[$i-1] ";
                         $query .= " $index_plus " unless $indexes_set;
                         $query .= " $operand";
+                                               $query_cgi .="";
+                                               $query_search_desc .=" $operators[$i-1] $index_plus $operands[$i]";
                     }
 
                     # the default operator is and
@@ -793,129 +795,67 @@ sub buildQuery {
                         $query .= " and ";
                         $query .= "$index_plus " unless $indexes_set;
                         $query .= "$operand";
-                        $human_search_desc .= " and $index_plus $operands[$i]";
+                                               $query_cgi .="";
+                        $query_search_desc .= " and $index_plus $operands[$i]";
                     }
                 }
 
-                # There's no previous operand - FIXME: completely ignoring our $query, no field weighting, no stemming
-                # FIXME: also, doesn't preserve original order
                 else { 
-                    # if there are terms to fit with truncation
-#                    if (scalar(@$righttruncated)+scalar(@$lefttruncated)+scalar(@$rightlefttruncated)>0){
- #                       # add the non-truncated ones first
-  #                      $query.= "$index_plus @$nontruncated " if (scalar(@$nontruncated)>0);
-   #                     if (scalar(@$righttruncated)>0){
-    #                        $query .= "and $index_plus_comma"."rtrn:@$righttruncated ";
-     #                   }            
-      #                  if (scalar(@$lefttruncated)>0){
-       #                     $query .= "and $index_plus_comma"."ltrn:@$lefttruncated ";
-        #                }            
-         #               if (scalar(@$rightlefttruncated)>0){
-          #                  $query .= "and $index_plus_comma"."rltrn:@$rightlefttruncated ";
-           #             }
-            #            $human_search_desc .= $query;
-             #       } else {
-                        # field-weighted queries already have indexes set
-                        $query.=" $index_plus " unless $indexes_set;
-                        $query             .= $operand;
-                        $human_search_desc .= " $index_plus $operands[$i]";
-              #      }            
+                                       # field-weighted queries already have indexes set
+                                       $query .=" $index_plus " unless $indexes_set;
+                                       $query .= $operand;
+                                       $query_search_desc .= " $index_plus $operands[$i]";
+                                       $query_cgi.="";
+
                     $previous_operand = 1;
                 }
             }    #/if $operands
         }    # /for
     }
     warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
+
     # add limits
-    my $limit_query;
-    my $limit_search_desc;
-    foreach my $limit (@limits) {
-
-        # FIXME: not quite right yet ... will work on this soon -- JF
-        my $type = $1 if $limit =~ m/([^:]+):([^:]*)/;
-        if ( $limit =~ /available/ ) {
-            $limit_query .= " (($query and datedue=0000-00-00) or ($query and datedue=0000-00-00 not lost=1) or ($query and datedue=0000-00-00 not lost=2))";
-            #$limit_search_desc.=" and available";
-        }
-        elsif ( ($limit_query) && ( index( $limit_query, $type, 0 ) > 0 ) ) {
-            if ( $limit_query !~ /\(/ ) {
-                $limit_query =
-                    substr( $limit_query, 0, index( $limit_query, $type, 0 ) )
-                  . "("
-                  . substr( $limit_query, index( $limit_query, $type, 0 ) )
-                  . " or $limit )"
-                  if $limit;
-                $limit_search_desc =
-                  substr( $limit_search_desc, 0,
-                    index( $limit_search_desc, $type, 0 ) )
-                  . "("
-                  . substr( $limit_search_desc,
-                    index( $limit_search_desc, $type, 0 ) )
-                  . " or $limit )"
-                  if $limit;
-            }
-            else {
-                chop $limit_query;
-                chop $limit_search_desc;
-                $limit_query       .= " or $limit )" if $limit;
-                $limit_search_desc .= " or $limit )" if $limit;
-            }
+    foreach my $this_limit (@limits) {
+        if ( $this_limit =~ /available/ ) {
+                       # FIXME: switch to zebra search for null values
+            $limit .= " (($query and datedue=0000-00-00) or ($query and datedue=0000-00-00 not lost=1) or ($query and datedue=0000-00-00 not lost=2))";
+                       $limit_cgi .= "&limit=available";
+                       $limit_desc .="";
         }
-        elsif ( ($limit_query) && ( $limit =~ /mc/ ) ) {
-            $limit_query       .= " or $limit" if $limit;
-            $limit_search_desc .= " or $limit" if $limit;
+               # these are treated as OR
+        elsif ( $this_limit =~ /mc/ ) {
+            $limit .= " or $this_limit";
+                       $limit_cgi .="&limit=$this_limit";
+            $limit_desc .= " or $this_limit";
         }
+               else {
+                       $limit .= " and $this_limit";
+                       $limit_cgi .="&limit=$this_limit";
+                       $limit_desc .=" and $this_limit";
+               }
+    }
 
-        # these are treated as AND
-        elsif ($limit_query) {
-           if ($limit =~ /branch/){
-                $limit_query       .= " ) and ( $limit" if $limit;
-            $limit_search_desc .= " ) and ( $limit" if $limit;
-        }else{
-            $limit_query       .= " or $limit" if $limit;
-                    $limit_search_desc .= " or $limit" if $limit;
-        }
-        }
+       # normalize the strings
+       for ($query, $query_search_desc, $limit, $limit_desc) {
+               $_ =~ s/  / /g;    # remove extra spaces
+       $_ =~ s/^ //g;     # remove any beginning spaces
+               $_ =~ s/ $//g;     # remove any beginning spaces
+       $_ =~ s/:/=/g;     # causes probs for server
+       $_ =~ s/==/=/g;    # remove double == from query
 
-        # otherwise, there is nothing but the limit
-        else {
-            $limit_query       .= "$limit" if $limit;
-            $limit_search_desc .= "$limit" if $limit;
-        }
-    }
+       }
 
-    # if there's also a query, we need to AND the limits to it
-    if ( ($limit_query) && ($query) ) {
-        $limit_query       = " and (" . $limit_query . ")";
-        $limit_search_desc = " and ($limit_search_desc)" if $limit_search_desc;
+       # append the limit to the query
+       $query .= $limit;
 
-    }
-    #warn "LIMIT: $limit_query";
-    $query             .= $limit_query;
-    $human_search_desc .= $limit_search_desc;
-
-    # now normalize the strings
-    $query =~ s/  / /g;    # remove extra spaces
-    $query =~ s/^ //g;     # remove any beginning spaces
-    $query =~ s/:/=/g;     # causes probs for server
-    $query =~ s/==/=/g;    # remove double == from query
-
-    my $federated_query = $human_search_desc;
-    $federated_query =~ s/  / /g;
-    $federated_query =~ s/^ //g;
-    $federated_query =~ s/:/=/g;
-    my $federated_query_opensearch = $federated_query;
-
-#     my $federated_query_RPN = new ZOOM::Query::CCL2RPN( $query , C4::Context->ZConn('biblioserver'));
-
-    $human_search_desc =~ s/  / /g;
-    $human_search_desc =~ s/^ //g;
-    my $koha_query = $query;
-
-    warn "QUERY:".$koha_query if $DEBUG;
-    warn "SEARCHDESC:".$human_search_desc if $DEBUG;
-    warn "FEDERATED QUERY:".$federated_query if $DEBUG;
-    return ( undef, $human_search_desc, $koha_query, $federated_query );
+    warn "QUERY:".$query if $DEBUG;
+       warn "QUERY CGI:".$query_cgi if $DEBUG;
+    warn "QUERY DESC:".$query_search_desc if $DEBUG;
+    warn "LIMIT:".$limit if $DEBUG;
+    warn "LIMIT CGI:".$limit_cgi if $DEBUG;
+    warn "LIMIT DESC:".$limit_desc if $DEBUG;
+
+       return ( undef, $query,$query_cgi,$query_search_desc,$limit,$limit_cgi,$limit_desc );
 }
 
 # IMO this subroutine is pretty messy still -- it's responsible for

diff --git a/catalogue/search.pl b/catalogue/search.pl
index a1ea0bc..87aab37 100755 (executable)
--- a/catalogue/search.pl
+++ b/catalogue/search.pl
@@ -392,14 +392,12 @@ my $hits;
 my $expanded_facet = $params->{'expand'};
 
 # Define some global variables
-my $error; # used for error handling
-my $search_desc; # the query expressed in terms that humans understand
-my $koha_query; # the query expressed in terms that zoom understands with field weighting and stemming
-my $federated_query;
-my $query_type; # usually not needed, but can be used to trigger ccl, cql, or pqf queries if set
+my ( $error,$query,$query_cgi,$query_search_desc,$limit,$limit_cgi,$limit_desc,$query_type);
+
 my @results;
+
 ## I. BUILD THE QUERY
-($error,$search_desc,$koha_query,$federated_query,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by);
+( $error,$query,$query_cgi,$query_search_desc,$limit,$limit_cgi,$limit_desc,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by);
 
 ## II. DO THE SEARCH AND GET THE RESULTS
 my $total; # the total results for the whole set
@@ -409,11 +407,11 @@ my $results_hashref;
 
 if (C4::Context->preference('NoZebra')) {
     eval {
-        ($error, $results_hashref, $facets) = NZgetRecords($koha_query,$federated_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
+        ($error, $results_hashref, $facets) = NZgetRecords($query,$query_cgi,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
     };
 } else {
     eval {
-        ($error, $results_hashref, $facets) = getRecords($koha_query,$federated_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
+        ($error, $results_hashref, $facets) = getRecords($query,$query_cgi,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
     };
 }
 if ($@ || $error) {
@@ -455,11 +453,12 @@ for (my $i=0;$i<=@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( $search_desc,$hits,$results_per_page,$offset,@{$results_hashref->{$server}->{"RECORDS"}});
+        my @newresults = searchResults( $query_search_desc,$hits,$results_per_page,$offset,@{$results_hashref->{$server}->{"RECORDS"}});
         $total = $total + $results_hashref->{$server}->{"hits"};
         if ($hits) {
             $template->param(total => $hits);
-            $template->param(searchdesc => ($query_type?"$query_type=":"")."$search_desc" );
+                       $template->param(limit_cgi => $limit_cgi);
+            $template->param(searchdesc => ($query_type?"$query_type=":"")."$query_search_desc" );
             $template->param(results_per_page =>  $results_per_page);
             $template->param(SEARCH_RESULTS => \@newresults);
 
@@ -478,7 +477,7 @@ for (my $i=0;$i<=@servers;$i++) {
 #             $template->param(PAGE_NUMBERS => \@page_numbers,
 #                             previous_page_offset => $previous_page_offset,
 #                             next_page_offset => $next_page_offset) unless $pages < 2;
-      my $link="/cgi-bin/koha/catalogue/search.pl?q=$search_desc&";
+      my $link="/cgi-bin/koha/catalogue/search.pl?q=$query_search_desc&";
       foreach my $sort (@sort_by){      
         $link.="&sort_by=".$sort."&";
       }        
@@ -521,7 +520,7 @@ for (my $i=0;$i<=@servers;$i++) {
 $template->param(
             #classlist => $classlist,
             total => $total,
-            searchdesc => ($query_type?"$query_type=":"")."$search_desc",
+            searchdesc => ($query_type?"$query_type=":"")."$query_search_desc",
             opacfacets => 1,
             facets_loop => $facets,
             scan_use => $scan,
@@ -531,7 +530,7 @@ $template->param(
 #  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 = $search_desc;
+my $phrases = $query_search_desc;
 my $ipaddress;
 
 if ( C4::Context->preference("kohaspsuggest") ) {

diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/facets.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/facets.inc
index ee90c4c..01a2f02 100644 (file)
--- a/koha-tmpl/intranet-tmpl/prog/en/includes/facets.inc
+++ b/koha-tmpl/intranet-tmpl/prog/en/includes/facets.inc
@@ -4,7 +4,7 @@
 <li><h4>Refine your search</h4></li>
 <!-- TMPL_LOOP NAME="facets_loop" -->
 <li id="<!-- TMPL_VAR NAME="type_id" -->"><!-- TMPL_VAR NAME="type_label" --><ul>
-        <!-- TMPL_LOOP NAME="facets" --><li><a href="/cgi-bin/koha/catalogue/search.pl?q=<!-- TMPL_VAR NAME="searchdesc" -->&amp;limit=<!-- TMPL_VAR NAME="type_link_value" -->:<!-- TMPL_VAR NAME="facet_link_value" -->" title="<!-- TMPL_VAR NAME="facet_title_value" -->"><!-- TMPL_VAR NAME="facet_label_value" --></a> <!-- (<!-- TMPL_VAR NAME="facet_count" -->)--></li><!-- /TMPL_LOOP --><!-- TMPL_IF NAME="expandable" -->
+        <!-- TMPL_LOOP NAME="facets" --><li><a href="/cgi-bin/koha/catalogue/search.pl?q=<!-- TMPL_VAR NAME="searchdesc" --><!-- TMPL_VAR NAME="limit_cgi" -->&amp;limit=<!-- TMPL_VAR NAME="type_link_value" -->:<!-- TMPL_VAR NAME="facet_link_value" -->" title="<!-- TMPL_VAR NAME="facet_title_value" -->"><!-- TMPL_VAR NAME="facet_label_value" --></a> <!-- (<!-- TMPL_VAR NAME="facet_count" -->)--></li><!-- /TMPL_LOOP --><!-- TMPL_IF NAME="expandable" -->
         <li class="showmore"><a href="/cgi-bin/koha/catalogue/search.pl?q=<!-- TMPL_VAR NAME="searchdesc" -->&amp;expand=<!-- TMPL_VAR NAME="expand" -->#<!-- TMPL_VAR NAME="type_id" -->">Show More</a></li>
 <!-- /TMPL_IF -->
 </ul></li>