thrift 0.22.0 → 0.24.0

data/lib/thrift/multiplexed_processor.rb

@@ -1,4 +1,5 @@
-# 
+# frozen_string_literal: true
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
 # distributed with this work for additional information
@@ -6,9 +7,9 @@
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License. You may obtain a copy of the License at
-# 
+#
 #   http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -23,17 +24,26 @@ module Thrift
   class MultiplexedProcessor
     def initialize
       @actual_processors = {}
+      @default_processor = nil
     end
- 
+
     def register_processor(service_name, processor)
       @actual_processors[service_name] = processor
     end
- 
+
+    def register_default(processor)
+      @default_processor = processor
+    end
+
     def process(iprot, oprot)
       name, type, seqid = iprot.read_message_begin
       check_type(type)
-      check_separator(name)
-      service_name, method = name.split(':')
+      if name.count(':') < 1
+        check_default_processor(name)
+        return @default_processor.process(StoredMessageProtocol.new(iprot, [name, type, seqid]), oprot)
+      end
+
+      service_name, method = name.split(':', 2)
       processor(service_name).process(StoredMessageProtocol.new(iprot, [method, type, seqid]), oprot)
     end
 
@@ -53,8 +63,8 @@ module Thrift
       end
     end
 
-    def check_separator(name)
-      if name.count(':') < 1
+    def check_default_processor(name)
+      unless @default_processor
         raise Thrift::Exception.new("Service name not found in message name: #{name}. Did you forget to use a Thrift::Protocol::MultiplexedProtocol in your client?")
       end
     end
@@ -63,7 +73,7 @@ module Thrift
   class StoredMessageProtocol < BaseProtocol
 
     include ProtocolDecorator
-    
+
     def initialize(protocol, message_begin)
       super(protocol)
       @message_begin = message_begin

data/lib/thrift/processor.rb

@@ -1,4 +1,5 @@
-# 
+# frozen_string_literal: true
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
 # distributed with this work for additional information
@@ -6,22 +7,22 @@
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License. You may obtain a copy of the License at
-# 
+#
 #   http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-# 
+#
 
 require 'logger'
 
 module Thrift
   module Processor
-    def initialize(handler, logger=nil)
+    def initialize(handler, logger = nil)
       @handler = handler
       if logger.nil?
         @logger = Logger.new(STDERR)
@@ -32,7 +33,7 @@ module Thrift
     end
 
     def process(iprot, oprot)
-      name, type, seqid  = iprot.read_message_begin
+      name, type, seqid = iprot.read_message_begin
       if respond_to?("process_#{name}")
         begin
           send("process_#{name}", seqid, iprot, oprot)

data/lib/thrift/protocol/base_protocol.rb

@@ -1,4 +1,5 @@
-# 
+# frozen_string_literal: true
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
 # distributed with this work for additional information
@@ -6,16 +7,16 @@
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License. You may obtain a copy of the License at
-# 
+#
 #   http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-# 
+#
 
 # this require is to make generated struct definitions happy
 require 'set'
@@ -33,7 +34,7 @@ module Thrift
 
     attr_reader :type
 
-    def initialize(type=UNKNOWN, message=nil)
+    def initialize(type = UNKNOWN, message = nil)
       super(message)
       @type = type
     end
@@ -116,7 +117,7 @@ module Thrift
       raise NotImplementedError
     end
 
-    # Writes a Thrift String. In Ruby 1.9+, the String passed will be transcoded to UTF-8.
+    # Writes a Thrift String. The String passed will be transcoded to UTF-8.
     #
     # str - The String to write.
     #
@@ -127,7 +128,7 @@ module Thrift
       raise NotImplementedError
     end
 
-    # Writes a Thrift Binary (Thrift String with no encoding). In Ruby 1.9+, the String passed
+    # Writes a Thrift Binary (Thrift String with no encoding). The String passed
     # will forced into BINARY encoding.
     #
     # buf - The String to write.
@@ -137,6 +138,15 @@ module Thrift
       raise NotImplementedError
     end
 
+    # Writes a UUID as 16 bytes.
+    #
+    # uuid - The UUID string to write (e.g. "550e8400-e29b-41d4-a716-446655440000").
+    #
+    # Returns nothing.
+    def write_uuid(uuid)
+      raise NotImplementedError
+    end
+
     def read_message_begin
       raise NotImplementedError
     end
@@ -197,14 +207,14 @@ module Thrift
       raise NotImplementedError
     end
 
-    # Reads a Thrift String. In Ruby 1.9+, all Strings will be returned with an Encoding of UTF-8.
+    # Reads a Thrift String. All Strings will be returned with an Encoding of UTF-8.
     #
     # Returns a String.
     def read_string
       raise NotImplementedError
     end
 
-    # Reads a Thrift Binary (Thrift String without encoding). In Ruby 1.9+, all Strings will be returned
+    # Reads a Thrift Binary (Thrift String without encoding). All Strings will be returned
     # with an Encoding of BINARY.
     #
     # Returns a String.
@@ -212,6 +222,13 @@ module Thrift
       raise NotImplementedError
     end
 
+    # Reads a UUID as 16 bytes and returns it as a string.
+    #
+    # Returns a String (e.g. "550e8400-e29b-41d4-a716-446655440000").
+    def read_uuid
+      raise NotImplementedError
+    end
+
     # Writes a field based on the field information, field ID and value.
     #
     # field_info - A Hash containing the definition of the field:
@@ -251,9 +268,9 @@ module Thrift
     #
     # Returns nothing.
     def write_type(field_info, value)
-      # if field_info is a Fixnum, assume it is a Thrift::Types constant
+      # if field_info is a Integer, assume it is a Thrift::Types constant
       # convert it into a field_info Hash for backwards compatibility
-      if field_info.is_a? Fixnum
+      if field_info.is_a? Integer
         field_info = {:type => field_info}
       end
 
@@ -276,6 +293,8 @@ module Thrift
         else
           write_string(value)
         end
+      when Types::UUID
+        write_uuid(value)
       when Types::STRUCT
         value.write(self)
       else
@@ -291,9 +310,9 @@ module Thrift
     #
     # Returns the value read; object type varies based on field_info[:type].
     def read_type(field_info)
-      # if field_info is a Fixnum, assume it is a Thrift::Types constant
+      # if field_info is a Integer, assume it is a Thrift::Types constant
       # convert it into a field_info Hash for backwards compatibility
-      if field_info.is_a? Fixnum
+      if field_info.is_a? Integer
         field_info = {:type => field_info}
       end
 
@@ -316,12 +335,15 @@ module Thrift
         else
           read_string
         end
+      when Types::UUID
+        read_uuid
       else
         raise NotImplementedError
       end
     end
 
-    def skip(type)
+    def skip(type, max_depth = 64)
+      raise ProtocolException.new(ProtocolException::DEPTH_LIMIT, 'Maximum skip depth exceeded') if max_depth <= 0
       case type
       when Types::BOOL
         read_bool
@@ -337,39 +359,48 @@ module Thrift
         read_double
       when Types::STRING
         read_string
+      when Types::UUID
+        read_uuid
       when Types::STRUCT
         read_struct_begin
         while true
           name, type, id = read_field_begin
           break if type == Types::STOP
-          skip(type)
+          skip(type, max_depth - 1)
           read_field_end
         end
         read_struct_end
       when Types::MAP
         ktype, vtype, size = read_map_begin
+        validate_container_size(size)
         size.times do
-          skip(ktype)
-          skip(vtype)
+          skip(ktype, max_depth - 1)
+          skip(vtype, max_depth - 1)
         end
         read_map_end
       when Types::SET
         etype, size = read_set_begin
+        validate_container_size(size)
         size.times do
-          skip(etype)
+          skip(etype, max_depth - 1)
         end
         read_set_end
       when Types::LIST
         etype, size = read_list_begin
+        validate_container_size(size)
         size.times do
-          skip(etype)
+          skip(etype, max_depth - 1)
         end
         read_list_end
       else
         raise ProtocolException.new(ProtocolException::INVALID_DATA, 'Invalid data')
       end
     end
-    
+
+    def validate_container_size(size)
+      raise ProtocolException.new(ProtocolException::NEGATIVE_SIZE, 'Negative size') unless size >= 0
+    end
+
     def to_s
       "#{trans.to_s}"
     end
@@ -379,7 +410,7 @@ module Thrift
     def get_protocol(trans)
       raise NotImplementedError
     end
-    
+
     def to_s
       "base"
     end

data/lib/thrift/protocol/binary_protocol.rb

@@ -1,4 +1,5 @@
-# 
+# frozen_string_literal: true
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
 # distributed with this work for additional information
@@ -6,26 +7,34 @@
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License. You may obtain a copy of the License at
-# 
+#
 #   http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-# 
+#
 
 module Thrift
   class BinaryProtocol < BaseProtocol
     VERSION_MASK = 0xffff0000
     VERSION_1 = 0x80010000
     TYPE_MASK = 0x000000ff
-    
+    BYTE_MIN = -2**7
+    BYTE_MAX = 2**7 - 1
+    I16_MIN = -2**15
+    I16_MAX = 2**15 - 1
+    I32_MIN = -2**31
+    I32_MAX = 2**31 - 1
+    I64_MIN = -2**63
+    I64_MAX = 2**63 - 1
+
     attr_reader :strict_read, :strict_write
 
-    def initialize(trans, strict_read=true, strict_write=true)
+    def initialize(trans, strict_read = true, strict_write = true)
       super(trans)
       @strict_read = strict_read
       @strict_write = strict_write
@@ -36,11 +45,10 @@ module Thrift
     end
 
     def write_message_begin(name, type, seqid)
-      # this is necessary because we added (needed) bounds checking to 
-      # write_i32, and 0x80010000 is too big for that.
       if strict_write
-        write_i16(VERSION_1 >> 16)
-        write_i16(type)
+        raise ::TypeError, 'integer argument expected' unless type.is_a?(Integer)
+        raise RangeError if type < BYTE_MIN || type > BYTE_MAX
+        trans.write([VERSION_1 | type].pack('N'))
         write_string(name)
         write_i32(seqid)
       else
@@ -64,17 +72,17 @@ module Thrift
     def write_map_begin(ktype, vtype, size)
       write_byte(ktype)
       write_byte(vtype)
-      write_i32(size)
+      write_i32_size(size)
     end
 
     def write_list_begin(etype, size)
       write_byte(etype)
-      write_i32(size)
+      write_i32_size(size)
     end
 
     def write_set_begin(etype, size)
       write_byte(etype)
-      write_i32(size)
+      write_i32_size(size)
     end
 
     def write_bool(bool)
@@ -82,40 +90,57 @@ module Thrift
     end
 
     def write_byte(byte)
-      raise RangeError if byte < -2**31 || byte >= 2**32
+      raise 'nil argument not allowed!' if byte.nil?
+      raise ::TypeError, 'integer argument expected' unless byte.is_a?(Integer)
+      raise RangeError if byte < BYTE_MIN || byte > BYTE_MAX
       trans.write([byte].pack('c'))
     end
 
     def write_i16(i16)
+      raise 'nil argument not allowed!' if i16.nil?
+      raise ::TypeError, 'integer argument expected' unless i16.is_a?(Integer)
+      raise RangeError if i16 < I16_MIN || i16 > I16_MAX
       trans.write([i16].pack('n'))
     end
 
     def write_i32(i32)
-      raise RangeError if i32 < -2**31 || i32 >= 2**31
+      raise 'nil argument not allowed!' if i32.nil?
+      raise ::TypeError, 'integer argument expected' unless i32.is_a?(Integer)
+      raise RangeError if i32 < I32_MIN || i32 > I32_MAX
       trans.write([i32].pack('N'))
     end
 
     def write_i64(i64)
-      raise RangeError if i64 < -2**63 || i64 >= 2**64
+      raise 'nil argument not allowed!' if i64.nil?
+      raise ::TypeError, 'integer argument expected' unless i64.is_a?(Integer)
+      raise RangeError if i64 < I64_MIN || i64 > I64_MAX
       hi = i64 >> 32
       lo = i64 & 0xffffffff
       trans.write([hi, lo].pack('N2'))
     end
 
     def write_double(dub)
+      raise 'nil argument not allowed!' if dub.nil?
       trans.write([dub].pack('G'))
     end
 
     def write_string(str)
+      raise 'nil argument not allowed!' if str.nil?
       buf = Bytes.convert_to_utf8_byte_buffer(str)
       write_binary(buf)
     end
 
     def write_binary(buf)
-      write_i32(buf.bytesize)
+      raise 'nil argument not allowed!' if buf.nil?
+      write_i32_size(buf.bytesize)
       trans.write(buf)
     end
 
+    def write_uuid(uuid)
+      UUID.validate_uuid!(uuid)
+      trans.write(UUID.uuid_bytes(uuid))
+    end
+
     def read_message_begin
       version = read_i32
       if version < 0
@@ -153,18 +178,21 @@ module Thrift
       ktype = read_byte
       vtype = read_byte
       size = read_i32
+      raise ProtocolException.new(ProtocolException::NEGATIVE_SIZE, 'Negative size') unless size >= 0
       [ktype, vtype, size]
     end
 
     def read_list_begin
       etype = read_byte
       size = read_i32
+      raise ProtocolException.new(ProtocolException::NEGATIVE_SIZE, 'Negative size') unless size >= 0
       [etype, size]
     end
 
     def read_set_begin
       etype = read_byte
       size = read_i32
+      raise ProtocolException.new(ProtocolException::NEGATIVE_SIZE, 'Negative size') unless size >= 0
       [etype, size]
     end
 
@@ -224,19 +252,36 @@ module Thrift
 
     def read_binary
       size = read_i32
-      trans.read_all(size)
+      if size >= 0
+        trans.read_all(size)
+      else
+        raise ProtocolException.new(ProtocolException::NEGATIVE_SIZE, 'Negative size')
+      end
+    end
+
+    def read_uuid
+      UUID.uuid_from_bytes(trans.read_all(16))
     end
-    
+
     def to_s
       "binary(#{super.to_s})"
     end
+
+    private
+
+    def write_i32_size(size)
+      raise 'nil argument not allowed!' if size.nil?
+      raise ::TypeError, 'integer argument expected' unless size.is_a?(Integer)
+      raise RangeError if size < 0 || size > I32_MAX
+      trans.write([size].pack('N'))
+    end
   end
 
   class BinaryProtocolFactory < BaseProtocolFactory
     def get_protocol(trans)
       return Thrift::BinaryProtocol.new(trans)
     end
-    
+
     def to_s
       "binary"
     end

data/lib/thrift/protocol/binary_protocol_accelerated.rb

@@ -1,4 +1,5 @@
-# 
+# frozen_string_literal: true
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
 # distributed with this work for additional information
@@ -6,20 +7,20 @@
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License. You may obtain a copy of the License at
-# 
+#
 #   http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-# 
+#
 
 =begin
 The only change required for a transport to support BinaryProtocolAccelerated is to implement 2 methods:
-  * borrow(size), which takes an optional argument and returns atleast _size_ bytes from the transport, 
+  * borrow(size), which takes an optional argument and returns atleast _size_ bytes from the transport,
                   or the default buffer size if no argument is given
   * consume!(size), which removes size bytes from the front of the buffer