riddle 0.9.8.1533.10 → 1.0.0

data/README.textile

@@ -87,3 +87,4 @@ Thanks to the following people who have contributed to Riddle in some shape or f
 * Kristopher Chambers
 * Rob Anderton
 * Dylan Egan
+* Jerry Vos

data/lib/riddle.rb

@@ -7,24 +7,18 @@ require 'riddle/controller'
 
 module Riddle #:nodoc:
   class ConnectionError < StandardError #:nodoc:
+    #
   end
   
-  module Version #:nodoc:
-    Major   = 0
-    Minor   = 9
-    Tiny    = 8
-    # Revision number for RubyForge's sake, taken from what Sphinx
-    # outputs to the command line.
-    Rev     = 1533
-    # Release number to mark my own fixes, beyond feature parity with
-    # Sphinx itself.
-    Release = 10
-    
-    String      = [Major, Minor, Tiny].join('.')
-    GemVersion  = [Major, Minor, Tiny, Rev, Release].join('.')
+  def self.escape_pattern
+    Thread.current[:riddle_escape_pattern] ||= /[\(\)\|\-!@~"&\/]/
+  end
+  
+  def self.escape_pattern=(pattern)
+    Thread.current[:riddle_escape_pattern] = pattern
   end
   
   def self.escape(string)
-    string.gsub(/[\(\)\|\-!@~"&\/]/) { |char| "\\#{char}" }
+    string.gsub(escape_pattern) { |char| "\\#{char}" }
   end
-end
+end

data/lib/riddle/0.9.9.rb

@@ -0,0 +1,5 @@
+require 'riddle/0.9.9/client'
+require 'riddle/0.9.9/client/filter'
+require 'riddle/0.9.9/configuration/searchd'
+
+Riddle.escape_pattern = /[\(\)\|\-!@~"&\/\\\^\$=]/

data/lib/riddle/0.9.9/client.rb

@@ -0,0 +1,49 @@
+Riddle::Client::Versions[:search] = 0x116
+Riddle::Client::Versions[:update] = 0x102
+
+class Riddle::Client
+  private
+  
+  def initialise_connection
+    socket = initialise_socket
+
+    # Send version
+    socket.send [1].pack('N'), 0
+    
+    # Checking version
+    version = socket.recv(4).unpack('N*').first
+    if version < 1
+      socket.close
+      raise VersionError, "Can only connect to searchd version 1.0 or better, not version #{version}"
+    end
+    
+    socket
+  end
+  
+  def update_message(index, attributes, values_by_doc)
+    message = Message.new
+    
+    message.append_string index
+    message.append_int attributes.length
+    attributes.each_with_index do |attribute, index|
+      message.append_string attribute
+      message.append_boolean values_by_doc.values.first[index].is_a?(Array)
+    end
+    
+    message.append_int values_by_doc.length
+    values_by_doc.each do |key,values|
+      message.append_64bit_int key # document ID
+      values.each do |value|
+        case value
+        when Array
+          message.append_int value.length
+          message.append_ints *value
+        else
+          message.append_int value
+        end
+      end
+    end
+    
+    message.to_s
+  end
+end

data/lib/riddle/0.9.9/client/filter.rb

@@ -0,0 +1,22 @@
+class Riddle::Client::Filter
+  #
+  
+  private
+  
+  def append_integer_range(message, range)
+    message.append_64bit_ints self.values.first, self.values.last
+  end
+  
+  def append_array(message, array)
+    message.append_64bit_ints *array.collect { |val|
+      case val
+      when TrueClass
+        1
+      when FalseClass
+        0
+      else
+        val
+      end
+    }
+  end
+end

data/lib/riddle/0.9.9/configuration/searchd.rb

@@ -0,0 +1,28 @@
+module Riddle
+  class Configuration
+    class Searchd
+      def valid?
+        set_listen
+        clear_deprecated
+        
+        !( @listen.nil? || @pid_file.nil? )
+      end
+      
+      private
+      
+      def set_listen
+        return unless @listen.nil?
+        
+        @listen = @port.to_s if @port && @address.nil?
+        @listen = "#{@address}:#{@port}" if @address && @port
+      end
+      
+      def clear_deprecated
+        return if @listen.nil?
+        
+        @address  = nil
+        @port     = nil
+      end
+    end
+  end
+end

data/lib/riddle/client.rb

@@ -33,14 +33,19 @@ module Riddle
       :search   => 0, # SEARCHD_COMMAND_SEARCH
       :excerpt  => 1, # SEARCHD_COMMAND_EXCERPT
       :update   => 2, # SEARCHD_COMMAND_UPDATE
-      :keywords => 3  # SEARCHD_COMMAND_KEYWORDS
+      :keywords => 3, # SEARCHD_COMMAND_KEYWORDS
+      :persist  => 4, # SEARCHD_COMMAND_PERSIST
+      :status   => 5, # SEARCHD_COMMAND_STATUS
+      :query    => 6  # SEARCHD_COMMAND_QUERY
     }
     
     Versions = {
       :search   => 0x113, # VER_COMMAND_SEARCH
       :excerpt  => 0x100, # VER_COMMAND_EXCERPT
       :update   => 0x101, # VER_COMMAND_UPDATE
-      :keywords => 0x100  # VER_COMMAND_KEYWORDS
+      :keywords => 0x100, # VER_COMMAND_KEYWORDS
+      :status   => 0x100, # VER_COMMAND_STATUS
+      :query    => 0x100  # VER_COMMAND_QUERY
     }
     
     Statuses = {
@@ -64,7 +69,10 @@ module Riddle
       :proximity_bm25 => 0, # SPH_RANK_PROXIMITY_BM25
       :bm25           => 1, # SPH_RANK_BM25
       :none           => 2, # SPH_RANK_NONE
-      :wordcount      => 3  # SPH_RANK_WORDCOUNT
+      :wordcount      => 3, # SPH_RANK_WORDCOUNT
+      :proximity      => 4, # SPH_RANK_PROXIMITY
+      :match_any      => 5, # SPH_RANK_MATCHANY
+      :fieldmask      => 6  # SPH_RANK_FIELDMASK
     }
     
     SortModes = {
@@ -82,6 +90,7 @@ module Riddle
       :ordinal    => 3, # SPH_ATTR_ORDINAL
       :bool       => 4, # SPH_ATTR_BOOL
       :float      => 5, # SPH_ATTR_FLOAT
+      :bigint     => 6, # SPH_ATTR_BIGINT
       :multi      => 0x40000000 # SPH_ATTR_MULTI
     }
     
@@ -104,7 +113,7 @@ module Riddle
       :match_mode, :sort_mode, :sort_by, :weights, :id_range, :filters,
       :group_by, :group_function, :group_clause, :group_distinct, :cut_off,
       :retry_count, :retry_delay, :anchor, :index_weights, :rank_mode,
-      :max_query_time, :field_weights, :timeout
+      :max_query_time, :field_weights, :timeout, :overrides, :select
     attr_reader :queue
     
     # Can instantiate with a specific server and port - otherwise it assumes
@@ -113,6 +122,7 @@ module Riddle
     def initialize(server=nil, port=nil)
       @server = server || "localhost"
       @port   = port   || 3312
+      @socket = nil
       
       reset
       
@@ -146,6 +156,8 @@ module Riddle
       # string keys are field names, integer values are weightings
       @field_weights  = {}
       @timeout        = 0
+      @overrides      = {}
+      @select         = "*"
     end
     
     # Set the geo-anchor point - with the names of the attributes that contain
@@ -389,27 +401,77 @@ module Riddle
       end
     end
     
+    def status
+      response = Response.new request(
+        :status, Message.new
+      )
+      
+      rows, cols = response.next_int, response.next_int
+      
+      (0...rows).inject({}) do |hash, row|
+        hash[response.next.to_sym] = response.next
+        hash
+      end
+    end
+    
+    def add_override(attribute, type, values)
+      @overrides[attribute] = {:type => type, :values => values}
+    end
+    
+    def open
+      open_socket
+      
+      return if Versions[:search] < 0x116
+      
+      @socket.send [
+        Commands[:persist], 0, 4, 1
+      ].pack("nnNN"), 0
+    end
+    
+    def close
+      close_socket
+    end
+    
     private
     
-    # Connects to the Sphinx daemon, and yields a socket to use. The socket is
-    # closed at the end of the block.
-    def connect(&block)
-      socket = nil
+    def open_socket
+      raise "Already Connected" unless @socket.nil?
+      
       if @timeout == 0
-        socket = initialise_connection
+        @socket = initialise_connection
       else
         begin
-          Timeout.timeout(@timeout) { socket = initialise_connection }
+          Timeout.timeout(@timeout) { @socket = initialise_connection }
         rescue Timeout::Error
           raise Riddle::ConnectionError,
             "Connection to #{@server} on #{@port} timed out after #{@timeout} seconds"
         end
       end
-
-      begin
-        yield socket
-      ensure
-        socket.close
+      
+      true
+    end
+    
+    def close_socket
+      raise "Not Connected" if @socket.nil?
+      
+      @socket.close
+      @socket = nil
+      
+      true
+    end
+    
+    # Connects to the Sphinx daemon, and yields a socket to use. The socket is
+    # closed at the end of the block.
+    def connect(&block)
+      unless @socket.nil?
+        yield @socket
+      else
+        open_socket
+        begin
+          yield @socket
+        ensure
+          close_socket
+        end
       end
     end
     
@@ -453,7 +515,7 @@ module Riddle
       if message.respond_to?(:force_encoding)
         message = message.force_encoding('ASCII-8BIT')
       end
-          
+      
       connect do |socket|
         case command
         when :search
@@ -463,6 +525,10 @@ module Riddle
             Commands[command], Versions[command],
             4+message.length,  messages.length
           ].pack("nnNN") + message, 0
+        when :status
+          socket.send [
+            Commands[command], Versions[command], 4, 1
+          ].pack("nnNN"), 0
         else
           socket.send [
             Commands[command], Versions[command], message.length
@@ -565,6 +631,30 @@ module Riddle
       
       message.append_string comments
       
+      return message.to_s if Versions[:search] < 0x116
+      
+      # Overrides  
+      message.append_int @overrides.length
+      @overrides.each do |key,val|
+        message.append_string key.to_s
+        message.append_int AttributeTypes[val[:type]]
+        message.append_int val[:values].length
+        val[:values].each do |id,map|
+          message.append_64bit_int id
+          method = case val[:type]
+          when :float
+            :append_float
+          when :bigint
+            :append_64bit_int
+          else
+            :append_int
+          end
+          message.send method, map
+        end
+      end
+      
+      message.append_string @select
+      
       message.to_s
     end
     
@@ -626,9 +716,11 @@ module Riddle
       
       case type
       when AttributeTypes[:float]
-        is_multi ? response.next_float_array : response.next_float
+        is_multi ? response.next_float_array    : response.next_float
+      when AttributeTypes[:bigint]
+        is_multi ? response.next_64bit_int_arry : response.next_64bit_int
       else
-        is_multi ? response.next_int_array   : response.next_int
+        is_multi ? response.next_int_array      : response.next_int
       end
     end
   end

data/lib/riddle/client/filter.rb

@@ -1,23 +1,22 @@
 module Riddle
   class Client
-    # Used for querying Sphinx.
     class Filter
       attr_accessor :attribute, :values, :exclude
-      
+  
       # Attribute name, values (which can be an array or a range), and whether
       # the filter should be exclusive.
       def initialize(attribute, values, exclude=false)
         @attribute, @values, @exclude = attribute, values, exclude
       end
-      
+  
       def exclude?
         self.exclude
       end
-      
+  
       # Returns the message for this filter to send to the Sphinx service
       def query_message
         message = Message.new
-        
+    
         message.append_string self.attribute.to_s
         case self.values
         when Range
@@ -26,28 +25,38 @@ module Riddle
             message.append_floats self.values.first, self.values.last
           else
             message.append_int FilterTypes[:range]
-            message.append_ints self.values.first, self.values.last
+            append_integer_range message, self.values
           end
         when Array
           message.append_int FilterTypes[:values]
           message.append_int self.values.length
-          # using to_f is a hack from the php client - to workaround 32bit
-          # signed ints on x32 platforms
-          message.append_ints *self.values.collect { |val|
-            case val
-            when TrueClass
-              1.0
-            when FalseClass
-              0.0
-            else
-              val.to_f
-            end
-          }
+          append_array message, self.values
         end
         message.append_int self.exclude? ? 1 : 0
-        
+    
         message.to_s
       end
+  
+      private
+  
+      def append_integer_range(message, range)
+        message.append_ints self.values.first, self.values.last
+      end
+  
+      # Using to_f is a hack from the PHP client - to workaround 32bit signed
+      # ints on x32 platforms
+      def append_array(message, array)
+        message.append_ints *array.collect { |val|
+          case val
+          when TrueClass
+            1.0
+          when FalseClass
+            0.0
+          else
+            val.to_f
+          end
+        }
+      end
     end
   end
-end
+end