thrift 0.22.0 → 0.23.0

data/lib/thrift/protocol/header_protocol.rb

@@ -0,0 +1,320 @@
+# encoding: ascii-8bit
+#
+# 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
+# regarding copyright ownership. The ASF licenses this file
+# 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
+  # HeaderProtocol is a protocol that wraps HeaderTransport and delegates
+  # to either BinaryProtocol or CompactProtocol based on auto-detection.
+  #
+  # It provides access to header management (get_headers, set_header, etc.)
+  # through the underlying HeaderTransport.
+  #
+  # Example usage:
+  #   socket = Thrift::Socket.new('localhost', 9090)
+  #   protocol = Thrift::HeaderProtocol.new(socket)
+  #   client = MyService::Client.new(protocol)
+  #   protocol.trans.open
+  #   client.some_method()
+  #   protocol.trans.close
+  #
+  class HeaderProtocol < BaseProtocol
+    # Creates a new HeaderProtocol.
+    #
+    # @param transport [BaseTransport, HeaderTransport] The transport to wrap.
+    #   If not already a HeaderTransport, it will be wrapped in one.
+    # @param allowed_client_types [Array<Integer>] Allowed client types for auto-detection
+    # @param default_protocol [Integer] Default protocol ID (BINARY or COMPACT)
+    def initialize(transport, allowed_client_types = nil, default_protocol = HeaderSubprotocolID::COMPACT)
+      # Wrap transport in HeaderTransport if not already wrapped
+      if transport.is_a?(HeaderTransport)
+        @header_transport = transport
+      else
+        @header_transport = HeaderTransport.new(transport, allowed_client_types, default_protocol)
+      end
+
+      @default_protocol = default_protocol
+      @current_protocol_id = default_protocol
+
+      # Create initial protocol
+      @protocol = create_protocol(@current_protocol_id)
+    end
+
+    # Returns the HeaderTransport
+    def trans
+      @header_transport
+    end
+
+    # Returns headers read from the last message
+    def get_headers
+      @header_transport.get_headers
+    end
+
+    # Sets a header to be sent with the next message
+    def set_header(key, value)
+      @header_transport.set_header(key, value)
+    end
+
+    # Clears all write headers
+    def clear_headers
+      @header_transport.clear_headers
+    end
+
+    # Adds a transform (e.g., ZLIB compression)
+    def add_transform(transform_id)
+      @header_transport.add_transform(transform_id)
+    end
+
+    # Write methods - delegate to underlying protocol
+    def write_message_begin(name, type, seqid)
+      @header_transport.sequence_id = seqid
+      @protocol.write_message_begin(name, type, seqid)
+    end
+
+    def write_message_end
+      @protocol.write_message_end
+    end
+
+    def write_struct_begin(name)
+      @protocol.write_struct_begin(name)
+    end
+
+    def write_struct_end
+      @protocol.write_struct_end
+    end
+
+    def write_field_begin(name, type, id)
+      @protocol.write_field_begin(name, type, id)
+    end
+
+    def write_field_end
+      @protocol.write_field_end
+    end
+
+    def write_field_stop
+      @protocol.write_field_stop
+    end
+
+    def write_map_begin(ktype, vtype, size)
+      @protocol.write_map_begin(ktype, vtype, size)
+    end
+
+    def write_map_end
+      @protocol.write_map_end
+    end
+
+    def write_list_begin(etype, size)
+      @protocol.write_list_begin(etype, size)
+    end
+
+    def write_list_end
+      @protocol.write_list_end
+    end
+
+    def write_set_begin(etype, size)
+      @protocol.write_set_begin(etype, size)
+    end
+
+    def write_set_end
+      @protocol.write_set_end
+    end
+
+    def write_bool(bool)
+      @protocol.write_bool(bool)
+    end
+
+    def write_byte(byte)
+      @protocol.write_byte(byte)
+    end
+
+    def write_i16(i16)
+      @protocol.write_i16(i16)
+    end
+
+    def write_i32(i32)
+      @protocol.write_i32(i32)
+    end
+
+    def write_i64(i64)
+      @protocol.write_i64(i64)
+    end
+
+    def write_double(dub)
+      @protocol.write_double(dub)
+    end
+
+    def write_string(str)
+      @protocol.write_string(str)
+    end
+
+    def write_binary(buf)
+      @protocol.write_binary(buf)
+    end
+
+    def write_uuid(uuid)
+      @protocol.write_uuid(uuid)
+    end
+
+    # Read methods - delegate to underlying protocol
+    # read_message_begin handles protocol switching after detection
+    def read_message_begin
+      begin
+        @header_transport.reset_protocol
+        reset_protocol_if_needed
+      rescue ProtocolException => ex
+        app_ex = ApplicationException.new(ApplicationException::INVALID_PROTOCOL, ex.message)
+        write_message_begin("", MessageTypes::EXCEPTION, 0)
+        app_ex.write(self)
+        write_message_end
+        @header_transport.flush
+        raise ex
+      end
+      @protocol.read_message_begin
+    end
+
+    def read_message_end
+      @protocol.read_message_end
+    end
+
+    def read_struct_begin
+      @protocol.read_struct_begin
+    end
+
+    def read_struct_end
+      @protocol.read_struct_end
+    end
+
+    def read_field_begin
+      @protocol.read_field_begin
+    end
+
+    def read_field_end
+      @protocol.read_field_end
+    end
+
+    def read_map_begin
+      @protocol.read_map_begin
+    end
+
+    def read_map_end
+      @protocol.read_map_end
+    end
+
+    def read_list_begin
+      @protocol.read_list_begin
+    end
+
+    def read_list_end
+      @protocol.read_list_end
+    end
+
+    def read_set_begin
+      @protocol.read_set_begin
+    end
+
+    def read_set_end
+      @protocol.read_set_end
+    end
+
+    def read_bool
+      @protocol.read_bool
+    end
+
+    def read_byte
+      @protocol.read_byte
+    end
+
+    def read_i16
+      @protocol.read_i16
+    end
+
+    def read_i32
+      @protocol.read_i32
+    end
+
+    def read_i64
+      @protocol.read_i64
+    end
+
+    def read_double
+      @protocol.read_double
+    end
+
+    def read_string
+      @protocol.read_string
+    end
+
+    def read_binary
+      @protocol.read_binary
+    end
+
+    def read_uuid
+      @protocol.read_uuid
+    end
+
+    def to_s
+      "header(#{@protocol.to_s})"
+    end
+
+    private
+
+    # Checks if the protocol needs to be switched after reading
+    def reset_protocol_if_needed
+      new_protocol_id = @header_transport.protocol_id
+      if new_protocol_id != @current_protocol_id
+        @protocol = create_protocol(new_protocol_id)
+        @current_protocol_id = new_protocol_id
+      end
+    end
+
+    # Creates a protocol instance based on protocol ID
+    def create_protocol(protocol_id)
+      case protocol_id
+      when HeaderSubprotocolID::BINARY
+        BinaryProtocol.new(@header_transport)
+      when HeaderSubprotocolID::COMPACT
+        CompactProtocol.new(@header_transport)
+      else
+        raise ProtocolException.new(
+          ProtocolException::INVALID_DATA,
+          "Unknown protocol ID: #{protocol_id}"
+        )
+      end
+    end
+  end
+
+  # Factory for creating HeaderProtocol instances
+  class HeaderProtocolFactory < BaseProtocolFactory
+    # Creates a new HeaderProtocolFactory.
+    #
+    # @param allowed_client_types [Array<Integer>] Allowed client types for auto-detection
+    # @param default_protocol [Integer] Default protocol ID (BINARY or COMPACT)
+    def initialize(allowed_client_types = nil, default_protocol = HeaderSubprotocolID::BINARY)
+      @allowed_client_types = allowed_client_types
+      @default_protocol = default_protocol
+    end
+
+    def get_protocol(trans)
+      HeaderProtocol.new(trans, @allowed_client_types, @default_protocol)
+    end
+
+    def to_s
+      "header"
+    end
+  end
+end

data/lib/thrift/protocol/json_protocol.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-# 
+#
 # 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
@@ -7,18 +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.
-# 
-
-require 'base64'
+#
 
 module Thrift
   class LookaheadReader
@@ -181,6 +179,8 @@ module Thrift
         "set"
       when Types::LIST
         "lst"
+      when Types::UUID
+        "uid"
       else
         raise NotImplementedError
       end
@@ -209,6 +209,8 @@ module Thrift
         result = Types::SET
       elsif (name == "lst")
         result = Types::LIST
+      elsif (name == "uid")
+        result = Types::UUID
       else
         result = Types::STOP
       end
@@ -255,7 +257,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.
@@ -266,9 +268,9 @@ module Thrift
       # <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, '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
+          1, 1, '"', 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, # 2
       ]
 
       ch_value = ch[0]
@@ -311,7 +313,7 @@ module Thrift
     def write_json_base64(str)
       @context.write(trans)
       trans.write(@@kJSONStringDelimiter)
-      trans.write(Base64.strict_encode64(str))
+      trans.write([str].pack('m0'))
       trans.write(@@kJSONStringDelimiter)
     end
 
@@ -477,6 +479,11 @@ module Thrift
       write_json_base64(str)
     end
 
+    def write_uuid(uuid)
+      UUID.validate_uuid!(uuid)
+      write_json_string(uuid.downcase)
+    end
+
     ##
     # Reading functions
     ##
@@ -497,11 +504,7 @@ module Thrift
       str += @reader.read
       str += @reader.read
       str += @reader.read
-      if RUBY_VERSION >= '1.9'
-        str.hex.chr(Encoding::UTF_8)
-      else
-        str.hex.chr
-      end
+      str.hex.chr(Encoding::UTF_8)
     end
 
     # Decodes a JSON string, including unescaping, and returns the string via str
@@ -555,7 +558,7 @@ module Thrift
           str += '='
         end
       end
-      Base64.strict_decode64(str)
+      str.unpack1('m0')
     end
 
     # Reads a sequence of characters, stopping at the first one that is not
@@ -769,6 +772,13 @@ module Thrift
       read_json_base64
     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})"
     end

data/lib/thrift/protocol/multiplexed_protocol.rb

@@ -1,4 +1,4 @@
-# 
+#
 # 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 +6,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
@@ -34,9 +34,9 @@ module Thrift
         @protocol.write_message_begin("#{@service_name}:#{name}", type, seqid)
       else
         @protocol.write_message_begin(name, type, seqid)
-      end 
+      end
     end
-    
+
     def to_s
       "multiplexed(#{@service_name=@protocol.to_s})"
     end

data/lib/thrift/protocol/protocol_decorator.rb

@@ -1,4 +1,4 @@
-# 
+#
 # 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 +6,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
@@ -111,6 +111,10 @@ module Thrift
       @protocol.write_binary(buf)
     end
 
+    def write_uuid(uuid)
+      @protocol.write_uuid(uuid)
+    end
+
     def read_message_begin
       @protocol.read_message_begin
     end
@@ -190,5 +194,9 @@ module Thrift
     def read_binary
       @protocol.read_binary
     end
+
+    def read_uuid
+      @protocol.read_uuid
+    end
   end
-end
+end

data/lib/thrift/serializer/deserializer.rb

@@ -1,4 +1,4 @@
-# 
+#
 # 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 +6,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.
-# 
+#
 
 module Thrift
   class Deserializer
@@ -30,4 +30,4 @@ module Thrift
       base
     end
   end
-end
+end

data/lib/thrift/serializer/serializer.rb

@@ -1,4 +1,4 @@
-# 
+#
 # 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 +6,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.
-# 
+#
 
 module Thrift
   class Serializer
@@ -31,4 +31,3 @@ module Thrift
     end
   end
 end
-

data/lib/thrift/server/base_server.rb

@@ -1,4 +1,4 @@
-# 
+#
 # 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 +6,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
@@ -19,7 +19,7 @@
 
 module Thrift
   class BaseServer
-    def initialize(processor, server_transport, transport_factory=nil, protocol_factory=nil)
+    def initialize(processor, server_transport, transport_factory = nil, protocol_factory = nil)
       @processor = processor
       @server_transport = server_transport
       @transport_factory = transport_factory ? transport_factory : Thrift::BaseTransportFactory.new

data/lib/thrift/server/mongrel_http_server.rb

@@ -1,4 +1,4 @@
-# 
+#
 # 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 +6,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.
-# 
+#
 
 require 'mongrel'
 
@@ -38,12 +38,12 @@ module Thrift
             @processor.process protocol, protocol
           end
         else
-          response.start(404) { }
+          response.start(404) {}
         end
       end
     end
 
-    def initialize(processor, opts={})
+    def initialize(processor, opts = {})
       Kernel.warn "[DEPRECATION WARNING] `Thrift::MongrelHTTPServer` is deprecated.  Please use `Thrift::ThinHTTPServer` instead."
       port = opts[:port] || 80
       ip = opts[:ip] || "0.0.0.0"

data/lib/thrift/server/nonblocking_server.rb

@@ -1,4 +1,4 @@
-# 
+#
 # 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 +6,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.
-# 
+#
 
 require 'logger'
 require 'thread'
@@ -23,7 +23,7 @@ require 'thread'
 module Thrift
   # this class expects to always use a FramedTransport for reading messages
   class NonblockingServer < BaseServer
-    def initialize(processor, server_transport, transport_factory=nil, protocol_factory=nil, num=20, logger=nil)
+    def initialize(processor, server_transport, transport_factory = nil, protocol_factory = nil, num = 20, logger = nil)
       super(processor, server_transport, transport_factory, protocol_factory)
       @num_threads = num
       if logger.nil?
@@ -97,7 +97,7 @@ module Thrift
 
     class IOManager # :nodoc:
       DEFAULT_BUFFER = 2**20
-      
+
       def initialize(processor, server_transport, transport_factory, protocol_factory, num, logger)
         @processor = processor
         @server_transport = server_transport
@@ -106,7 +106,7 @@ module Thrift
         @num_threads = num
         @logger = logger
         @connections = []
-        @buffers = Hash.new { |h,k| h[k] = '' }
+        @buffers = Hash.new { |h, k| h[k] = '' }
         @signal_queue = Queue.new
         @signal_pipes = IO.pipe
         @signal_pipes[1].sync = true
@@ -142,7 +142,7 @@ module Thrift
       end
 
       private
-      
+
       def run
         spin_worker_threads