2011-09-26 14:51:15 +02:00
|
|
|
/*
|
2012-06-04 22:31:44 +02:00
|
|
|
* Copyright 2012 The Netty Project
|
2011-09-26 14:51:15 +02:00
|
|
|
*
|
2011-12-09 06:18:34 +01:00
|
|
|
* The Netty Project 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:
|
2011-09-26 14:51:15 +02:00
|
|
|
*
|
2012-06-04 22:31:44 +02:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2011-09-26 14:51:15 +02:00
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
2011-12-09 06:18:34 +01:00
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
2011-09-26 14:51:15 +02:00
|
|
|
* License for the specific language governing permissions and limitations
|
|
|
|
* under the License.
|
|
|
|
*/
|
2011-12-09 04:38:59 +01:00
|
|
|
package io.netty.handler.codec.http.websocketx;
|
2011-09-26 14:51:15 +02:00
|
|
|
|
2012-06-10 04:08:43 +02:00
|
|
|
import io.netty.buffer.ByteBuf;
|
2012-06-07 07:52:33 +02:00
|
|
|
import io.netty.channel.ChannelHandlerContext;
|
2012-05-17 05:37:37 +02:00
|
|
|
import io.netty.handler.codec.ReplayingDecoder;
|
2012-05-16 16:02:06 +02:00
|
|
|
import io.netty.handler.codec.TooLongFrameException;
|
2011-09-26 14:51:15 +02:00
|
|
|
|
|
|
|
/**
|
2012-06-10 04:08:43 +02:00
|
|
|
* Decodes {@link ByteBuf}s into {@link WebSocketFrame}s.
|
2011-09-26 14:51:15 +02:00
|
|
|
* <p>
|
2011-12-15 06:09:09 +01:00
|
|
|
* For the detailed instruction on adding add Web Socket support to your HTTP server, take a look into the
|
|
|
|
* <tt>WebSocketServer</tt> example located in the {@code io.netty.example.http.websocket} package.
|
2012-05-23 20:42:10 +02:00
|
|
|
*
|
2011-09-26 14:51:15 +02:00
|
|
|
* @apiviz.landmark
|
2011-12-09 04:38:59 +01:00
|
|
|
* @apiviz.uses io.netty.handler.codec.http.websocket.WebSocketFrame
|
2011-09-26 14:51:15 +02:00
|
|
|
*/
|
2013-01-08 08:18:46 +01:00
|
|
|
public class WebSocket00FrameDecoder extends ReplayingDecoder<Void> {
|
2011-09-26 14:51:15 +02:00
|
|
|
|
2012-05-31 02:21:51 +02:00
|
|
|
static final int DEFAULT_MAX_FRAME_SIZE = 16384;
|
2011-12-15 12:25:40 +01:00
|
|
|
|
2012-05-31 02:13:00 +02:00
|
|
|
private final long maxFrameSize;
|
2011-12-15 12:25:40 +01:00
|
|
|
private boolean receivedClosingHandshake;
|
|
|
|
|
|
|
|
public WebSocket00FrameDecoder() {
|
|
|
|
this(DEFAULT_MAX_FRAME_SIZE);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a new instance of {@code WebSocketFrameDecoder} with the specified {@code maxFrameSize}. If the client
|
|
|
|
* sends a frame size larger than {@code maxFrameSize}, the channel will be closed.
|
2012-05-23 20:42:10 +02:00
|
|
|
*
|
2011-12-15 12:25:40 +01:00
|
|
|
* @param maxFrameSize
|
|
|
|
* the maximum frame size to decode
|
|
|
|
*/
|
2012-05-31 02:21:51 +02:00
|
|
|
public WebSocket00FrameDecoder(int maxFrameSize) {
|
2011-12-15 12:25:40 +01:00
|
|
|
this.maxFrameSize = maxFrameSize;
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
2013-01-08 08:18:46 +01:00
|
|
|
public Object decode(ChannelHandlerContext ctx, ByteBuf in) throws Exception {
|
2011-12-15 12:25:40 +01:00
|
|
|
// Discard all data received if closing handshake was received before.
|
|
|
|
if (receivedClosingHandshake) {
|
2012-05-23 20:42:10 +02:00
|
|
|
in.skipBytes(actualReadableBytes());
|
2011-12-15 12:25:40 +01:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Decode a frame otherwise.
|
2012-05-23 20:42:10 +02:00
|
|
|
byte type = in.readByte();
|
2011-12-15 12:25:40 +01:00
|
|
|
if ((type & 0x80) == 0x80) {
|
|
|
|
// If the MSB on type is set, decode the frame length
|
2012-05-23 20:42:10 +02:00
|
|
|
return decodeBinaryFrame(type, in);
|
2011-12-15 12:25:40 +01:00
|
|
|
} else {
|
|
|
|
// Decode a 0xff terminated UTF-8 string
|
2012-05-23 20:42:10 +02:00
|
|
|
return decodeTextFrame(in);
|
2011-12-15 12:25:40 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-11-09 23:07:37 +01:00
|
|
|
private WebSocketFrame decodeBinaryFrame(byte type, ByteBuf buffer) {
|
2011-12-15 12:25:40 +01:00
|
|
|
long frameSize = 0;
|
|
|
|
int lengthFieldSize = 0;
|
|
|
|
byte b;
|
|
|
|
do {
|
|
|
|
b = buffer.readByte();
|
|
|
|
frameSize <<= 7;
|
|
|
|
frameSize |= b & 0x7f;
|
|
|
|
if (frameSize > maxFrameSize) {
|
|
|
|
throw new TooLongFrameException();
|
|
|
|
}
|
|
|
|
lengthFieldSize++;
|
|
|
|
if (lengthFieldSize > 8) {
|
|
|
|
// Perhaps a malicious peer?
|
|
|
|
throw new TooLongFrameException();
|
|
|
|
}
|
|
|
|
} while ((b & 0x80) == 0x80);
|
|
|
|
|
2012-01-19 05:12:45 +01:00
|
|
|
if (type == (byte) 0xFF && frameSize == 0) {
|
2011-12-15 12:25:40 +01:00
|
|
|
receivedClosingHandshake = true;
|
|
|
|
return new CloseWebSocketFrame();
|
|
|
|
}
|
|
|
|
|
|
|
|
return new BinaryWebSocketFrame(buffer.readBytes((int) frameSize));
|
|
|
|
}
|
|
|
|
|
2012-11-09 23:07:37 +01:00
|
|
|
private WebSocketFrame decodeTextFrame(ByteBuf buffer) {
|
2011-12-15 12:25:40 +01:00
|
|
|
int ridx = buffer.readerIndex();
|
|
|
|
int rbytes = actualReadableBytes();
|
|
|
|
int delimPos = buffer.indexOf(ridx, ridx + rbytes, (byte) 0xFF);
|
|
|
|
if (delimPos == -1) {
|
|
|
|
// Frame delimiter (0xFF) not found
|
|
|
|
if (rbytes > maxFrameSize) {
|
|
|
|
// Frame length exceeded the maximum
|
|
|
|
throw new TooLongFrameException();
|
|
|
|
} else {
|
|
|
|
// Wait until more data is received
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
int frameSize = delimPos - ridx;
|
|
|
|
if (frameSize > maxFrameSize) {
|
|
|
|
throw new TooLongFrameException();
|
|
|
|
}
|
|
|
|
|
2012-06-10 04:08:43 +02:00
|
|
|
ByteBuf binaryData = buffer.readBytes(frameSize);
|
2011-12-15 12:25:40 +01:00
|
|
|
buffer.skipBytes(1);
|
|
|
|
|
|
|
|
int ffDelimPos = binaryData.indexOf(binaryData.readerIndex(), binaryData.writerIndex(), (byte) 0xFF);
|
|
|
|
if (ffDelimPos >= 0) {
|
|
|
|
throw new IllegalArgumentException("a text frame should not contain 0xFF.");
|
|
|
|
}
|
|
|
|
|
|
|
|
return new TextWebSocketFrame(binaryData);
|
|
|
|
}
|
2011-09-26 14:51:15 +02:00
|
|
|
}
|