websocket-driver 0.6.5-java → 0.7.4-java

data/ext/websocket-driver/websocket_mask.c

@@ -1,41 +1,32 @@
 #include <ruby.h>
 
-VALUE WebSocket = Qnil;
-VALUE WebSocketMask = Qnil;
-
-void Init_websocket_mask();
-VALUE method_websocket_mask(VALUE self, VALUE payload, VALUE mask);
-
-void
-Init_websocket_mask()
+VALUE method_websocket_mask(VALUE self, VALUE payload, VALUE mask)
 {
-  WebSocket = rb_define_module("WebSocket");
-  WebSocketMask = rb_define_module_under(WebSocket, "Mask");
-  rb_define_singleton_method(WebSocketMask, "mask", method_websocket_mask, 2);
-}
+    char *payload_s, *mask_s, *unmasked_s;
+    long i, n;
+    VALUE unmasked;
 
-VALUE
-method_websocket_mask(VALUE self,
-                      VALUE payload,
-                      VALUE mask)
-{
-  char *payload_s, *mask_s, *unmasked_s;
-  long i, n;
-  VALUE unmasked;
+    if (mask == Qnil || RSTRING_LEN(mask) != 4) {
+        return payload;
+    }
 
-  if (mask == Qnil || RSTRING_LEN(mask) != 4) {
-    return payload;
-  }
+    payload_s = RSTRING_PTR(payload);
+    mask_s    = RSTRING_PTR(mask);
+    n         = RSTRING_LEN(payload);
 
-  payload_s = RSTRING_PTR(payload);
-  mask_s    = RSTRING_PTR(mask);
-  n         = RSTRING_LEN(payload);
+    unmasked   = rb_str_new(0, n);
+    unmasked_s = RSTRING_PTR(unmasked);
 
-  unmasked   = rb_str_new(0, n);
-  unmasked_s = RSTRING_PTR(unmasked);
+    for (i = 0; i < n; i++) {
+        unmasked_s[i] = payload_s[i] ^ mask_s[i % 4];
+    }
+    return unmasked;
+}
+
+void Init_websocket_mask()
+{
+    VALUE WebSocket = rb_define_module("WebSocket");
+    VALUE Mask = rb_define_module_under(WebSocket, "Mask");
 
-  for (i = 0; i < n; i++) {
-    unmasked_s[i] = payload_s[i] ^ mask_s[i % 4];
-  }
-  return unmasked;
+    rb_define_singleton_method(Mask, "mask", method_websocket_mask, 2);
 }

data/lib/websocket/driver.rb

@@ -44,12 +44,11 @@ module WebSocket
     MAX_LENGTH = 0x3ffffff
     STATES     = [:connecting, :open, :closing, :closed]
 
-    BINARY  = 'ASCII-8BIT'
-    UNICODE = 'UTF-8'
-
     ConnectEvent = Struct.new(nil)
     OpenEvent    = Struct.new(nil)
     MessageEvent = Struct.new(:data)
+    PingEvent    = Struct.new(:data)
+    PongEvent    = Struct.new(:data)
     CloseEvent   = Struct.new(:code, :reason)
 
     ProtocolError      = Class.new(StandardError)
@@ -99,15 +98,24 @@ module WebSocket
 
     def start
       return false unless @ready_state == 0
-      response = handshake_response
-      return false unless response
+
+      unless Driver.websocket?(@socket.env)
+        return fail_handshake(ProtocolError.new('Not a WebSocket request'))
+      end
+
+      begin
+        response = handshake_response
+      rescue => error
+        return fail_handshake(error)
+      end
+
       @socket.write(response)
       open unless @stage == -1
       true
     end
 
     def text(message)
-      message = message.encode(UNICODE) unless message.encoding.name == UNICODE
+      message = message.encode(Encoding::UTF_8) unless message.encoding == Encoding::UTF_8
       frame(message, :text)
     end
 
@@ -132,6 +140,24 @@ module WebSocket
 
   private
 
+    def fail_handshake(error)
+      headers = Headers.new
+      headers['Content-Type'] = 'text/plain'
+      headers['Content-Length'] = error.message.bytesize
+
+      headers = ['HTTP/1.1 400 Bad Request', headers.to_s, error.message]
+      @socket.write(headers.join("\r\n"))
+      fail(:protocol_error, error.message)
+
+      false
+    end
+
+    def fail(type, message)
+      @ready_state = 2
+      emit(:error, ProtocolError.new(message))
+      close
+    end
+
     def open
       @ready_state = 1
       @queue.each { |message| frame(*message) }
@@ -153,10 +179,15 @@ module WebSocket
     end
 
     def self.rack(socket, options = {})
-      env = socket.env
-      if env['HTTP_SEC_WEBSOCKET_VERSION']
+      env     = socket.env
+      version = env['HTTP_SEC_WEBSOCKET_VERSION']
+      key     = env['HTTP_SEC_WEBSOCKET_KEY']
+      key1    = env['HTTP_SEC_WEBSOCKET_KEY1']
+      key2    = env['HTTP_SEC_WEBSOCKET_KEY2']
+
+      if version or key
         Hybi.new(socket, options.merge(:require_masking => true))
-      elsif env['HTTP_SEC_WEBSOCKET_KEY1']
+      elsif key1 or key2
         Draft76.new(socket, options)
       else
         Draft75.new(socket, options)
@@ -167,21 +198,21 @@ module WebSocket
       case string
         when Array then
           string = string.pack('C*')
-          encoding ||= BINARY
+          encoding ||= Encoding::BINARY
         when String then
-          encoding ||= UNICODE
+          encoding ||= Encoding::UTF_8
       end
-      unless string.encoding.name == encoding
+      unless string.encoding == encoding
         string = string.dup if string.frozen?
         string.force_encoding(encoding)
       end
-      string.valid_encoding? ? string : nil
+      string
     end
 
     def self.validate_options(options, valid_keys)
       options.keys.each do |key|
         unless valid_keys.include?(key)
-          raise ConfigurationError, "Unrecognized option: #{key.inspect}"
+          raise ConfigurationError, "Unrecognized option: #{ key.inspect }"
         end
       end
     end

data/lib/websocket/driver/client.rb

@@ -20,10 +20,10 @@ module WebSocket
 
         uri = URI.parse(@socket.url)
         unless VALID_SCHEMES.include?(uri.scheme)
-          raise URIError, "#{socket.url} is not a valid WebSocket URL"
+          raise URIError, "#{ socket.url } is not a valid WebSocket URL"
         end
 
-        host      = uri.host + (uri.port ? ":#{uri.port}" : '')
+        host      = uri.host + (uri.port ? ":#{ uri.port }" : '')
         path      = (uri.path == '') ? '/' : uri.path
         @pathname = path + (uri.query ? '?' + uri.query : '')
 
@@ -31,7 +31,7 @@ module WebSocket
         @headers['Upgrade']               = 'websocket'
         @headers['Connection']            = 'Upgrade'
         @headers['Sec-WebSocket-Key']     = @key
-        @headers['Sec-WebSocket-Version'] = '13'
+        @headers['Sec-WebSocket-Version'] = VERSION
 
         if @protocols.size > 0
           @headers['Sec-WebSocket-Protocol'] = @protocols * ', '
@@ -44,7 +44,7 @@ module WebSocket
       end
 
       def version
-        'hybi-13'
+        "hybi-#{ VERSION }"
       end
 
       def proxy(origin, options = {})
@@ -73,19 +73,19 @@ module WebSocket
         parse(@http.body)
       end
 
-    private 
+    private
 
       def handshake_request
         extensions = @extensions.generate_offer
         @headers['Sec-WebSocket-Extensions'] = extensions if extensions
 
-        start   = "GET #{@pathname} HTTP/1.1"
+        start   = "GET #{ @pathname } HTTP/1.1"
         headers = [start, @headers.to_s, '']
         headers.join("\r\n")
       end
 
       def fail_handshake(message)
-        message = "Error during WebSocket handshake: #{message}"
+        message = "Error during WebSocket handshake: #{ message }"
         @ready_state = 3
         emit(:error, ProtocolError.new(message))
         emit(:close, CloseEvent.new(ERRORS[:protocol_error], message))
@@ -96,7 +96,7 @@ module WebSocket
         @headers = Headers.new(@http.headers)
 
         unless @http.code == 101
-          return fail_handshake("Unexpected response code: #{@http.code}")
+          return fail_handshake("Unexpected response code: #{ @http.code }")
         end
 
         upgrade    = @http['Upgrade'] || ''

data/lib/websocket/driver/draft75.rb

@@ -56,7 +56,7 @@ module WebSocket
             when 2 then
               if octet == 0xFF
                 @stage = 0
-                emit(:message, MessageEvent.new(Driver.encode(@buffer, UNICODE)))
+                emit(:message, MessageEvent.new(Driver.encode(@buffer, Encoding::UTF_8)))
               else
                 if @length
                   @skipped += 1

data/lib/websocket/driver/draft76.rb

@@ -6,9 +6,10 @@ module WebSocket
 
       def initialize(socket, options = {})
         super
-        input  = @socket.env['rack.input']
+        input  = (@socket.env['rack.input'] || StringIO.new('')).read
+        input  = input.dup if input.frozen?
         @stage = -1
-        @body  = (input ? input.read : String.new('')).force_encoding(BINARY)
+        @body  = input.force_encoding(Encoding::BINARY)
 
         @headers.clear
         @headers['Upgrade'] = 'WebSocket'
@@ -29,7 +30,7 @@ module WebSocket
 
       def close(reason = nil, code = nil)
         return false if @ready_state == 3
-        @socket.write([0xFF, 0x00].pack('C*'))
+        @socket.write([0xFF, 0x00].pack('C*')) if @ready_state == 1
         @ready_state = 3
         emit(:close, CloseEvent.new(nil, nil))
         true
@@ -39,19 +40,20 @@ module WebSocket
 
       def handshake_response
         env     = @socket.env
-
         key1    = env['HTTP_SEC_WEBSOCKET_KEY1']
+        key2    = env['HTTP_SEC_WEBSOCKET_KEY2']
+
+        raise ProtocolError.new('Missing required header: Sec-WebSocket-Key1') unless key1
+        raise ProtocolError.new('Missing required header: Sec-WebSocket-Key2') unless key2
+
         number1 = number_from_key(key1)
         spaces1 = spaces_in_key(key1)
 
-        key2    = env['HTTP_SEC_WEBSOCKET_KEY2']
         number2 = number_from_key(key2)
         spaces2 = spaces_in_key(key2)
 
         if number1 % spaces1 != 0 or number2 % spaces2 != 0
-          emit(:error, ProtocolError.new('Client sent invalid Sec-WebSocket-Key headers'))
-          close
-          return nil
+          raise ProtocolError.new('Client sent invalid Sec-WebSocket-Key headers')
         end
 
         @key_values = [number1 / spaces1, number2 / spaces2]
@@ -84,7 +86,8 @@ module WebSocket
       end
 
       def number_from_key(key)
-        key.scan(/[0-9]/).join('').to_i(10)
+        number = key.scan(/[0-9]/).join('')
+        number == '' ? Float::NAN : number.to_i(10)
       end
 
       def spaces_in_key(key)

data/lib/websocket/driver/headers.rb

@@ -25,7 +25,7 @@ module WebSocket
         return if value.nil?
         key = HTTP.normalize_header(name)
         return unless @sent.add?(key) or ALLOWED_DUPLICATES.include?(key)
-        @lines << "#{name.strip}: #{value.to_s.strip}\r\n"
+        @lines << "#{ name.strip }: #{ value.to_s.strip }\r\n"
       end
 
       def inspect

data/lib/websocket/driver/hybi.rb

@@ -11,7 +11,8 @@ module WebSocket
         Base64.strict_encode64(Digest::SHA1.digest(key + GUID))
       end
 
-      GUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'
+      VERSION = '13'
+      GUID    = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'
 
       BYTE       = 0b11111111
       FIN = MASK = 0b10000000
@@ -51,7 +52,7 @@ module WebSocket
       MIN_RESERVED_ERROR = 3000
       MAX_RESERVED_ERROR = 4999
 
-      PACK_FORMATS = {2 => 'n', 8 => 'Q>'}
+      PACK_FORMATS = { 2 => 'S>', 8 => 'Q>' }
 
       def initialize(socket, options = {})
         super
@@ -68,22 +69,16 @@ module WebSocket
 
         return unless @socket.respond_to?(:env)
 
-        sec_key = @socket.env['HTTP_SEC_WEBSOCKET_KEY']
-        protos  = @socket.env['HTTP_SEC_WEBSOCKET_PROTOCOL']
-
-        @headers['Upgrade']              = 'websocket'
-        @headers['Connection']           = 'Upgrade'
-        @headers['Sec-WebSocket-Accept'] = Hybi.generate_accept(sec_key)
-
         if protos = @socket.env['HTTP_SEC_WEBSOCKET_PROTOCOL']
           protos = protos.split(/ *, */) if String === protos
           @protocol = protos.find { |p| @protocols.include?(p) }
-          @headers['Sec-WebSocket-Protocol'] = @protocol if @protocol
+        else
+          @protocol = nil
         end
       end
 
       def version
-        "hybi-#{@socket.env['HTTP_SEC_WEBSOCKET_VERSION']}"
+        "hybi-#{ VERSION }"
       end
 
       def add_extension(extension)
@@ -165,14 +160,13 @@ module WebSocket
 
         message = Message.new
         frame   = Frame.new
-        is_text = String === buffer
 
         message.rsv1   = message.rsv2 = message.rsv3 = false
-        message.opcode = OPCODES[type || (is_text ? :text : :binary)]
+        message.opcode = OPCODES[type || (String === buffer ? :text : :binary)]
 
-        payload = is_text ? buffer.bytes.to_a : buffer
-        payload = [code].pack(PACK_FORMATS[2]).bytes.to_a + payload if code
-        message.data = payload.pack('C*')
+        payload = Driver.encode(buffer, Encoding::BINARY)
+        payload = [code, payload].pack('S>a*') if code
+        message.data = payload
 
         if MESSAGE_OPCODES.include?(message.opcode)
           message = @extensions.process_outgoing_message(message)
@@ -199,43 +193,59 @@ module WebSocket
 
       def send_frame(frame)
         length = frame.length
-        buffer = []
+        values = []
+        format = 'C2'
         masked = frame.masked ? MASK : 0
 
-        buffer[0] = (frame.final ? FIN : 0) |
+        values[0] = (frame.final ? FIN : 0) |
                     (frame.rsv1 ? RSV1 : 0) |
                     (frame.rsv2 ? RSV2 : 0) |
                     (frame.rsv3 ? RSV3 : 0) |
                     frame.opcode
 
         if length <= 125
-          buffer[1] = masked | length
+          values[1] = masked | length
         elsif length <= 65535
-          buffer[1] = masked | 126
-          buffer[2..3] = [length].pack(PACK_FORMATS[2]).bytes.to_a
+          values[1] = masked | 126
+          values[2] = length
+          format << 'S>'
         else
-          buffer[1] = masked | 127
-          buffer[2..9] = [length].pack(PACK_FORMATS[8]).bytes.to_a
+          values[1] = masked | 127
+          values[2] = length
+          format << 'Q>'
         end
 
         if frame.masked
-          buffer.concat(frame.masking_key.bytes.to_a)
-          buffer.concat(Mask.mask(frame.payload, frame.masking_key).bytes.to_a)
+          values << frame.masking_key
+          values << Mask.mask(frame.payload, frame.masking_key)
+          format << 'a4a*'
         else
-          buffer.concat(frame.payload.bytes.to_a)
+          values << frame.payload
+          format << 'a*'
         end
 
-        @socket.write(buffer.pack('C*'))
+        @socket.write(values.pack(format))
       end
 
       def handshake_response
-        begin
-          extensions = @extensions.generate_response(@socket.env['HTTP_SEC_WEBSOCKET_EXTENSIONS'])
-        rescue => error
-          fail(:protocol_error, error.message)
-          return nil
+        sec_key = @socket.env['HTTP_SEC_WEBSOCKET_KEY']
+        version = @socket.env['HTTP_SEC_WEBSOCKET_VERSION']
+
+        unless version == VERSION
+          raise ProtocolError.new("Unsupported WebSocket version: #{ VERSION }")
+        end
+
+        unless sec_key
+          raise ProtocolError.new('Missing handshake request header: Sec-WebSocket-Key')
         end
 
+        @headers['Upgrade']              = 'websocket'
+        @headers['Connection']           = 'Upgrade'
+        @headers['Sec-WebSocket-Accept'] = Hybi.generate_accept(sec_key)
+
+        @headers['Sec-WebSocket-Protocol'] = @protocol if @protocol
+
+        extensions = @extensions.generate_response(@socket.env['HTTP_SEC_WEBSOCKET_EXTENSIONS'])
         @headers['Sec-WebSocket-Extensions'] = extensions if extensions
 
         start   = 'HTTP/1.1 101 Switching Protocols'
@@ -275,17 +285,17 @@ module WebSocket
 
         unless @extensions.valid_frame_rsv?(@frame)
           return fail(:protocol_error,
-              "One or more reserved bits are on: reserved1 = #{@frame.rsv1 ? 1 : 0}" +
-              ", reserved2 = #{@frame.rsv2 ? 1 : 0 }" +
-              ", reserved3 = #{@frame.rsv3 ? 1 : 0 }")
+              "One or more reserved bits are on: reserved1 = #{ @frame.rsv1 ? 1 : 0 }" +
+              ", reserved2 = #{ @frame.rsv2 ? 1 : 0 }" +
+              ", reserved3 = #{ @frame.rsv3 ? 1 : 0 }")
         end
 
         unless OPCODES.values.include?(@frame.opcode)
-          return fail(:protocol_error, "Unrecognized frame opcode: #{@frame.opcode}")
+          return fail(:protocol_error, "Unrecognized frame opcode: #{ @frame.opcode }")
         end
 
         unless MESSAGE_OPCODES.include?(@frame.opcode) or @frame.final
-          return fail(:protocol_error, "Received fragmented control frame: opcode = #{@frame.opcode}")
+          return fail(:protocol_error, "Received fragmented control frame: opcode = #{ @frame.opcode }")
         end
 
         if @message and OPENING_OPCODES.include?(@frame.opcode)
@@ -315,7 +325,7 @@ module WebSocket
         @stage = @frame.masked ? 3 : 4
 
         unless MESSAGE_OPCODES.include?(@frame.opcode) or @frame.length <= 125
-          return fail(:protocol_error, "Received control frame having too long payload: #{@frame.length}")
+          return fail(:protocol_error, "Received control frame having too long payload: #{ @frame.length }")
         end
 
         return unless check_frame_length
@@ -337,7 +347,6 @@ module WebSocket
         opcode   = frame.opcode
         payload  = frame.payload = Mask.mask(buffer, @frame.masking_key)
         bytesize = payload.bytesize
-        bytes    = payload.bytes.to_a
 
         @frame = nil
 
@@ -351,8 +360,8 @@ module WebSocket
             @message << frame
 
           when OPCODES[:close] then
-            code   = (bytesize >= 2) ? payload.unpack(PACK_FORMATS[2]).first : nil
-            reason = (bytesize > 2)  ? Driver.encode(bytes[2..-1] || [], UNICODE) : nil
+            code, reason = payload.unpack('S>a*') if bytesize >= 2
+            reason = Driver.encode(reason || '', Encoding::UTF_8)
 
             unless (bytesize == 0) or
                    (code && code >= MIN_RESERVED_ERROR && code <= MAX_RESERVED_ERROR) or
@@ -360,7 +369,7 @@ module WebSocket
               code = ERRORS[:protocol_error]
             end
 
-            if bytesize > 125 or (bytesize > 2 and reason.nil?)
+            if bytesize > 125 or !reason.valid_encoding?
               code = ERRORS[:protocol_error]
             end
 
@@ -368,12 +377,14 @@ module WebSocket
 
           when OPCODES[:ping] then
             frame(payload, :pong)
+            emit(:ping, PingEvent.new(payload))
 
           when OPCODES[:pong] then
-            message = Driver.encode(payload, UNICODE)
+            message = Driver.encode(payload, Encoding::UTF_8)
             callback = @ping_callbacks[message]
             @ping_callbacks.delete(message)
             callback.call if callback
+            emit(:pong, PongEvent.new(payload))
         end
 
         emit_message if frame.final and MESSAGE_OPCODES.include?(opcode)
@@ -387,7 +398,8 @@ module WebSocket
 
         case message.opcode
           when OPCODES[:text] then
-            payload = Driver.encode(payload, UNICODE)
+            payload = Driver.encode(payload, Encoding::UTF_8)
+            payload = nil unless payload.valid_encoding?
           when OPCODES[:binary]
             payload = payload.bytes.to_a
         end