2009-12-07 Fumitoshi Ukai <ukai@chromium.org>
[WebKit-https.git] / WebCore / websockets / WebSocketHandshake.h
1 /*
2  * Copyright (C) 2009 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 WebSocketHandshake_h
32 #define WebSocketHandshake_h
33
34 #if ENABLE(WEB_SOCKETS)
35
36 #include "KURL.h"
37 #include "PlatformString.h"
38 #include <wtf/Noncopyable.h>
39
40 namespace WebCore {
41
42     class ScriptExecutionContext;
43     class HTTPHeaderMap;
44
45     class WebSocketHandshake : public Noncopyable {
46     public:
47         enum Mode {
48             Incomplete, Normal, Failed, Connected
49         };
50         WebSocketHandshake(const KURL&, const String& protocol, ScriptExecutionContext*);
51         ~WebSocketHandshake();
52
53         const KURL& url() const;
54         void setURL(const KURL&);
55         const String host() const;
56
57         const String& clientProtocol() const;
58         void setClientProtocol(const String& protocol);
59
60         bool secure() const;
61         void setSecure(bool secure);
62
63         String clientOrigin() const;
64         String clientLocation() const;
65
66         CString clientHandshakeMessage() const;
67
68         void reset();
69
70         int readServerHandshake(const char* header, size_t len);
71         Mode mode() const;
72
73         const String& serverWebSocketOrigin() const;
74         void setServerWebSocketOrigin(const String& webSocketOrigin);
75
76         const String& serverWebSocketLocation() const;
77         void setServerWebSocketLocation(const String& webSocketLocation);
78
79         const String& serverWebSocketProtocol() const;
80         void setServerWebSocketProtocol(const String& webSocketProtocol);
81
82         const String& serverSetCookie() const;
83         void setServerSetCookie(const String& setCookie);
84         const String& serverSetCookie2() const;
85         void setServerSetCookie2(const String& setCookie2);
86
87     private:
88         KURL httpURLForAuthenticationAndCookies() const;
89
90         // Reads all headers except for the two predefined ones.
91         const char* readHTTPHeaders(const char* start, const char* end, HTTPHeaderMap* headers);
92         bool processHeaders(const HTTPHeaderMap& headers);
93         void checkResponseHeaders();
94
95         KURL m_url;
96         String m_clientProtocol;
97         bool m_secure;
98         ScriptExecutionContext* m_context;
99
100         Mode m_mode;
101
102         String m_wsOrigin;
103         String m_wsLocation;
104         String m_wsProtocol;
105         String m_setCookie;
106         String m_setCookie2;
107     };
108
109 }  // namespace WebCore
110
111 #endif  // ENABLE(WEB_SOCKETS)
112
113 #endif  // WebSocketHandshake_h