WebSocket: Remove hixie76 protocol implementation
[WebKit-https.git] / Source / WebCore / Modules / websockets / WebSocketChannel.h
1 /*
2  * Copyright (C) 2011, 2012 Google Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebSocketChannel_h
32 #define WebSocketChannel_h
33
34 #if ENABLE(WEB_SOCKETS)
35
36 #include "FileReaderLoaderClient.h"
37 #include "SocketStreamHandleClient.h"
38 #include "ThreadableWebSocketChannel.h"
39 #include "Timer.h"
40 #include "WebSocketDeflateFramer.h"
41 #include "WebSocketFrame.h"
42 #include "WebSocketHandshake.h"
43 #include <wtf/Deque.h>
44 #include <wtf/Forward.h>
45 #include <wtf/RefCounted.h>
46 #include <wtf/Vector.h>
47 #include <wtf/text/CString.h>
48
49 namespace WebCore {
50
51 class Blob;
52 class Document;
53 class FileReaderLoader;
54 class SocketStreamHandle;
55 class SocketStreamError;
56 class WebSocketChannelClient;
57
58 class WebSocketChannel : public RefCounted<WebSocketChannel>, public SocketStreamHandleClient, public ThreadableWebSocketChannel
59 #if ENABLE(BLOB)
60                        , public FileReaderLoaderClient
61 #endif
62 {
63     WTF_MAKE_FAST_ALLOCATED;
64 public:
65     static PassRefPtr<WebSocketChannel> create(Document* document, WebSocketChannelClient* client) { return adoptRef(new WebSocketChannel(document, client)); }
66     virtual ~WebSocketChannel();
67
68     bool send(const char* data, int length);
69
70     // ThreadableWebSocketChannel functions.
71     virtual void connect(const KURL&, const String& protocol) OVERRIDE;
72     virtual String subprotocol() OVERRIDE;
73     virtual String extensions() OVERRIDE;
74     virtual ThreadableWebSocketChannel::SendResult send(const String& message) OVERRIDE;
75     virtual ThreadableWebSocketChannel::SendResult send(const ArrayBuffer&) OVERRIDE;
76     virtual ThreadableWebSocketChannel::SendResult send(const Blob&) OVERRIDE;
77     virtual unsigned long bufferedAmount() const OVERRIDE;
78     virtual void close(int code, const String& reason) OVERRIDE; // Start closing handshake.
79     virtual void fail(const String& reason) OVERRIDE;
80     virtual void disconnect() OVERRIDE;
81
82     virtual void suspend() OVERRIDE;
83     virtual void resume() OVERRIDE;
84
85     // SocketStreamHandleClient functions.
86     virtual void willOpenSocketStream(SocketStreamHandle*) OVERRIDE;
87     virtual void didOpenSocketStream(SocketStreamHandle*) OVERRIDE;
88     virtual void didCloseSocketStream(SocketStreamHandle*) OVERRIDE;
89     virtual void didReceiveSocketStreamData(SocketStreamHandle*, const char*, int) OVERRIDE;
90     virtual void didUpdateBufferedAmount(SocketStreamHandle*, size_t bufferedAmount) OVERRIDE;
91     virtual void didFailSocketStream(SocketStreamHandle*, const SocketStreamError&) OVERRIDE;
92     virtual void didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&) OVERRIDE;
93     virtual void didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&) OVERRIDE;
94
95     enum CloseEventCode {
96         CloseEventCodeNotSpecified = -1,
97         CloseEventCodeNormalClosure = 1000,
98         CloseEventCodeGoingAway = 1001,
99         CloseEventCodeProtocolError = 1002,
100         CloseEventCodeUnsupportedData = 1003,
101         CloseEventCodeFrameTooLarge = 1004,
102         CloseEventCodeNoStatusRcvd = 1005,
103         CloseEventCodeAbnormalClosure = 1006,
104         CloseEventCodeInvalidFramePayloadData = 1007,
105         CloseEventCodePolicyViolation = 1008,
106         CloseEventCodeMessageTooBig = 1009,
107         CloseEventCodeMandatoryExt = 1010,
108         CloseEventCodeInternalError = 1011,
109         CloseEventCodeTLSHandshake = 1015,
110         CloseEventCodeMinimumUserDefined = 3000,
111         CloseEventCodeMaximumUserDefined = 4999
112     };
113
114 #if ENABLE(BLOB)
115     // FileReaderLoaderClient functions.
116     virtual void didStartLoading();
117     virtual void didReceiveData();
118     virtual void didFinishLoading();
119     virtual void didFail(int errorCode);
120 #endif
121
122     using RefCounted<WebSocketChannel>::ref;
123     using RefCounted<WebSocketChannel>::deref;
124
125 protected:
126     virtual void refThreadableWebSocketChannel() { ref(); }
127     virtual void derefThreadableWebSocketChannel() { deref(); }
128
129 private:
130     WebSocketChannel(Document*, WebSocketChannelClient*);
131
132     bool appendToBuffer(const char* data, size_t len);
133     void skipBuffer(size_t len);
134     bool processBuffer();
135     void resumeTimerFired(Timer<WebSocketChannel>*);
136     void startClosingHandshake(int code, const String& reason);
137     void closingTimerFired(Timer<WebSocketChannel>*);
138
139     bool processFrame();
140
141     // It is allowed to send a Blob as a binary frame if hybi-10 protocol is in use. Sending a Blob
142     // can be delayed because it must be read asynchronously. Other types of data (String or
143     // ArrayBuffer) may also be blocked by preceding sending request of a Blob.
144     //
145     // To address this situation, messages to be sent need to be stored in a queue. Whenever a new
146     // data frame is going to be sent, it first must go to the queue. Items in the queue are processed
147     // in the order they were put into the queue. Sending request of a Blob blocks further processing
148     // until the Blob is completely read and sent to the socket stream.
149     enum QueuedFrameType {
150         QueuedFrameTypeString,
151         QueuedFrameTypeVector,
152         QueuedFrameTypeBlob
153     };
154     struct QueuedFrame {
155         WebSocketFrame::OpCode opCode;
156         QueuedFrameType frameType;
157         // Only one of the following items is used, according to the value of frameType.
158         CString stringData;
159         Vector<char> vectorData;
160         RefPtr<Blob> blobData;
161     };
162     void enqueueTextFrame(const CString&);
163     void enqueueRawFrame(WebSocketFrame::OpCode, const char* data, size_t dataLength);
164     void enqueueBlobFrame(WebSocketFrame::OpCode, const Blob&);
165
166     void processOutgoingFrameQueue();
167     void abortOutgoingFrameQueue();
168
169     enum OutgoingFrameQueueStatus {
170         // It is allowed to put a new item into the queue.
171         OutgoingFrameQueueOpen,
172         // Close frame has already been put into the queue but may not have been sent yet;
173         // m_handle->close() will be called as soon as the queue is cleared. It is not
174         // allowed to put a new item into the queue.
175         OutgoingFrameQueueClosing,
176         // Close frame has been sent or the queue was aborted. It is not allowed to put
177         // a new item to the queue.
178         OutgoingFrameQueueClosed
179     };
180
181     // If you are going to send a hybi-10 frame, you need to use the outgoing frame queue
182     // instead of call sendFrame() directly.
183     bool sendFrame(WebSocketFrame::OpCode, const char* data, size_t dataLength);
184
185 #if ENABLE(BLOB)
186     enum BlobLoaderStatus {
187         BlobLoaderNotStarted,
188         BlobLoaderStarted,
189         BlobLoaderFinished,
190         BlobLoaderFailed
191     };
192 #endif
193
194     Document* m_document;
195     WebSocketChannelClient* m_client;
196     OwnPtr<WebSocketHandshake> m_handshake;
197     RefPtr<SocketStreamHandle> m_handle;
198     char* m_buffer;
199     size_t m_bufferSize;
200
201     Timer<WebSocketChannel> m_resumeTimer;
202     bool m_suspended;
203     bool m_closing;
204     bool m_receivedClosingHandshake;
205     Timer<WebSocketChannel> m_closingTimer;
206     bool m_closed;
207     bool m_shouldDiscardReceivedData;
208     unsigned long m_unhandledBufferedAmount;
209
210     unsigned long m_identifier; // m_identifier == 0 means that we could not obtain a valid identifier.
211
212     // Private members only for hybi-10 protocol.
213     bool m_hasContinuousFrame;
214     WebSocketFrame::OpCode m_continuousFrameOpCode;
215     Vector<char> m_continuousFrameData;
216     unsigned short m_closeEventCode;
217     String m_closeEventReason;
218
219     Deque<OwnPtr<QueuedFrame> > m_outgoingFrameQueue;
220     OutgoingFrameQueueStatus m_outgoingFrameQueueStatus;
221
222 #if ENABLE(BLOB)
223     // FIXME: Load two or more Blobs simultaneously for better performance.
224     OwnPtr<FileReaderLoader> m_blobLoader;
225     BlobLoaderStatus m_blobLoaderStatus;
226 #endif
227
228     WebSocketDeflateFramer m_deflateFramer;
229 };
230
231 } // namespace WebCore
232
233 #endif // ENABLE(WEB_SOCKETS)
234
235 #endif // WebSocketChannel_h