thrift 0.23.0 → 0.25.0

data/lib/thrift/protocol/json_protocol.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -33,7 +34,7 @@ module Thrift
         @data = @trans.read(1)
       end
 
-      return @data
+      @data
     end
 
     def peek
@@ -41,7 +42,7 @@ module Thrift
         @data = @trans.read(1)
       end
       @hasData = true
-      return @data
+      @data
     end
   end
 
@@ -50,7 +51,7 @@ module Thrift
   # implementations
   #
   class JSONContext
-    @@kJSONElemSeparator = ','
+    @@kJSONElemSeparator = ","
     #
     # Write context data to the trans. Default is to do nothing.
     #
@@ -68,13 +69,13 @@ module Thrift
     # Default behavior is to return false.
     #
     def escapeNum
-      return false
+      false
     end
   end
 
   # Context class for object member key-value pairs
   class JSONPairContext < JSONContext
-    @@kJSONPairSeparator = ':'
+    @@kJSONPairSeparator = ":"
 
     def initialize
       @first = true
@@ -82,7 +83,7 @@ module Thrift
     end
 
     def write(trans)
-      if (@first)
+      if @first
         @first = false
         @colon = true
       else
@@ -92,7 +93,7 @@ module Thrift
     end
 
     def read(reader)
-      if (@first)
+      if @first
         @first = false
         @colon = true
       else
@@ -104,19 +105,18 @@ module Thrift
 
     # Numbers must be turned into strings if they are the key part of a pair
     def escapeNum
-      return @colon
+      @colon
     end
   end
 
   # Context class for lists
   class JSONListContext < JSONContext
-
     def initialize
       @first = true
     end
 
     def write(trans)
-      if (@first)
+      if @first
         @first = false
       else
         trans.write(@@kJSONElemSeparator)
@@ -124,7 +124,7 @@ module Thrift
     end
 
     def read(reader)
-      if (@first)
+      if @first
         @first = false
       else
         JsonProtocol::read_syntax_char(reader, @@kJSONElemSeparator)
@@ -133,13 +133,14 @@ module Thrift
   end
 
   class JsonProtocol < BaseProtocol
+    attr_reader :max_string_size
 
-    @@kJSONObjectStart = '{'
-    @@kJSONObjectEnd = '}'
-    @@kJSONArrayStart = '['
-    @@kJSONArrayEnd = ']'
+    @@kJSONObjectStart = "{"
+    @@kJSONObjectEnd = "}"
+    @@kJSONArrayStart = "["
+    @@kJSONArrayEnd = "]"
     @@kJSONNewline = '\n'
-    @@kJSONBackslash = '\\'
+    @@kJSONBackslash = "\\"
     @@kJSONStringDelimiter = '"'
 
     @@kThriftVersion1 = 1
@@ -148,8 +149,10 @@ module Thrift
     @@kThriftInfinity = "Infinity"
     @@kThriftNegativeInfinity = "-Infinity"
 
-    def initialize(trans)
+    def initialize(trans, max_string_size: DEFAULT_MAX_STRING_SIZE)
+      BaseProtocol.validate_max_string_size(max_string_size)
       super(trans)
+      @max_string_size = max_string_size
       @context = JSONContext.new
       @contexts = Array.new
       @reader = LookaheadReader.new(trans)
@@ -182,42 +185,27 @@ module Thrift
       when Types::UUID
         "uid"
       else
-        raise NotImplementedError
+        raise ProtocolException.new(ProtocolException::INVALID_DATA, "Unknown type id: #{id}")
       end
     end
 
     def get_type_id_for_type_name(name)
-      if (name == "tf")
-        result = Types::BOOL
-      elsif (name == "i8")
-        result = Types::BYTE
-      elsif (name == "i16")
-        result = Types::I16
-      elsif (name == "i32")
-        result = Types::I32
-      elsif (name == "i64")
-        result = Types::I64
-      elsif (name == "dbl")
-        result = Types::DOUBLE
-      elsif (name == "str")
-        result = Types::STRING
-      elsif (name == "rec")
-        result = Types::STRUCT
-      elsif (name == "map")
-        result = Types::MAP
-      elsif (name == "set")
-        result = Types::SET
-      elsif (name == "lst")
-        result = Types::LIST
-      elsif (name == "uid")
-        result = Types::UUID
+      case name
+      when "tf" then Types::BOOL
+      when "i8" then Types::BYTE
+      when "i16" then Types::I16
+      when "i32" then Types::I32
+      when "i64" then Types::I64
+      when "dbl" then Types::DOUBLE
+      when "str" then Types::STRING
+      when "rec" then Types::STRUCT
+      when "map" then Types::MAP
+      when "set" then Types::SET
+      when "lst" then Types::LIST
+      when "uid" then Types::UUID
       else
-        result = Types::STOP
+        raise ProtocolException.new(ProtocolException::INVALID_DATA, "Unknown type name: #{name.inspect}")
       end
-      if (result == Types::STOP)
-        raise NotImplementedError
-      end
-      return result
     end
 
     # Static helper functions
@@ -227,17 +215,17 @@ module Thrift
     def self.read_syntax_char(reader, ch)
       ch2 = reader.read
       if (ch2 != ch)
-        raise ProtocolException.new(ProtocolException::INVALID_DATA, "Expected \'#{ch}\' got \'#{ch2}\'.")
+        raise ProtocolException.new(ProtocolException::INVALID_DATA, "Expected '#{ch}' got '#{ch2}'.")
       end
     end
 
-   # Return true if the character ch is in [-+0-9.Ee]; false otherwise
+    # Return true if the character ch is in [-+0-9.Ee]; false otherwise
     def is_json_numeric(ch)
       case ch
-      when '+', '-', '.', '0' .. '9', 'E', "e"
-        return true
+      when "+", "-", ".", "0".."9", "E", "e"
+        true
       else
-        return false
+        false
       end
     end
 
@@ -257,7 +245,7 @@ module Thrift
       if (ch_value.kind_of? String)
         ch_value = ch.bytes.first
       end
-      trans.write(ch_value.to_s(16).rjust(4, '0'))
+      trans.write(ch_value.to_s(16).rjust(4, "0"))
     end
 
     # Write the character ch as part of a JSON string, escaping as appropriate.
@@ -267,10 +255,10 @@ module Thrift
       # 1 : just output index
       # <other> : escape using "\<other>" notation
       kJSONCharTable = [
-          # 0 1 2 3 4 5 6 7 8 9 A B C D E F
-          0, 0, 0, 0, 0, 0, 0, 0, 'b', 't', 'n', 0, 'f', 'r', 0, 0, # 0
-          0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, # 1
-          1, 1, '"', 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, # 2
+        # 0 1 2 3 4 5 6 7 8 9 A B C D E F
+        0, 0, 0, 0, 0, 0, 0, 0, "b", "t", "n", 0, "f", "r", 0, 0, # 0
+        0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, # 1
+        1, 1, '"', 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, # 2
       ]
 
       ch_value = ch[0]
@@ -300,9 +288,10 @@ module Thrift
 
     # Write out the contents of the string str as a JSON string, escaping characters as appropriate.
     def write_json_string(str)
+      str = normalize_json_string(str)
       @context.write(trans)
       trans.write(@@kJSONStringDelimiter)
-      str.split('').each do |ch|
+      str.each_char do |ch|
         write_json_char(ch)
       end
       trans.write(@@kJSONStringDelimiter)
@@ -313,7 +302,7 @@ module Thrift
     def write_json_base64(str)
       @context.write(trans)
       trans.write(@@kJSONStringDelimiter)
-      trans.write([str].pack('m0'))
+      trans.write([str].pack("m0"))
       trans.write(@@kJSONStringDelimiter)
     end
 
@@ -322,11 +311,11 @@ module Thrift
     def write_json_integer(num)
       @context.write(trans)
       escapeNum = @context.escapeNum
-      if (escapeNum)
+      if escapeNum
         trans.write(@@kJSONStringDelimiter)
       end
       trans.write(num.to_s);
-      if (escapeNum)
+      if escapeNum
         trans.write(@@kJSONStringDelimiter)
       end
     end
@@ -337,10 +326,10 @@ module Thrift
       @context.write(trans)
       # Normalize output of thrift::to_string for NaNs and Infinities
       special = false;
-      if (num.nan?)
+      if num.nan?
         special = true;
         val = @@kThriftNan;
-      elsif (num.infinite?)
+      elsif num.infinite?
         special = true;
         val = @@kThriftInfinity;
         if (num < 0.0)
@@ -351,11 +340,11 @@ module Thrift
       end
 
       escapeNum = special || @context.escapeNum
-      if (escapeNum)
+      if escapeNum
         trans.write(@@kJSONStringDelimiter)
       end
       trans.write(val)
-      if (escapeNum)
+      if escapeNum
         trans.write(@@kJSONStringDelimiter)
       end
     end
@@ -493,59 +482,65 @@ module Thrift
       JsonProtocol::read_syntax_char(@reader, ch)
     end
 
-    # Decodes the four hex parts of a JSON escaped string character and returns
-    # the character via out.
-    #
-    # Note - this only supports Unicode characters in the BMP (U+0000 to U+FFFF);
-    # characters above the BMP are encoded as two escape sequences (surrogate pairs),
-    # which is not yet implemented
     def read_json_escape_char
-      str = @reader.read
-      str += @reader.read
-      str += @reader.read
-      str += @reader.read
-      str.hex.chr(Encoding::UTF_8)
+      code_unit = read_unicode_code_unit
+
+      if code_unit.between?(0xD800, 0xDBFF)
+        slash = @reader.read
+        marker = @reader.read
+        invalid_unicode!("Unpaired UTF-16 high surrogate") unless slash == "\\" && marker == "u"
+
+        low_surrogate = read_unicode_code_unit
+        invalid_unicode!("Unpaired UTF-16 high surrogate") unless low_surrogate.between?(0xDC00, 0xDFFF)
+        codepoint = 0x10000 + ((code_unit - 0xD800) << 10) + (low_surrogate - 0xDC00)
+        [codepoint].pack("U")
+      elsif code_unit.between?(0xDC00, 0xDFFF)
+        invalid_unicode!("Unpaired UTF-16 low surrogate")
+      else
+        [code_unit].pack("U")
+      end
+    rescue EOFError
+      invalid_unicode!("Incomplete Unicode escape")
     end
 
     # Decodes a JSON string, including unescaping, and returns the string via str
     def read_json_string(skipContext = false)
       # This string's characters must match up with the elements in escape_char_vals.
-      # I don't have '/' on this list even though it appears on www.json.org --
-      # it is not in the RFC -> it is. See RFC 4627
+      # JSON permits the optional solidus escape "\/"; see RFC 8259, section 7.
       escape_chars = "\"\\/bfnrt"
 
       # The elements of this array must match up with the sequence of characters in
       # escape_chars
       escape_char_vals = [
-        "\"", "\\", "\/", "\b", "\f", "\n", "\r", "\t",
+        "\"", "\\", "/", "\b", "\f", "\n", "\r", "\t",
       ]
 
       if !skipContext
         @context.read(@reader)
       end
       read_json_syntax_char(@@kJSONStringDelimiter)
-      ch = ""
-      str = ""
-      while (true)
+      str = Bytes.empty_byte_buffer
+      while true
         ch = @reader.read
         if (ch == @@kJSONStringDelimiter)
           break
         end
         if (ch == @@kJSONBackslash)
           ch = @reader.read
-          if (ch == 'u')
+          if (ch == "u")
             ch = read_json_escape_char
           else
             pos = escape_chars.index(ch);
-            if (pos.nil?) # not found
-              raise ProtocolException.new(ProtocolException::INVALID_DATA, "Expected control char, got \'#{ch}\'.")
+            if pos.nil? # not found
+              raise ProtocolException.new(ProtocolException::INVALID_DATA, "Expected control char, got '#{ch}'.")
             end
             ch = escape_char_vals[pos]
           end
         end
-        str += ch
+        str << Bytes.force_binary_encoding(ch)
+        check_string_size(str.bytesize)
       end
-      return str
+      decode_json_string(str)
     end
 
     # Reads a block of base64 characters, decoding it, and returns via str
@@ -555,32 +550,37 @@ module Thrift
       if m != 0
         # Add missing padding
         (4 - m).times do
-          str += '='
+          str += "="
         end
       end
-      str.unpack1('m0')
+      begin
+        str.unpack1("m0")
+      rescue ArgumentError
+        raise ProtocolException.new(ProtocolException::INVALID_DATA, "Invalid Base64 data")
+      end
     end
 
     # Reads a sequence of characters, stopping at the first one that is not
     # a valid JSON numeric character.
     def read_json_numeric_chars
-      str = ""
-      while (true)
+      str = String.new(encoding: Encoding::UTF_8)
+      while true
         ch = @reader.peek
-        if (!is_json_numeric(ch))
+        if !is_json_numeric(ch)
           break;
         end
         ch = @reader.read
-        str += ch
+        str << ch
+        check_string_size(str.bytesize)
       end
-      return str
+      str
     end
 
     # Reads a sequence of characters and assembles them into a number,
     # returning them via num
     def read_json_integer
       @context.read(@reader)
-      if (@context.escapeNum)
+      if @context.escapeNum
         read_json_syntax_char(@@kJSONStringDelimiter)
       end
       str = read_json_numeric_chars
@@ -591,11 +591,11 @@ module Thrift
         raise ProtocolException.new(ProtocolException::INVALID_DATA, "Expected numeric value; got \"#{str}\"")
       end
 
-      if (@context.escapeNum)
+      if @context.escapeNum
         read_json_syntax_char(@@kJSONStringDelimiter)
       end
 
-      return num
+      num
     end
 
     # Reads a JSON number or string and interprets it as a double.
@@ -606,13 +606,13 @@ module Thrift
         str = read_json_string(true)
         # Check for NaN, Infinity and -Infinity
         if (str == @@kThriftNan)
-          num = (+1.0/0.0)/(+1.0/0.0)
+          num = (+1.0 / 0.0) / (+1.0 / 0.0)
         elsif (str == @@kThriftInfinity)
-          num = +1.0/0.0
+          num = +1.0 / 0.0
         elsif (str == @@kThriftNegativeInfinity)
-          num = -1.0/0.0
+          num = -1.0 / 0.0
         else
-          if (!@context.escapeNum)
+          if !@context.escapeNum
             # Raise exception -- we should not be in a string in this case
             raise ProtocolException.new(ProtocolException::INVALID_DATA, "Numeric data unexpectedly quoted")
           end
@@ -623,7 +623,7 @@ module Thrift
           end
         end
       else
-        if (@context.escapeNum)
+        if @context.escapeNum
           # This will throw - we should have had a quote if escapeNum == true
           read_json_syntax_char(@@kJSONStringDelimiter)
         end
@@ -634,7 +634,7 @@ module Thrift
           raise ProtocolException.new(ProtocolException::INVALID_DATA, "Expected numeric value; got \"#{str}\"")
         end
       end
-      return num
+      num
     end
 
     def read_json_object_start
@@ -667,7 +667,7 @@ module Thrift
       read_json_array_start
       version = read_json_integer
       if (version != @@kThriftVersion1)
-        raise ProtocolException.new(ProtocolException::BAD_VERSION, 'Message contained bad version.')
+        raise ProtocolException.new(ProtocolException::BAD_VERSION, "Message contained bad version.")
       end
       name = read_json_string
       message_type = read_json_integer
@@ -712,6 +712,7 @@ module Thrift
       key_type = get_type_id_for_type_name(read_json_string)
       val_type = get_type_id_for_type_name(read_json_string)
       size = read_json_integer
+      validate_container_size(size)
       read_json_object_start
       [key_type, val_type, size]
     end
@@ -723,7 +724,10 @@ module Thrift
 
     def read_list_begin
       read_json_array_start
-      [get_type_id_for_type_name(read_json_string), read_json_integer]
+      type = get_type_id_for_type_name(read_json_string)
+      size = read_json_integer
+      validate_container_size(size)
+      [type, size]
     end
 
     def read_list_end
@@ -732,7 +736,10 @@ module Thrift
 
     def read_set_begin
       read_json_array_start
-      [get_type_id_for_type_name(read_json_string), read_json_integer]
+      type = get_type_id_for_type_name(read_json_string)
+      size = read_json_integer
+      validate_container_size(size)
+      [type, size]
     end
 
     def read_set_end
@@ -772,21 +779,63 @@ module Thrift
       read_json_base64
     end
 
+    def skip_string
+      read_string
+    end
+
     def read_uuid
       uuid = read_json_string
-      raise EOFError.new if uuid.length < 36
       UUID.validate_uuid!(uuid)
       uuid.tap(&:downcase!)
     end
 
     def to_s
-      "json(#{super.to_s})"
+      "json(#{super})"
+    end
+
+    private
+
+    def normalize_json_string(str)
+      utf8 = if str.encoding == Encoding::UTF_8
+        str
+      elsif str.encoding == Encoding::BINARY
+        str.ascii_only? ? str : str.dup.force_encoding(Encoding::UTF_8)
+      else
+        str.encode(Encoding::UTF_8)
+      end
+      invalid_unicode!("Invalid UTF-8 string") unless utf8.valid_encoding?
+      utf8
+    rescue EncodingError
+      invalid_unicode!("Invalid UTF-8 string")
+    end
+
+    def decode_json_string(bytes)
+      bytes.force_encoding(Encoding::UTF_8)
+      invalid_unicode!("Invalid UTF-8 string") unless bytes.valid_encoding?
+      bytes
+    end
+
+    def read_unicode_code_unit
+      hex = Bytes.empty_byte_buffer
+      4.times { hex << @reader.read }
+      invalid_unicode!("Invalid Unicode escape") unless hex.match?(/\A[0-9a-fA-F]{4}\z/)
+      hex.to_i(16)
+    rescue EOFError
+      invalid_unicode!("Incomplete Unicode escape")
+    end
+
+    def invalid_unicode!(message)
+      raise ProtocolException.new(ProtocolException::INVALID_DATA, message)
     end
   end
 
   class JsonProtocolFactory < BaseProtocolFactory
+    def initialize(max_string_size: BaseProtocol::DEFAULT_MAX_STRING_SIZE)
+      @max_string_size = max_string_size
+    end
+
     def get_protocol(trans)
-      return Thrift::JsonProtocol.new(trans)
+      Thrift::JsonProtocol.new(trans, max_string_size: @max_string_size)
     end
 
     def to_s

data/lib/thrift/protocol/multiplexed_protocol.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -16,11 +17,10 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'thrift/protocol/protocol_decorator'
+require "thrift/protocol/protocol_decorator"
 
 module Thrift
   class MultiplexedProtocol < BaseProtocol
-
     include ProtocolDecorator
 
     def initialize(protocol, service_name)
@@ -38,7 +38,7 @@ module Thrift
     end
 
     def to_s
-      "multiplexed(#{@service_name=@protocol.to_s})"
+      "multiplexed(#{@protocol})"
     end
   end
 end

data/lib/thrift/protocol/protocol_decorator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -18,7 +19,6 @@
 
 module Thrift
   module ProtocolDecorator
-
     def initialize(protocol)
       @protocol = protocol
     end
@@ -28,7 +28,7 @@ module Thrift
     end
 
     def write_message_begin(name, type, seqid)
-      @protocol.write_message_begin
+      @protocol.write_message_begin(name, type, seqid)
     end
 
     def write_message_end
@@ -195,6 +195,10 @@ module Thrift
       @protocol.read_binary
     end
 
+    def skip_string
+      @protocol.skip_string
+    end
+
     def read_uuid
       @protocol.read_uuid
     end

data/lib/thrift/serializer/deserializer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file

data/lib/thrift/serializer/serializer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -20,14 +21,20 @@
 module Thrift
   class Serializer
     def initialize(protocol_factory = BinaryProtocolFactory.new)
+      @protocol_factory = protocol_factory
       @transport = MemoryBufferTransport.new
       @protocol = protocol_factory.get_protocol(@transport)
     end
 
     def serialize(base)
       @transport.reset_buffer
+      @protocol ||= @protocol_factory.get_protocol(@transport)
       base.write(@protocol)
+      @protocol.trans.flush
       @transport.read(@transport.available)
+    rescue
+      @protocol = nil
+      raise
     end
   end
 end