/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* vim: set sw=2 ts=8 et tw=80 : */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (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.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is * Wellington Fernando de Macedo. * Portions created by the Initial Developer are Copyright (C) 2009 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Wellington Fernando de Macedo (original author) * * Alternatively, the contents of this file may be used under the terms of * either of the GNU General Public License Version 2 or later (the "GPL"), * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #include "nsWebSocket.h" #include "nsIScriptGlobalObject.h" #include "nsIDOMWindow.h" #include "nsIDocument.h" #include "nsXPCOM.h" #include "nsIXPConnect.h" #include "nsContentUtils.h" #include "nsEventDispatcher.h" #include "nsDOMError.h" #include "nsIScriptObjectPrincipal.h" #include "nsIDOMClassInfo.h" #include "nsDOMClassInfo.h" #include "jsapi.h" #include "nsNetUtil.h" #include "nsIStandardURL.h" #include "nsIURL.h" #include "nsIPrivateDOMEvent.h" #include "nsISocketTransportService.h" #include "nsIProtocolProxyCallback.h" #include "nsISocketTransport.h" #include "nsIAsyncInputStream.h" #include "nsIAsyncOutputStream.h" #include "nsICancelable.h" #include "nsIInterfaceRequestor.h" #include "nsISSLSocketControl.h" #include "nsISocketProviderService.h" #include "nsIProtocolProxyService2.h" #include "nsISocketProvider.h" #include "nsDeque.h" #include "nsICookieService.h" #include "nsICharsetConverterManager.h" #include "nsIUnicodeEncoder.h" #include "nsThreadUtils.h" #include "nsIDOMDocumentEvent.h" #include "nsIDOMMessageEvent.h" #include "nsIStandardURL.h" #include "nsIPromptFactory.h" #include "nsIWindowWatcher.h" #include "nsIPrompt.h" #include "nsIStringBundle.h" #include "nsIConsoleService.h" #include "nsITimer.h" #include "nsIDNSListener.h" #include "nsIDNSRecord.h" #include "nsIDNSService.h" #include "nsLayoutStatics.h" #include "nsIHttpAuthenticableChannel.h" #include "nsIHttpChannelAuthProvider.h" #include "mozilla/Mutex.h" #include "nsIDOMCloseEvent.h" #include "nsICryptoHash.h" using namespace mozilla; static nsIThread *gWebSocketThread = nsnull; //////////////////////////////////////////////////////////////////////////////// // nsWebSocketEstablishedConnection //////////////////////////////////////////////////////////////////////////////// #define DEFAULT_BUFFER_SIZE 2048 #define UTF_8_REPLACEMENT_CHAR static_cast(0xFFFD) #define TIMEOUT_TRY_CONNECT_AGAIN 1000 #define TIMEOUT_WAIT_FOR_SERVER_RESPONSE 20000 #define TIMEOUT_WAIT_FOR_CLOSING 5000 #define ENSURE_TRUE_AND_FAIL_IF_FAILED(x, ret) \ PR_BEGIN_MACRO \ if (NS_UNLIKELY(!(x))) { \ NS_WARNING("ENSURE_TRUE_AND_FAIL_IF_FAILED(" #x ") failed"); \ FailConnection(); \ return ret; \ } \ PR_END_MACRO #define ENSURE_SUCCESS_AND_FAIL_IF_FAILED(res, ret) \ PR_BEGIN_MACRO \ nsresult __rv = res; \ if (NS_FAILED(__rv)) { \ NS_ENSURE_SUCCESS_BODY(res, ret) \ FailConnection(); \ return ret; \ } \ PR_END_MACRO #define CHECK_TRUE_AND_FAIL_IF_FAILED(x) \ PR_BEGIN_MACRO \ if (NS_UNLIKELY(!(x))) { \ NS_WARNING("CHECK_TRUE_AND_FAIL_IF_FAILED(" #x ") failed"); \ FailConnection(); \ return; \ } \ PR_END_MACRO #define CHECK_SUCCESS_AND_FAIL_IF_FAILED(res) \ PR_BEGIN_MACRO \ nsresult __rv = res; \ if (NS_FAILED(__rv)) { \ NS_ENSURE_SUCCESS_BODY(res, ret) \ FailConnection(); \ return; \ } \ PR_END_MACRO #define CHECK_SUCCESS_AND_FAIL_IF_FAILED2(res) \ PR_BEGIN_MACRO \ nsresult __rv = res; \ if (NS_FAILED(__rv)) { \ NS_ENSURE_SUCCESS_BODY(res, ret) \ thisObject->FailConnection(); \ return; \ } \ PR_END_MACRO #define WARN_IF_FALSE_AND_RETURN(_expr, _msg) \ if (!(_expr)) { \ NS_WARNING(_msg); \ return; \ } #define DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(_method) \ nsresult _method(); \ void MainRunnable##_method(); #define IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(_method) \ nsresult \ nsWebSocketEstablishedConnection::_method() \ { \ if (!NS_IsMainThread()) { \ nsCOMPtr event = \ NS_NewRunnableMethod(this, &nsWebSocketEstablishedConnection:: \ MainRunnable##_method); \ if (!event) { \ return NS_ERROR_OUT_OF_MEMORY; \ } \ return NS_DispatchToMainThread(event, NS_DISPATCH_NORMAL); \ } \ MainRunnable##_method(); \ return NS_OK; \ } \ \ void \ nsWebSocketEstablishedConnection::MainRunnable##_method() \ { \ if (!mOwner) { \ return; \ } #define IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END \ } // protocol specific #define IS_HIGH_BIT_OF_FRAME_TYPE_SET(_v) ((_v & 0x80) == 0x80) #define IS_HIGH_BIT_OF_BYTE_SET(_v) ((_v & 0x80) == 0x80) #define START_BYTE_OF_MESSAGE 0x00 #define END_BYTE_OF_MESSAGE 0xff #define START_BYTE_OF_CLOSE_FRAME 0xff #define END_BYTE_OF_CLOSE_FRAME 0x00 // nsIInterfaceRequestor will be the unambiguous class for this class class nsWebSocketEstablishedConnection: public nsIInterfaceRequestor, public nsIDNSListener, public nsIProtocolProxyCallback, public nsIInputStreamCallback, public nsIOutputStreamCallback, public nsIChannel, public nsIHttpAuthenticableChannel { friend class nsWSNetAddressComparator; friend class nsWSAutoClose; public: nsWebSocketEstablishedConnection(); virtual ~nsWebSocketEstablishedConnection(); NS_DECL_ISUPPORTS NS_DECL_NSIDNSLISTENER NS_DECL_NSIPROTOCOLPROXYCALLBACK NS_DECL_NSIINPUTSTREAMCALLBACK NS_DECL_NSIOUTPUTSTREAMCALLBACK NS_DECL_NSIINTERFACEREQUESTOR NS_DECL_NSIREQUEST NS_DECL_NSICHANNEL NS_DECL_NSIPROXIEDCHANNEL // nsIHttpAuthenticableChannel. // We can't use NS_DECL_NSIHTTPAUTHENTICABLECHANNEL because it duplicates // cancel() and others. NS_IMETHOD GetRequestMethod(nsACString &method); NS_IMETHOD GetIsSSL(PRBool *aIsSSL); NS_IMETHOD GetProxyMethodIsConnect(PRBool *aProxyMethodIsConnect); NS_IMETHOD GetServerResponseHeader(nsACString & aServerResponseHeader); NS_IMETHOD GetProxyChallenges(nsACString & aChallenges); NS_IMETHOD GetWWWChallenges(nsACString & aChallenges); NS_IMETHOD SetProxyCredentials(const nsACString & aCredentials); NS_IMETHOD SetWWWCredentials(const nsACString & aCredentials); NS_IMETHOD OnAuthAvailable(); NS_IMETHOD OnAuthCancelled(PRBool userCancel); nsresult Init(nsWebSocket *aOwner); nsresult Disconnect(); // these are called always on the main thread (they dispatch themselves) DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(Close) DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(FailConnection) PRBool ClosedCleanly() { return mClosedCleanly; } nsresult PostMessage(const nsString& aMessage); PRUint32 GetOutgoingBufferedAmount() { return mOutgoingBufferedAmount; } // prevent more than one instance from connecting at a time per IP static nsTArray >* sWSsConnecting; private: // We can only establish one connection at a time per IP address. // TryConnect ensures this by checking sWSsConnecting. // If there is a IP address entry there it tries again after // TIMEOUT_TRY_CONNECT_AGAIN milliseconds. static void TryConnect(nsITimer *aTimer, void *aClosure); // We wait for the initial server response for // TIMEOUT_WAIT_FOR_SERVER_RESPONSE milliseconds static void TimerInitialServerResponseCallback(nsITimer *aTimer, void *aClosure); // We wait TIMEOUT_WAIT_FOR_CLOSING milliseconds to the connection be closed // after setting the readyState to CLOSING. static void TimerForceCloseCallback(nsITimer *aTimer, void *aClosure); // Similar to the Close method, but this one neither sends the close frame // nor expects the connection to be closed (mStatus == CONN_CLOSED) to // disconnect. void ForceClose(); nsresult DoConnect(); nsresult HandleNewInputString(PRUint32 aStart); nsresult AddAuthorizationHeaders(nsCString& aAuthHeaderStr, PRBool aIsProxyAuth); nsresult AddCookiesToRequest(nsCString& aAuthHeaderStr); // Returns the related number of the generated key. PRUint32 GenerateSecKey(nsCString& aKey); nsresult GenerateRequestKeys(nsCString& aKey1, nsCString& aKey2, nsCString& aKey3); PRBool UsingHttpProxy(); nsresult Reset(); void RemoveFromLoadGroup(); nsresult ProcessHeaders(); nsresult PostData(nsCString *aBuffer, PRBool aIsMessage); nsresult PrintErrorOnConsole(const char *aBundleURI, const PRUnichar *aError, const PRUnichar **aFormatStrings, PRUint32 aFormatStringsLen); PRBool SentAlreadyTheCloseFrame() { return mPostedCloseFrame && mOutgoingMessages.GetSize() == 0; } // auth specific methods DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(ProcessAuthentication) // these are called always on the main thread (they dispatch themselves) DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(AddWSConnecting) DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(RemoveWSConnecting) DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(HandleSetCookieHeader) DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(DoInitialRequest) DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(Connected) DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(FrameError) DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(DispatchNewMessage) DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(Retry) DECL_RUNNABLE_ON_MAIN_THREAD_METHOD(ResolveNextProxyAndConnect) // called to cause the underlying socket to start speaking SSL nsresult ProxyStartSSL(); // shared by both threads (the main and the socket ones) Mutex mLockDisconnect; Mutex mLockOutgoingMessages; Mutex mLockReceivedMessages; nsCOMPtr mSocketTransport; nsCOMPtr mSocketInput; nsCOMPtr mSocketOutput; nsCOMPtr mProxyInfo; nsDeque mOutgoingMessages; // has nsCString* which need to be sent PRUint32 mBytesAlreadySentOfFirstOutString; PRUint32 mOutgoingBufferedAmount; // not really necessary, but it is // here for fast access. nsDeque mReceivedMessages; // has nsCString* messages that need // to be dispatched as message events nsCString mExpectedMD5Challenge; nsWebSocket* mOwner; // WEAK // used in mHeaders enum { kUpgradePos = 0, kConnectionPos, kSecWebSocketOriginPos, kSecWebSocketLocationPos, kSecWebSocketProtocolPos, kSetCookiePos, kProxyAuthenticatePos, kServerPos, // for digest auth kHeadersLen }; // used only by the socket thread nsCString mBuffer; PRUint32 mBytesInBuffer; // it is needed because mBuffer.SetLength() does // change also the buffer's Capacity. nsCString mHeaders[kHeadersLen]; PRUint32 mLengthToDiscard; PRPackedBool mReadingProxyConnectResponse; // WebSockets should resolve proxy in this order: // (1) socks, (2) https, (3) http enum ProxyConfig { eNotResolvingProxy, eResolvingSOCKSProxy, eResolvingHTTPSProxy, eResolvingHTTPProxy, eResolvingProxyFailed }; ProxyConfig mCurrentProxyConfig; nsresult mProxyFailureReason; nsCOMPtr mProxyResolveCancelable; nsCOMPtr mDNSRequest; PRNetAddr mPRNetAddr; nsCOMPtr mTryConnectTimer; nsCOMPtr mInitialServerResponseTimer; nsCOMPtr mCloseFrameServerResponseTimer; // for nsIRequest implementation nsCString mRequestName; nsresult mFailureStatus; // auth specific data nsCString mProxyCredentials; nsCString mCredentials; nsCOMPtr mAuthProvider; PRPackedBool mAuthenticating; PRPackedBool mPostedCloseFrame; PRPackedBool mClosedCleanly; /** * A simple state machine used to manage the flow status of the input/output * streams of the connection. * * CONN_NOT_CONNECTED (initial state) -> * CONN_CONNECTING | * CONN_CLOSED * * CONN_CONNECTING -> * CONN_CONNECTING_TO_HTTP_PROXY | * CONN_SENDING_INITIAL_REQUEST | * CONN_CLOSED * * CONN_RETRYING_TO_AUTHENTICATE -> * CONN_CONNECTING_TO_HTTP_PROXY | * CONN_SENDING_INITIAL_REQUEST | * CONN_CLOSED * * CONN_CONNECTING_TO_HTTP_PROXY -> * CONN_READING_FIRST_CHAR_OF_RESPONSE_HEADER_NAME | * CONN_CLOSED * * CONN_SENDING_INITIAL_REQUEST -> * CONN_WAITING_RESPONSE_FOR_INITIAL_REQUEST | * CONN_CLOSED * * CONN_WAITING_RESPONSE_FOR_INITIAL_REQUEST -> * CONN_READING_FIRST_CHAR_OF_RESPONSE_HEADER_NAME | * CONN_CLOSED * * CONN_READING_FIRST_CHAR_OF_RESPONSE_HEADER_NAME -> * CONN_READING_RESPONSE_HEADER_NAME | * CONN_WAITING_LF_CHAR_TO_CONNECTING | * CONN_CLOSED * * CONN_READING_RESPONSE_HEADER_NAME -> * CONN_READING_RESPONSE_HEADER_VALUE | * CONN_CLOSED * * CONN_READING_RESPONSE_HEADER_VALUE -> * CONN_WAITING_LF_CHAR_OF_RESPONSE_HEADER | * CONN_CLOSED * * CONN_WAITING_LF_CHAR_OF_RESPONSE_HEADER -> * CONN_READING_FIRST_CHAR_OF_RESPONSE_HEADER_NAME | * CONN_CLOSED * * CONN_WAITING_LF_CHAR_TO_CONNECTING -> * CONN_SENDING_INITIAL_REQUEST | * CONN_READING_CHALLENGE_RESPONSE | * CONN_RETRYING_TO_AUTHENTICATE | * CONN_CLOSED * * CONN_READING_CHALLENGE_RESPONSE -> * CONN_CONNECTED_AND_READY | * CONN_CLOSED * * CONN_CONNECTED_AND_READY -> * CONN_HIGH_BIT_OF_FRAME_TYPE_SET | * CONN_HIGH_BIT_OF_FRAME_TYPE_NOT_SET | * CONN_CLOSED * * CONN_HIGH_BIT_OF_FRAME_TYPE_SET -> * CONN_READING_AND_DISCARDING_LENGTH_BYTES | * CONN_SENDING_ACK_CLOSE_FRAME | * CONN_CLOSED * * CONN_READING_AND_DISCARDING_LENGTH_BYTES -> * CONN_CONNECTED_AND_READY | * CONN_CLOSED * * CONN_HIGH_BIT_OF_FRAME_TYPE_NOT_SET -> * CONN_CONNECTED_AND_READY | * CONN_CLOSED * * CONN_SENDING_ACK_CLOSE_FRAME -> * CONN_CLOSED * * CONN_CLOSED (final state) * */ enum ConnectionStatus { CONN_NOT_CONNECTED, CONN_CONNECTING, // connecting to the http proxy CONN_RETRYING_TO_AUTHENTICATE, CONN_CONNECTING_TO_HTTP_PROXY, // doing the websocket handshake CONN_SENDING_INITIAL_REQUEST, CONN_WAITING_RESPONSE_FOR_INITIAL_REQUEST, CONN_READING_FIRST_CHAR_OF_RESPONSE_HEADER_NAME, CONN_READING_RESPONSE_HEADER_NAME, CONN_READING_RESPONSE_HEADER_VALUE, CONN_WAITING_LF_CHAR_OF_RESPONSE_HEADER, CONN_WAITING_LF_CHAR_TO_CONNECTING, CONN_READING_CHALLENGE_RESPONSE, // the websocket connection is established CONN_CONNECTED_AND_READY, CONN_HIGH_BIT_OF_FRAME_TYPE_SET, CONN_READING_AND_DISCARDING_LENGTH_BYTES, CONN_HIGH_BIT_OF_FRAME_TYPE_NOT_SET, // the websocket server requested to close the connection and because of // this the close frame in acknowledgement is expected to be sent CONN_SENDING_ACK_CLOSE_FRAME, // the websocket connection is closed (or it is going to) CONN_CLOSED }; // Shared by both threads (the main and the socket ones). // The initial states (CONN_NOT_CONNECTED, CONN_CONNECTING, // CONN_CONNECTING_TO_HTTP_PROXY and CONN_SENDING_INITIAL_REQUEST) are set by // the main thread. The other ones are set by the socket thread. ConnectionStatus mStatus; }; nsTArray >* nsWebSocketEstablishedConnection::sWSsConnecting = nsnull; //------------------------------------------------------------------------------ // Helper classes //------------------------------------------------------------------------------ class nsWSNetAddressComparator { public: // when comparing, if the connection is under a proxy it'll use its hostname, // otherwise it'll use its mPRNetAddr. PRBool Equals(nsWebSocketEstablishedConnection* a, nsWebSocketEstablishedConnection* b) const; PRBool LessThan(nsWebSocketEstablishedConnection* a, nsWebSocketEstablishedConnection* b) const; }; class nsWSAutoClose { public: nsWSAutoClose(nsWebSocketEstablishedConnection* conn) : mConnection(conn) {} ~nsWSAutoClose() { mConnection->Close(); } private: nsWebSocketEstablishedConnection* mConnection; }; PRBool nsWSNetAddressComparator::Equals(nsWebSocketEstablishedConnection* a, nsWebSocketEstablishedConnection* b) const { NS_ASSERTION(a->mOwner && b->mOwner, "Unexpected disconnected connection"); if ((a->mProxyInfo && !b->mProxyInfo) || (!a->mProxyInfo && b->mProxyInfo)) { return PR_FALSE; } if (a->mProxyInfo) { return a->mOwner->mAsciiHost.Equals(b->mOwner->mAsciiHost); } if (a->mPRNetAddr.raw.family != b->mPRNetAddr.raw.family) { return PR_FALSE; } if (a->mPRNetAddr.raw.family == PR_AF_INET) { return a->mPRNetAddr.inet.ip == b->mPRNetAddr.inet.ip; } NS_ASSERTION(a->mPRNetAddr.raw.family == PR_AF_INET6, "Invalid net raw family"); return a->mPRNetAddr.ipv6.ip.pr_s6_addr64[0] == b->mPRNetAddr.ipv6.ip.pr_s6_addr64[0] && a->mPRNetAddr.ipv6.ip.pr_s6_addr64[1] == b->mPRNetAddr.ipv6.ip.pr_s6_addr64[1]; } PRBool nsWSNetAddressComparator::LessThan(nsWebSocketEstablishedConnection* a, nsWebSocketEstablishedConnection* b) const { NS_ASSERTION(a->mOwner && b->mOwner, "Unexpected disconnected connection"); if (a->mProxyInfo && !b->mProxyInfo) { return PR_FALSE; } if (!a->mProxyInfo && b->mProxyInfo) { return PR_TRUE; } if (a->mProxyInfo) { return (a->mOwner->mAsciiHost < b->mOwner->mAsciiHost); } if (a->mPRNetAddr.raw.family == PR_AF_INET && b->mPRNetAddr.raw.family == PR_AF_INET6) { return PR_TRUE; } if (a->mPRNetAddr.raw.family == PR_AF_INET6 && b->mPRNetAddr.raw.family == PR_AF_INET) { return PR_FALSE; } if (a->mPRNetAddr.raw.family == PR_AF_INET && b->mPRNetAddr.raw.family == PR_AF_INET) { return a->mPRNetAddr.inet.ip < b->mPRNetAddr.inet.ip; } NS_ASSERTION(a->mPRNetAddr.raw.family == PR_AF_INET6 && b->mPRNetAddr.raw.family == PR_AF_INET6, "Invalid net raw family"); return a->mPRNetAddr.ipv6.ip.pr_s6_addr64[0] < b->mPRNetAddr.ipv6.ip.pr_s6_addr64[0] || (a->mPRNetAddr.ipv6.ip.pr_s6_addr64[0] == b->mPRNetAddr.ipv6.ip.pr_s6_addr64[0] && a->mPRNetAddr.ipv6.ip.pr_s6_addr64[1] < b->mPRNetAddr.ipv6.ip.pr_s6_addr64[1]); } //----------------------------------------------------------------------------- // nsWebSocketEstablishedConnection::nsISupports //----------------------------------------------------------------------------- NS_IMPL_THREADSAFE_ISUPPORTS9(nsWebSocketEstablishedConnection, nsIInterfaceRequestor, nsIDNSListener, nsIProtocolProxyCallback, nsIInputStreamCallback, nsIOutputStreamCallback, nsIRequest, nsIChannel, nsIProxiedChannel, nsIHttpAuthenticableChannel) //----------------------------------------------------------------------------- // nsWebSocketEstablishedConnection methods: //----------------------------------------------------------------------------- nsWebSocketEstablishedConnection::nsWebSocketEstablishedConnection() : mLockDisconnect("WebSocket's disconnect lock"), mLockOutgoingMessages("WebSocket's outgoing messages lock"), mLockReceivedMessages("WebSocket's received messages lock"), mBytesAlreadySentOfFirstOutString(0), mOutgoingBufferedAmount(0), mOwner(nsnull), mBytesInBuffer(0), mLengthToDiscard(0), mReadingProxyConnectResponse(PR_FALSE), mCurrentProxyConfig(eNotResolvingProxy), mProxyFailureReason(NS_OK), mFailureStatus(NS_OK), mAuthenticating(PR_FALSE), mPostedCloseFrame(PR_FALSE), mClosedCleanly(PR_FALSE), mStatus(CONN_NOT_CONNECTED) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); nsLayoutStatics::AddRef(); } nsWebSocketEstablishedConnection::~nsWebSocketEstablishedConnection() { } nsresult nsWebSocketEstablishedConnection::PostData(nsCString *aBuffer, PRBool aIsMessage) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); if (mStatus == CONN_CLOSED) { NS_ASSERTION(mOwner, "Posting data after disconnecting the websocket!"); // the tcp connection has been closed, but the main thread hasn't received // the event for disconnecting the object yet. return NS_BASE_STREAM_CLOSED; } MutexAutoLock lockOut(mLockOutgoingMessages); nsresult rv; PRInt32 sizeBefore = mOutgoingMessages.GetSize(); mOutgoingMessages.Push(aBuffer); NS_ENSURE_TRUE(mOutgoingMessages.GetSize() == sizeBefore + 1, NS_ERROR_OUT_OF_MEMORY); if (aIsMessage) { // without the START_BYTE_OF_MESSAGE and END_BYTE_OF_MESSAGE bytes mOutgoingBufferedAmount += aBuffer->Length() - 2; } if (sizeBefore == 0) { mBytesAlreadySentOfFirstOutString = 0; rv = mSocketOutput->AsyncWait(this, 0, 0, gWebSocketThread); NS_ENSURE_SUCCESS(rv, rv); } return NS_OK; } nsresult nsWebSocketEstablishedConnection::PostMessage(const nsString& aMessage) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); if (!mOwner) { return NS_OK; } // only send messages when connected NS_ENSURE_STATE(mStatus >= CONN_CONNECTED_AND_READY); nsresult rv; nsCOMPtr ccm = do_GetService(NS_CHARSETCONVERTERMANAGER_CONTRACTID, &rv); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); nsCOMPtr converter; rv = ccm->GetUnicodeEncoder("UTF-8", getter_AddRefs(converter)); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); rv = converter->SetOutputErrorBehavior(nsIUnicodeEncoder::kOnError_Replace, nsnull, UTF_8_REPLACEMENT_CHAR); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); PRInt32 inLen = aMessage.Length(); PRInt32 maxLen; rv = converter->GetMaxLength(aMessage.BeginReading(), inLen, &maxLen); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); maxLen += 2; // 2 bytes for START_BYTE_OF_MESSAGE and END_BYTE_OF_MESSAGE nsAutoPtr buf(new nsCString()); ENSURE_TRUE_AND_FAIL_IF_FAILED(buf.get(), NS_ERROR_OUT_OF_MEMORY); buf->SetLength(maxLen); ENSURE_TRUE_AND_FAIL_IF_FAILED(buf->Length() == static_cast(maxLen), NS_ERROR_OUT_OF_MEMORY); char* start = buf->BeginWriting(); *start = static_cast(START_BYTE_OF_MESSAGE); ++start; PRInt32 outLen = maxLen; rv = converter->Convert(aMessage.BeginReading(), &inLen, start, &outLen); if (NS_SUCCEEDED(rv)) { PRInt32 outLen2 = maxLen - outLen; rv = converter->Finish(start + outLen, &outLen2); outLen += outLen2; } if (NS_FAILED(rv) || rv == NS_ERROR_UENC_NOMAPPING) { // Yes, NS_ERROR_UENC_NOMAPPING is a success code return NS_ERROR_DOM_SYNTAX_ERR; } char* end = buf->BeginWriting() + outLen + 1; *end = static_cast(END_BYTE_OF_MESSAGE); outLen += 2; buf->SetLength(outLen); ENSURE_TRUE_AND_FAIL_IF_FAILED(buf->Length() == static_cast(outLen), NS_ERROR_UNEXPECTED); rv = PostData(buf.forget(), PR_TRUE); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); return NS_OK; } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(DoInitialRequest) { nsresult rv; nsString strRequestTmp; nsAutoPtr buf(new nsCString()); CHECK_TRUE_AND_FAIL_IF_FAILED(buf.get()); // GET resource HTTP/1.1 buf->AppendLiteral("GET "); buf->Append(mOwner->mResource); buf->AppendLiteral(" HTTP/1.1\r\n"); nsCAutoString key_1, key_2, key_3; rv = GenerateRequestKeys(key_1, key_2, key_3); CHECK_SUCCESS_AND_FAIL_IF_FAILED(rv); // the headers should be sent in a random order enum eRequestHeader { upgradeHeader = 0, connectionHeader, hostHeader, originHeader, secWebSocketProtocolHeader, authorizationHeaders, cookieHeaders, secWebSocketKey1Header, secWebSocketKey2Header, numberRequestHeaders }; nsAutoTArray headersToSend; for (PRUint32 i = 0; i < numberRequestHeaders; ++i) { headersToSend.AppendElement(i); } while (!headersToSend.IsEmpty()) { PRUint8 headerPosToSendNow = rand() % headersToSend.Length(); eRequestHeader headerToSendNow = static_cast(headersToSend[headerPosToSendNow]); switch (headerToSendNow) { case upgradeHeader: { buf->AppendLiteral("Upgrade: WebSocket\r\n"); } break; case connectionHeader: { buf->AppendLiteral("Connection: Upgrade\r\n"); } break; case hostHeader: { buf->AppendLiteral("Host: "); buf->Append(mOwner->mAsciiHost); buf->AppendLiteral(":"); buf->AppendInt(mOwner->mPort); buf->AppendLiteral("\r\n"); } break; case originHeader: { buf->AppendLiteral("Origin: "); buf->Append(mOwner->mOrigin); buf->AppendLiteral("\r\n"); } break; case secWebSocketProtocolHeader: { if (!mOwner->mProtocol.IsEmpty()) { buf->AppendLiteral("Sec-WebSocket-Protocol: "); buf->Append(mOwner->mProtocol); buf->AppendLiteral("\r\n"); } } break; case authorizationHeaders: { rv = AddAuthorizationHeaders(*buf, PR_FALSE); CHECK_SUCCESS_AND_FAIL_IF_FAILED(rv); } break; case cookieHeaders: { rv = AddCookiesToRequest(*buf); CHECK_SUCCESS_AND_FAIL_IF_FAILED(rv); } break; case secWebSocketKey1Header: { buf->AppendLiteral("Sec-WebSocket-Key1: "); buf->Append(key_1); buf->AppendLiteral("\r\n"); } break; case secWebSocketKey2Header: { buf->AppendLiteral("Sec-WebSocket-Key2: "); buf->Append(key_2); buf->AppendLiteral("\r\n"); } break; } headersToSend.RemoveElementAt(headerPosToSendNow); } buf->AppendLiteral("\r\n"); buf->Append(key_3); mStatus = CONN_SENDING_INITIAL_REQUEST; rv = PostData(buf.forget(), PR_FALSE); CHECK_SUCCESS_AND_FAIL_IF_FAILED(rv); } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END static nsresult GetHttpResponseCode(const nsCString& aLine, PRUint32 aLen, PRUint32 *aStatusCode, PRUint32 *aLineLen) { // make sure we have HTTP at the beginning if (aLen < 4) { return NS_ERROR_IN_PROGRESS; } if (!StringBeginsWith(aLine, NS_LITERAL_CSTRING("HTTP"))) { return NS_ERROR_UNEXPECTED; } // get the response code PRUint32 responseCode = 0; PRUint8 responseCodeReadingState = 0; // 0:not reading, 1:reading, // 2:done reading char last2Chrs[2] = {'\0', '\0'}; PRUint32 i = 4; // just after the HTTP for (; i < aLen; ++i) { if (responseCodeReadingState == 0 && aLine[i] == ' ') { responseCodeReadingState = 1; } else if (responseCodeReadingState == 1) { if (aLine[i] == ' ') { responseCodeReadingState = 2; } else if (aLine[i] >= '0' && aLine[i] <= '9') { responseCode = 10 * responseCode + (aLine[i] - '0'); if (responseCode > 999) { // the response code must be three digits long return NS_ERROR_UNEXPECTED; } } else { return NS_ERROR_UNEXPECTED; } } last2Chrs[0] = last2Chrs[1]; last2Chrs[1] = aLine[i]; if (last2Chrs[0] == '\r' && last2Chrs[1] == '\n') { // CR LF *aStatusCode = responseCode; *aLineLen = i + 1; return NS_OK; } } return NS_ERROR_IN_PROGRESS; } nsresult nsWebSocketEstablishedConnection::HandleNewInputString(PRUint32 aStart) { NS_ASSERTION(!NS_IsMainThread(), "Not running on socket thread"); if (mBytesInBuffer == 0 || aStart == mBytesInBuffer) { return NS_OK; } NS_ENSURE_STATE(aStart < mBytesInBuffer); nsresult rv; switch (mStatus) { case CONN_CONNECTING_TO_HTTP_PROXY: { PRUint32 statusCode, lengthStr; rv = GetHttpResponseCode(mBuffer, mBytesInBuffer, &statusCode, &lengthStr); if (rv != NS_ERROR_IN_PROGRESS) { NS_ENSURE_SUCCESS(rv, NS_ERROR_UNEXPECTED); if (statusCode == 200) { mReadingProxyConnectResponse = PR_TRUE; mAuthenticating = PR_FALSE; } else if (statusCode == 407) { mReadingProxyConnectResponse = PR_TRUE; mAuthenticating = PR_TRUE; } else { return NS_ERROR_UNEXPECTED; } mStatus = CONN_READING_FIRST_CHAR_OF_RESPONSE_HEADER_NAME; mBuffer.Cut(0, lengthStr); mBytesInBuffer -= lengthStr; return HandleNewInputString(0); } } break; case CONN_SENDING_ACK_CLOSE_FRAME: case CONN_CLOSED: { mBytesInBuffer = 0; } break; case CONN_WAITING_RESPONSE_FOR_INITIAL_REQUEST: { PRUint32 statusCode, lengthStr; rv = GetHttpResponseCode(mBuffer, mBytesInBuffer, &statusCode, &lengthStr); if (rv != NS_ERROR_IN_PROGRESS) { NS_ENSURE_SUCCESS(rv, NS_ERROR_UNEXPECTED); if (statusCode != 101) { return NS_ERROR_UNEXPECTED; } mReadingProxyConnectResponse = PR_FALSE; mAuthenticating = PR_FALSE; mStatus = CONN_READING_FIRST_CHAR_OF_RESPONSE_HEADER_NAME; mBuffer.Cut(0, lengthStr); mBytesInBuffer -= lengthStr; // we have just received the server response. We must cancel this timer // or it will fail the connection. mInitialServerResponseTimer->Cancel(); return HandleNewInputString(0); } } break; case CONN_READING_FIRST_CHAR_OF_RESPONSE_HEADER_NAME: { if (mBuffer[aStart] == '\r') { mStatus = CONN_WAITING_LF_CHAR_TO_CONNECTING; return HandleNewInputString(aStart + 1); } NS_ENSURE_STATE(mBuffer[aStart] != '\n'); mStatus = CONN_READING_RESPONSE_HEADER_NAME; return HandleNewInputString(aStart); } break; case CONN_READING_RESPONSE_HEADER_NAME: { PRUint32 i; for (i = aStart; i < mBytesInBuffer; ++i) { NS_ENSURE_STATE(mBuffer[i] != '\r' && mBuffer[i] != '\n'); if (mBuffer[i] == ':') { mStatus = CONN_READING_RESPONSE_HEADER_VALUE; return HandleNewInputString(i + 1); } } } break; case CONN_READING_RESPONSE_HEADER_VALUE: { PRUint32 i; for (i = aStart; i < mBytesInBuffer; ++i) { if (mBuffer[i] == '\r') { mStatus = CONN_WAITING_LF_CHAR_OF_RESPONSE_HEADER; return HandleNewInputString(i + 1); } NS_ENSURE_STATE(mBuffer[i] != '\n'); } } break; case CONN_WAITING_LF_CHAR_OF_RESPONSE_HEADER: { NS_ENSURE_STATE(mBuffer[aStart] == '\n'); PRUint32 posColon = mBuffer.FindChar(':'); PRUint32 posCR = mBuffer.FindChar('\r'); const nsCSubstring& headerName = Substring(mBuffer, 0, posColon); nsCString headerValue; if (mBuffer[posColon + 1] == 0x20 && posColon + 2 != posCR) { headerValue = Substring(mBuffer, posColon + 2, posCR - posColon - 2); } else if (posColon + 1 != posCR) { headerValue = Substring(mBuffer, posColon + 1, posCR - posColon - 1); } else { ; // No header value } NS_ENSURE_STATE(!headerName.IsEmpty()); PRInt32 headerPos = -1; if (mReadingProxyConnectResponse) { if (headerName.LowerCaseEqualsLiteral("proxy-authenticate")) { headerPos = kProxyAuthenticatePos; } } else { if (headerName.LowerCaseEqualsLiteral("upgrade")) { headerPos = kUpgradePos; } else if (headerName.LowerCaseEqualsLiteral("connection")) { headerPos = kConnectionPos; } else if (headerName.LowerCaseEqualsLiteral("sec-websocket-origin")) { headerPos = kSecWebSocketOriginPos; } else if (headerName.LowerCaseEqualsLiteral("sec-websocket-location")) { headerPos = kSecWebSocketLocationPos; } else if (headerName.LowerCaseEqualsLiteral("sec-websocket-protocol")) { headerPos = kSecWebSocketProtocolPos; } else if (headerName.LowerCaseEqualsLiteral("set-cookie")) { headerPos = kSetCookiePos; } } if (headerPos == -1 && headerName.LowerCaseEqualsLiteral("server")) { headerPos = kServerPos; } if (headerPos != -1) { NS_ENSURE_STATE(mHeaders[headerPos].IsEmpty()); mHeaders[headerPos] = headerValue; } mStatus = CONN_READING_FIRST_CHAR_OF_RESPONSE_HEADER_NAME; mBuffer.Cut(0, aStart + 1); mBytesInBuffer -= aStart + 1; return HandleNewInputString(0); } break; case CONN_WAITING_LF_CHAR_TO_CONNECTING: { NS_ENSURE_STATE(mBuffer[aStart] == '\n'); rv = ProcessHeaders(); NS_ENSURE_SUCCESS(rv, NS_ERROR_UNEXPECTED); if (mAuthenticating) { Reset(); mStatus = CONN_RETRYING_TO_AUTHENTICATE; return ProcessAuthentication(); } if (mReadingProxyConnectResponse) { if (mOwner->mSecure) { rv = ProxyStartSSL(); NS_ENSURE_SUCCESS(rv, NS_ERROR_UNEXPECTED); } mBytesInBuffer = 0; return DoInitialRequest(); } mStatus = CONN_READING_CHALLENGE_RESPONSE; mBuffer.Cut(0, aStart + 1); mBytesInBuffer -= aStart + 1; return HandleNewInputString(0); } case CONN_READING_CHALLENGE_RESPONSE: { NS_ENSURE_STATE(aStart == 0); if (mBytesInBuffer < 16) { return NS_OK; } const nsCSubstring& receivedMD5Challenge = Substring(mBuffer, 0, 16); if (!mExpectedMD5Challenge.Equals(receivedMD5Challenge)) { return NS_ERROR_UNEXPECTED; } mStatus = CONN_CONNECTED_AND_READY; rv = Connected(); NS_ENSURE_SUCCESS(rv, NS_ERROR_UNEXPECTED); mBuffer.Cut(0, aStart + 16); mBytesInBuffer -= aStart + 16; return HandleNewInputString(0); } case CONN_CONNECTED_AND_READY: { NS_ENSURE_STATE(aStart == 0); PRUint8 frameType = mBuffer[0]; if (IS_HIGH_BIT_OF_FRAME_TYPE_SET(frameType)) { mStatus = CONN_HIGH_BIT_OF_FRAME_TYPE_SET; mLengthToDiscard = 0; } else { mStatus = CONN_HIGH_BIT_OF_FRAME_TYPE_NOT_SET; } return HandleNewInputString(1); } break; case CONN_HIGH_BIT_OF_FRAME_TYPE_SET: { PRUint32 i; PRUint8 frameType = mBuffer[0]; for (i = aStart; i < mBytesInBuffer; ++i) { PRUint8 b, bv; b = mBuffer[i]; bv = (b & 0x7f); // prevent overflow NS_ENSURE_STATE(mLengthToDiscard <= ((PR_UINT32_MAX - bv) / 128)); mLengthToDiscard = mLengthToDiscard * 128 + bv; if (!IS_HIGH_BIT_OF_BYTE_SET(b)) { // check if it is the close frame if (mLengthToDiscard == 0 && frameType == START_BYTE_OF_CLOSE_FRAME) { mBytesInBuffer = 0; if (SentAlreadyTheCloseFrame()) { mClosedCleanly = PR_TRUE; mStatus = CONN_CLOSED; } else { mStatus = CONN_SENDING_ACK_CLOSE_FRAME; } return Close(); } FrameError(); mStatus = CONN_READING_AND_DISCARDING_LENGTH_BYTES; return HandleNewInputString(i + 1); } } mBytesInBuffer = 0; } break; case CONN_READING_AND_DISCARDING_LENGTH_BYTES: { if (mBytesInBuffer - aStart >= mLengthToDiscard) { mBuffer.Cut(0, aStart + mLengthToDiscard); mBytesInBuffer -= aStart + mLengthToDiscard; mStatus = CONN_CONNECTED_AND_READY; return HandleNewInputString(0); } mLengthToDiscard -= mBytesInBuffer - aStart; mBytesInBuffer = 0; } break; case CONN_HIGH_BIT_OF_FRAME_TYPE_NOT_SET: { PRUint32 i; for (i = aStart; i < mBytesInBuffer; ++i) { PRUint8 b; b = mBuffer[i]; if (b == END_BYTE_OF_MESSAGE) { PRUint8 frameType = mBuffer[0]; if (frameType == START_BYTE_OF_MESSAGE) { // get the message, without the START_BYTE_OF_MESSAGE and // END_BYTE_OF_MESSAGE bytes nsAutoPtr dataMessage(new nsCString()); NS_ENSURE_TRUE(dataMessage.get(), NS_ERROR_OUT_OF_MEMORY); dataMessage->Assign(Substring(mBuffer, 1, i - 1)); // push the new message onto our stack { MutexAutoLock lockIn(mLockReceivedMessages); PRInt32 sizeBefore = mReceivedMessages.GetSize(); mReceivedMessages.Push(dataMessage.forget()); NS_ENSURE_TRUE(mReceivedMessages.GetSize() == sizeBefore + 1, NS_ERROR_OUT_OF_MEMORY); } // and dispatch it rv = DispatchNewMessage(); NS_ENSURE_SUCCESS(rv, NS_ERROR_UNEXPECTED); } else { FrameError(); } mBuffer.Cut(0, i + 1); mBytesInBuffer -= i + 1; mStatus = CONN_CONNECTED_AND_READY; return HandleNewInputString(0); } } } break; default: NS_ASSERTION(PR_FALSE, "Invalid state."); } return NS_OK; } nsresult nsWebSocketEstablishedConnection::AddAuthorizationHeaders(nsCString& aStr, PRBool aIsProxyAuth) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); mAuthProvider->AddAuthorizationHeaders(); if (UsingHttpProxy() && !mProxyCredentials.IsEmpty()) { aStr.AppendLiteral("Proxy-Authorization: "); aStr.Append(mProxyCredentials); aStr.AppendLiteral("\r\n"); } if (!aIsProxyAuth && !mCredentials.IsEmpty()) { aStr.AppendLiteral("Authorization: "); aStr.Append(mCredentials); aStr.AppendLiteral("\r\n"); } return NS_OK; } nsresult nsWebSocketEstablishedConnection::AddCookiesToRequest(nsCString& aStr) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); // get the content of the cookie request header nsCOMPtr cookieService = do_GetService(NS_COOKIESERVICE_CONTRACTID); nsCOMPtr doc = nsContentUtils::GetDocumentFromScriptContext(mOwner->mScriptContext); if (!cookieService || !doc) { return NS_OK; } nsCOMPtr documentURI = doc->GetDocumentURI(); if (!documentURI) { return NS_OK; } nsXPIDLCString cookieValue; cookieService->GetCookieStringFromHttp(documentURI, documentURI, nsnull, getter_Copies(cookieValue)); if (!cookieValue.IsEmpty()) { aStr.AppendLiteral("Cookie: "); aStr.Append(cookieValue); aStr.AppendLiteral("\r\n"); } return NS_OK; } PRUint32 nsWebSocketEstablishedConnection::GenerateSecKey(nsCString& aKey) { PRUint32 i; PRUint32 spaces = rand() % 12 + 1; PRUint32 max = PR_UINT32_MAX / spaces; PRUint32 number = rand() % max; PRUint32 product = number * spaces; nsCAutoString key; key.AppendInt(product); // Insert between one and twelve random characters from the ranges // U+0021 to U+002F and U+003A to U+007E into the key at random // positions. PRUint32 numberOfCharsToInsert = rand() % 12 + 1; for (i = 0; i < numberOfCharsToInsert; ++i) { PRUint32 posToInsert = rand() % key.Length(); char charToInsert = rand() % 2 == 0 ? static_cast(0x21 + (rand() % (0x2F - 0x21 + 1))) : static_cast(0x3A + (rand() % (0x7E - 0x3A + 1))); key.Insert(charToInsert, posToInsert); } // Insert /spaces/ U+0020 SPACE characters into the key at random // positions other than the start or end of the string. for (i = 0; i < spaces; ++i) { PRUint32 posToInsert = rand() % (key.Length() - 1) + 1; key.Insert(static_cast(0x20), posToInsert); } aKey = key; return number; } nsresult nsWebSocketEstablishedConnection::GenerateRequestKeys(nsCString& aKey1, nsCString& aKey2, nsCString& aKey3) { nsresult rv; PRUint32 i; nsCAutoString key_1; PRUint32 number_1; nsCAutoString key_2; PRUint32 number_2; // generate the sec-keys headers values number_1 = GenerateSecKey(key_1); number_2 = GenerateSecKey(key_2); // key3 must be a string consisting of eight random bytes nsCAutoString key_3; for (i = 0; i < 8; ++i) { // get a byte between 1 and 255. 0x00 was discarted to prevent possible // issues in ws servers. key_3 += static_cast(rand() % 0xff + 1); } // since we have the keys, we calculate the server md5 challenge response, // which is the md5 string of the concatenation of /number_1/, expressed as // a big-endian 32 bit integer, /number_2/, expressed as a big-endian // 32 bit integer, and the eight bytes of /key_3/ nsCOMPtr md5CryptoHash = do_CreateInstance(NS_CRYPTO_HASH_CONTRACTID, &rv); NS_ENSURE_SUCCESS(rv, rv); rv = md5CryptoHash->Init(nsICryptoHash::MD5); NS_ENSURE_SUCCESS(rv, rv); PRUint8 data[16]; for (i = 1; i <= 4; ++i) { data[i - 1] = static_cast(number_1 >> (32 - i * 8)); } for (i = 1; i <= 4; ++i) { data[i + 3] = static_cast(number_2 >> (32 - i * 8)); } for (i = 0; i < 8; ++i) { data[i + 8] = static_cast(key_3[i]); } rv = md5CryptoHash->Update(data, 16); NS_ENSURE_SUCCESS(rv, rv); rv = md5CryptoHash->Finish(PR_FALSE, mExpectedMD5Challenge); NS_ENSURE_SUCCESS(rv, rv); aKey1 = key_1; aKey2 = key_2; aKey3 = key_3; return NS_OK; } PRBool nsWebSocketEstablishedConnection::UsingHttpProxy() { if (!mProxyInfo) { return PR_FALSE; } nsCAutoString proxyType; mProxyInfo->GetType(proxyType); return proxyType.EqualsLiteral("http"); } // it is called by both main and socket threads under the mLockDisconnect nsresult nsWebSocketEstablishedConnection::Reset() { RemoveWSConnecting(); mStatus = CONN_NOT_CONNECTED; if (mSocketTransport) { mSocketTransport->Close(NS_OK); mSocketTransport = nsnull; } mSocketInput = nsnull; mSocketOutput = nsnull; while (mOutgoingMessages.GetSize() != 0) { delete static_cast(mOutgoingMessages.PopFront()); } while (mReceivedMessages.GetSize() != 0) { delete static_cast(mReceivedMessages.PopFront()); } mBytesAlreadySentOfFirstOutString = 0; mBytesInBuffer = 0; return NS_OK; } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(Connected) { RemoveWSConnecting(); if (mAuthProvider) { mAuthProvider->Disconnect(NS_ERROR_ABORT); mAuthProvider = nsnull; } mOwner->SetReadyState(nsIWebSocket::OPEN); } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(FrameError) { nsresult rv = mOwner->CreateAndDispatchSimpleEvent(NS_LITERAL_STRING("error")); if (NS_FAILED(rv)) { NS_WARNING("Failed to dispatch the error event"); } } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(DispatchNewMessage) { nsresult rv; while (PR_TRUE) { nsAutoPtr data; { MutexAutoLock lockIn(mLockReceivedMessages); if (mReceivedMessages.GetSize() == 0) { return; } data = static_cast(mReceivedMessages.PopFront()); } rv = mOwner->CreateAndDispatchMessageEvent(data); if (NS_FAILED(rv)) { NS_WARNING("Failed to dispatch the message event"); } } } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END nsresult nsWebSocketEstablishedConnection::ProxyStartSSL() { NS_ASSERTION(!NS_IsMainThread(), "Not running on socket thread"); nsCOMPtr securityInfo; nsresult rv = mSocketTransport->GetSecurityInfo(getter_AddRefs(securityInfo)); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr ssl = do_QueryInterface(securityInfo, &rv); NS_ENSURE_SUCCESS(rv, rv); return ssl->ProxyStartSSL(); } nsresult nsWebSocketEstablishedConnection::Init(nsWebSocket *aOwner) { // test if it has been alredy initialized NS_ASSERTION(!mOwner, "WebSocket's connection is already initialized"); nsresult rv; mOwner = aOwner; if (mOwner->mSecure) { // HACK: make sure PSM gets initialized on the main thread. nsCOMPtr spserv = do_GetService(NS_SOCKETPROVIDERSERVICE_CONTRACTID); NS_ENSURE_STATE(spserv); nsCOMPtr provider; rv = spserv->GetSocketProvider("ssl", getter_AddRefs(provider)); NS_ENSURE_SUCCESS(rv, rv); } mTryConnectTimer = do_CreateInstance("@mozilla.org/timer;1", &rv); NS_ENSURE_SUCCESS(rv, rv); mInitialServerResponseTimer = do_CreateInstance("@mozilla.org/timer;1", &rv); NS_ENSURE_SUCCESS(rv, rv); // add ourselves to the document's load group nsCOMPtr loadGroup; rv = GetLoadGroup(getter_AddRefs(loadGroup)); NS_ENSURE_SUCCESS(rv, rv); if (loadGroup) { rv = loadGroup->AddRequest(this, nsnull); NS_ENSURE_SUCCESS(rv, rv); } mAuthProvider = do_CreateInstance("@mozilla.org/network/http-channel-auth-provider;1", &rv); NS_ENSURE_SUCCESS(rv, rv); rv = mAuthProvider->Init(this); NS_ENSURE_SUCCESS(rv, rv); CopyUTF16toUTF8(mOwner->mOriginalURL, mRequestName); if (!sWSsConnecting) { sWSsConnecting = new nsTArray >(); ENSURE_TRUE_AND_FAIL_IF_FAILED(sWSsConnecting, NS_ERROR_OUT_OF_MEMORY); } if (!gWebSocketThread) { rv = NS_NewThread(&gWebSocketThread); NS_ENSURE_SUCCESS(rv, rv); } rv = ResolveNextProxyAndConnect(); NS_ENSURE_SUCCESS(rv, rv); return NS_OK; } nsresult nsWebSocketEstablishedConnection::DoConnect() { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); nsresult rv; rv = AddWSConnecting(); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); mStatus = CONN_CONNECTING; nsCOMPtr sts = do_GetService(NS_SOCKETTRANSPORTSERVICE_CONTRACTID, &rv); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); // configure the socket type based on the connection type requested. const char* types[1]; nsAdoptingCString value = nsContentUtils::GetCharPref("network.http.default-socket-type"); if (mOwner->mSecure) { types[0] = "ssl"; } else { if (value.IsEmpty()) { types[0] = nsnull; } else { types[0] = value.get(); } } nsCOMPtr strans; PRUint32 typeCount = (types[0] != nsnull ? 1 : 0); rv = sts->CreateTransport(types, typeCount, mOwner->mAsciiHost, mOwner->mPort, mProxyInfo, getter_AddRefs(strans)); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); rv = strans->SetSecurityCallbacks(this); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); nsCOMPtr outStream; rv = strans->OpenOutputStream(nsITransport::OPEN_UNBUFFERED, 0, 0, getter_AddRefs(outStream)); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); nsCOMPtr inStream; rv = strans->OpenInputStream(nsITransport::OPEN_UNBUFFERED, 0, 0, getter_AddRefs(inStream)); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); mSocketTransport = strans; mSocketInput = do_QueryInterface(inStream); mSocketOutput = do_QueryInterface(outStream); mProxyResolveCancelable = nsnull; if (!UsingHttpProxy()) { rv = DoInitialRequest(); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); return NS_OK; } nsAutoPtr buf(new nsCString()); ENSURE_TRUE_AND_FAIL_IF_FAILED(buf.get(), NS_ERROR_OUT_OF_MEMORY); nsString strRequestTmp; // CONNECT host:port HTTP/1.1 buf->AppendLiteral("CONNECT "); buf->Append(mOwner->mAsciiHost); buf->AppendLiteral(":"); buf->AppendInt(mOwner->mPort); buf->AppendLiteral(" HTTP/1.1\r\n"); // Host // all HTTP/1.1 requests must include a Host header (even though it // may seem redundant in this case; see bug 82388). buf->AppendLiteral("Host: "); buf->Append(mOwner->mAsciiHost); buf->AppendLiteral(":"); buf->AppendInt(mOwner->mPort); buf->AppendLiteral("\r\n"); // Proxy Authorization rv = AddAuthorizationHeaders(*buf, PR_TRUE); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); buf->AppendLiteral("\r\n"); mStatus = CONN_CONNECTING_TO_HTTP_PROXY; rv = PostData(buf.forget(), PR_FALSE); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); return NS_OK; } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(AddWSConnecting) { #ifdef DEBUG PRUint32 index = sWSsConnecting->BinaryIndexOf(this, nsWSNetAddressComparator()); NS_ASSERTION(index == nsTArray::NoIndex, "The ws connection shouldn't be already added in the " "serialization list."); #endif PRBool inserted = !!(sWSsConnecting->InsertElementSorted(this, nsWSNetAddressComparator())); NS_ASSERTION(inserted, "Couldn't insert the ws connection into the " "serialization list."); } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(RemoveWSConnecting) { if (mStatus == CONN_NOT_CONNECTED) { return; } PRUint32 index = sWSsConnecting->BinaryIndexOf(this, nsWSNetAddressComparator()); if (index != nsTArray::NoIndex) { sWSsConnecting->RemoveElementAt(index); } } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END // static void nsWebSocketEstablishedConnection::TryConnect(nsITimer* aTimer, void* aClosure) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); nsresult rv; nsRefPtr thisObject = static_cast(aClosure); if (!thisObject->mOwner) { // we have been disconnected return; } PRUint32 index = sWSsConnecting->BinaryIndexOf(thisObject, nsWSNetAddressComparator()); if (index != nsTArray::NoIndex) { // try again after TIMEOUT_TRY_CONNECT_AGAIN second rv = thisObject->mTryConnectTimer-> InitWithFuncCallback(TryConnect, thisObject, TIMEOUT_TRY_CONNECT_AGAIN, nsITimer::TYPE_ONE_SHOT); CHECK_SUCCESS_AND_FAIL_IF_FAILED2(rv); } else { rv = thisObject->DoConnect(); CHECK_SUCCESS_AND_FAIL_IF_FAILED2(rv); } } // static void nsWebSocketEstablishedConnection:: TimerInitialServerResponseCallback(nsITimer* aTimer, void* aClosure) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); nsRefPtr thisObject = static_cast(aClosure); if (!thisObject->mOwner) { // we have been disconnected return; } thisObject->FailConnection(); } // static void nsWebSocketEstablishedConnection::TimerForceCloseCallback(nsITimer* aTimer, void* aClosure) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); nsRefPtr thisObject = static_cast(aClosure); if (!thisObject->mOwner) { // we have been disconnected return; } thisObject->ForceClose(); } nsresult nsWebSocketEstablishedConnection::ProcessHeaders() { NS_ASSERTION(!NS_IsMainThread(), "Not running on socket thread"); nsresult rv; if (mAuthenticating) { if (mHeaders[kProxyAuthenticatePos].IsEmpty()) return NS_ERROR_UNEXPECTED; return NS_OK; } if (mReadingProxyConnectResponse) { return NS_OK; } // test the upgrade header if (!mHeaders[kUpgradePos].EqualsLiteral("WebSocket")) { return NS_ERROR_UNEXPECTED; } // test the connection header if (!mHeaders[kConnectionPos].LowerCaseEqualsLiteral("upgrade")) { return NS_ERROR_UNEXPECTED; } // test the sec-websocket-origin header nsCString responseOriginHeader = mHeaders[kSecWebSocketOriginPos]; ToLowerCase(responseOriginHeader); if (!responseOriginHeader.Equals(mOwner->mOrigin)) { return NS_ERROR_UNEXPECTED; } // test the sec-websocket-location header nsCString validWebSocketLocation1, validWebSocketLocation2; validWebSocketLocation1.Append(mOwner->mSecure ? "wss://" : "ws://"); validWebSocketLocation1.Append(mOwner->mAsciiHost); validWebSocketLocation1.Append(":"); validWebSocketLocation1.AppendInt(mOwner->mPort); validWebSocketLocation1.Append(mOwner->mResource); if ((mOwner->mSecure && mOwner->mPort != DEFAULT_WSS_SCHEME_PORT) || (!mOwner->mSecure && mOwner->mPort != DEFAULT_WS_SCHEME_PORT)) { validWebSocketLocation2 = validWebSocketLocation1; } else { validWebSocketLocation2.Append(mOwner->mSecure ? "wss://" : "ws://"); validWebSocketLocation2.Append(mOwner->mAsciiHost); validWebSocketLocation2.Append(mOwner->mResource); } if (!mHeaders[kSecWebSocketLocationPos].Equals(validWebSocketLocation1) && !mHeaders[kSecWebSocketLocationPos].Equals(validWebSocketLocation2)) { return NS_ERROR_UNEXPECTED; } // handle the sec-websocket-protocol header if (!mOwner->mProtocol.IsEmpty() && !mHeaders[kSecWebSocketProtocolPos]. Equals(mOwner->mProtocol)) { return NS_ERROR_UNEXPECTED; } // handle the set-cookie header if (!mHeaders[kSetCookiePos].IsEmpty()) { rv = HandleSetCookieHeader(); NS_ENSURE_SUCCESS(rv, rv); } return NS_OK; } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(HandleSetCookieHeader) { nsresult rv; nsCOMPtr cookieService = do_GetService(NS_COOKIESERVICE_CONTRACTID); nsCOMPtr doc = nsContentUtils::GetDocumentFromScriptContext(mOwner->mScriptContext); if (!cookieService || !doc) { return; } nsCOMPtr documentURI = doc->GetDocumentURI(); if (!documentURI) { return; } nsCOMPtr wwatch = do_GetService(NS_WINDOWWATCHER_CONTRACTID, &rv); CHECK_SUCCESS_AND_FAIL_IF_FAILED(rv); nsCOMPtr prompt; nsCOMPtr outerWindow = doc->GetWindow(); rv = wwatch->GetPrompt(outerWindow, NS_GET_IID(nsIPrompt), getter_AddRefs(prompt)); CHECK_SUCCESS_AND_FAIL_IF_FAILED(rv); rv = cookieService->SetCookieStringFromHttp(documentURI, documentURI, prompt, mHeaders[kSetCookiePos].get(), nsnull, nsnull); CHECK_SUCCESS_AND_FAIL_IF_FAILED(rv); } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END nsresult nsWebSocketEstablishedConnection::PrintErrorOnConsole(const char *aBundleURI, const PRUnichar *aError, const PRUnichar **aFormatStrings, PRUint32 aFormatStringsLen) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); nsresult rv; nsCOMPtr bundleService = do_GetService(NS_STRINGBUNDLE_CONTRACTID, &rv); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr strBundle; rv = bundleService->CreateBundle(aBundleURI, getter_AddRefs(strBundle)); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr console( do_GetService(NS_CONSOLESERVICE_CONTRACTID, &rv)); NS_ENSURE_SUCCESS(rv, rv); // Localize the error message nsXPIDLString message; if (aFormatStrings) { rv = strBundle->FormatStringFromName(aError, aFormatStrings, aFormatStringsLen, getter_Copies(message)); } else { rv = strBundle->GetStringFromName(aError, getter_Copies(message)); } NS_ENSURE_SUCCESS(rv, rv); // print the error message directly to the JS console rv = console->LogStringMessage(message.get()); NS_ENSURE_SUCCESS(rv, rv); return NS_OK; } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(Close) { nsresult rv; if (mOwner->mReadyState == nsIWebSocket::CONNECTING) { // we must not convey any failure information to scripts, so we just // disconnect and maintain the owner WebSocket object in the CONNECTING // state. Disconnect(); return; } mOwner->SetReadyState(nsIWebSocket::CLOSING); if (!mCloseFrameServerResponseTimer) { mCloseFrameServerResponseTimer = do_CreateInstance("@mozilla.org/timer;1", &rv); if (NS_FAILED(rv)) { NS_WARNING("Failed to create mCloseFrameServerResponseTimer."); } else { rv = mCloseFrameServerResponseTimer-> InitWithFuncCallback(TimerForceCloseCallback, this, TIMEOUT_WAIT_FOR_CLOSING, nsITimer::TYPE_ONE_SHOT); if (NS_FAILED(rv)) { NS_WARNING("Failed to start the ForceClose timeout."); } } } if (mStatus == CONN_CLOSED) { mOwner->SetReadyState(nsIWebSocket::CLOSED); Disconnect(); } else if (!mPostedCloseFrame) { nsAutoPtr closeFrame(new nsCString()); if (!closeFrame.get()) { return; } closeFrame->SetLength(2); if (closeFrame->Length() != 2) { return; } closeFrame->SetCharAt(START_BYTE_OF_CLOSE_FRAME, 0); closeFrame->SetCharAt(END_BYTE_OF_CLOSE_FRAME, 1); rv = PostData(closeFrame.forget(), PR_FALSE); if (NS_FAILED(rv)) { NS_WARNING("Failed to post the close frame"); return; } mPostedCloseFrame = PR_TRUE; } else { // Probably failed to send the close frame. Just disconnect. Disconnect(); } } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END void nsWebSocketEstablishedConnection::ForceClose() { if (mOwner->mReadyState == nsIWebSocket::CONNECTING) { // we must not convey any failure information to scripts, so we just // disconnect and maintain the owner WebSocket object in the CONNECTING // state. Disconnect(); return; } mOwner->SetReadyState(nsIWebSocket::CLOSING); mOwner->SetReadyState(nsIWebSocket::CLOSED); Disconnect(); } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(FailConnection) { nsresult rv; nsWSAutoClose autoClose(this); if (mFailureStatus == NS_OK) { mFailureStatus = NS_ERROR_UNEXPECTED; } nsCAutoString targetSpec; rv = mOwner->mURI->GetSpec(targetSpec); WARN_IF_FALSE_AND_RETURN(NS_SUCCEEDED(rv), "Failed to get targetSpec"); NS_ConvertUTF8toUTF16 specUTF16(targetSpec); const PRUnichar *formatStrings[] = { specUTF16.get() }; if (mStatus < CONN_CONNECTED_AND_READY) { if (mCurrentProxyConfig == eResolvingProxyFailed) { PrintErrorOnConsole("chrome://browser/locale/appstrings.properties", NS_LITERAL_STRING("proxyConnectFailure").get(), nsnull, 0); } PrintErrorOnConsole("chrome://browser/locale/appstrings.properties", NS_LITERAL_STRING("connectionFailure").get(), formatStrings, NS_ARRAY_LENGTH(formatStrings)); } else { PrintErrorOnConsole("chrome://browser/locale/appstrings.properties", NS_LITERAL_STRING("netInterrupt").get(), formatStrings, NS_ARRAY_LENGTH(formatStrings)); } } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END nsresult nsWebSocketEstablishedConnection::Disconnect() { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); { MutexAutoLock lockDisconnect(mLockDisconnect); if (!mOwner) { return NS_OK; } RemoveWSConnecting(); mStatus = CONN_CLOSED; mOwner = nsnull; if (mAuthProvider) { mAuthProvider->Disconnect(NS_ERROR_ABORT); mAuthProvider = nsnull; } if (mTryConnectTimer) { mTryConnectTimer->Cancel(); mTryConnectTimer = nsnull; } if (mInitialServerResponseTimer) { mInitialServerResponseTimer->Cancel(); mInitialServerResponseTimer = nsnull; } if (mCloseFrameServerResponseTimer) { mCloseFrameServerResponseTimer->Cancel(); mCloseFrameServerResponseTimer = nsnull; } if (mProxyResolveCancelable) { mProxyResolveCancelable->Cancel(NS_ERROR_ABORT); mProxyResolveCancelable = nsnull; } if (mDNSRequest) { mDNSRequest->Cancel(NS_ERROR_ABORT); mDNSRequest = nsnull; } if (mSocketInput) { mSocketInput->Close(); mSocketInput = nsnull; } if (mSocketOutput) { mSocketOutput->Close(); mSocketOutput = nsnull; } if (mSocketTransport) { mSocketTransport->Close(NS_OK); mSocketTransport = nsnull; } mProxyInfo = nsnull; while (mOutgoingMessages.GetSize() != 0) { delete static_cast(mOutgoingMessages.PopFront()); } while (mReceivedMessages.GetSize() != 0) { delete static_cast(mReceivedMessages.PopFront()); } // Remove ourselves from the document's load group. nsIRequest expects // this be done asynchronously. nsCOMPtr event = NS_NewRunnableMethod(this, &nsWebSocketEstablishedConnection:: RemoveFromLoadGroup); if (event) { NS_DispatchToMainThread(event, NS_DISPATCH_NORMAL); } nsLayoutStatics::Release(); } return NS_OK; } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(Retry) { nsresult rv; for (PRUint32 i = 0; i < kHeadersLen; ++i) { mHeaders[i].Truncate(); } rv = OnProxyAvailable(nsnull, mOwner->mURI, mProxyInfo, NS_OK); CHECK_SUCCESS_AND_FAIL_IF_FAILED(rv); } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(ResolveNextProxyAndConnect) { nsresult rv; if (mCurrentProxyConfig == eResolvingProxyFailed) { return; } nsCOMPtr proxyService = do_GetService(NS_PROTOCOLPROXYSERVICE_CONTRACTID, &rv); if (NS_FAILED(rv)) { NS_WARNING("Failed getting proxyService"); mCurrentProxyConfig = eResolvingProxyFailed; mFailureStatus = NS_ERROR_UNKNOWN_PROXY_HOST; FailConnection(); return; } if (mProxyInfo) { // If there was already a proxy info it means we tried to connect to its // proxy, but we couldn't. We have to remove the connection from the // serialization list, reset it, and try to get a failover proxy. { MutexAutoLock lockDisconnect(mLockDisconnect); rv = Reset(); CHECK_SUCCESS_AND_FAIL_IF_FAILED(rv); } nsCOMPtr pi; rv = proxyService->GetFailoverForProxy(mProxyInfo, mOwner->mURI, mProxyFailureReason, getter_AddRefs(pi)); if (NS_FAILED(rv)) { mProxyInfo = nsnull; ResolveNextProxyAndConnect(); return; } OnProxyAvailable(nsnull, mOwner->mURI, pi, NS_OK); return; } // if (!mProxyInfo) PRUint32 flags = nsIProtocolProxyService::RESOLVE_IGNORE_URI_SCHEME; if (mCurrentProxyConfig == eNotResolvingProxy) { mCurrentProxyConfig = eResolvingSOCKSProxy; flags |= nsIProtocolProxyService::RESOLVE_PREFER_SOCKS_PROXY; } else if (mCurrentProxyConfig == eResolvingSOCKSProxy) { flags |= nsIProtocolProxyService::RESOLVE_PREFER_HTTPS_PROXY; mCurrentProxyConfig = eResolvingHTTPSProxy; } else if (mCurrentProxyConfig == eResolvingHTTPSProxy) { mCurrentProxyConfig = eResolvingHTTPProxy; } else if (mCurrentProxyConfig == eResolvingHTTPProxy) { mCurrentProxyConfig = eResolvingProxyFailed; mFailureStatus = NS_ERROR_UNKNOWN_PROXY_HOST; FailConnection(); return; } rv = proxyService->AsyncResolve(mOwner->mURI, flags, this, getter_AddRefs(mProxyResolveCancelable)); if (NS_FAILED(rv)) { ResolveNextProxyAndConnect(); return; } } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END void nsWebSocketEstablishedConnection::RemoveFromLoadGroup() { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); nsCOMPtr loadGroup; GetLoadGroup(getter_AddRefs(loadGroup)); if (loadGroup) { loadGroup->RemoveRequest(this, nsnull, NS_OK); } } //----------------------------------------------------------------------------- // Authentication //----------------------------------------------------------------------------- IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_BEGIN(ProcessAuthentication) { nsresult rv = mAuthProvider->ProcessAuthentication(407, PR_FALSE); if (rv == NS_ERROR_IN_PROGRESS) { return; } if (NS_FAILED(rv)) { NS_WARNING("ProcessAuthentication failed"); FailConnection(); return; } Retry(); } IMPL_RUNNABLE_ON_MAIN_THREAD_METHOD_END //----------------------------------------------------------------------------- //----------------------------------------------------------------------------- #define NOT_IMPLEMENTED_IF_FUNC_BEGIN(_func) \ NS_IMETHODIMP \ nsWebSocketEstablishedConnection::_func #define NOT_IMPLEMENTED_IF_FUNC_END(_func) \ { \ return NS_ERROR_NOT_IMPLEMENTED; \ } #define NOT_IMPLEMENTED_IF_FUNC_0(_func) \ NOT_IMPLEMENTED_IF_FUNC_BEGIN(_func) () \ NOT_IMPLEMENTED_IF_FUNC_END(_func) #define NOT_IMPLEMENTED_IF_FUNC_1(_func, _arg) \ NOT_IMPLEMENTED_IF_FUNC_BEGIN(_func) (_arg) \ NOT_IMPLEMENTED_IF_FUNC_END(_func) #define NOT_IMPLEMENTED_IF_FUNC_2(_func, _arg1, arg2) \ NOT_IMPLEMENTED_IF_FUNC_BEGIN(_func) (_arg1, arg2) \ NOT_IMPLEMENTED_IF_FUNC_END(_func) //----------------------------------------------------------------------------- // nsWebSocketEstablishedConnection::nsIRequest //----------------------------------------------------------------------------- NS_IMETHODIMP nsWebSocketEstablishedConnection::GetName(nsACString &aName) { aName = mRequestName; return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::IsPending(PRBool *aValue) { *aValue = !!(mOwner); return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::GetStatus(nsresult *aStatus) { *aStatus = mFailureStatus; return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::Cancel(nsresult aStatus) { if (!mOwner) { return NS_OK; } mFailureStatus = aStatus; return Close(); } NOT_IMPLEMENTED_IF_FUNC_0(Suspend) NOT_IMPLEMENTED_IF_FUNC_0(Resume) NS_IMETHODIMP nsWebSocketEstablishedConnection::GetLoadGroup(nsILoadGroup **aLoadGroup) { *aLoadGroup = nsnull; if (!mOwner) return NS_OK; nsCOMPtr doc = nsContentUtils::GetDocumentFromScriptContext(mOwner->mScriptContext); if (doc) { *aLoadGroup = doc->GetDocumentLoadGroup().get(); // already_AddRefed } return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::SetLoadGroup(nsILoadGroup *aLoadGroup) { return NS_ERROR_UNEXPECTED; } NS_IMETHODIMP nsWebSocketEstablishedConnection::GetLoadFlags(nsLoadFlags *aLoadFlags) { *aLoadFlags = nsIRequest::LOAD_BACKGROUND; return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::SetLoadFlags(nsLoadFlags aLoadFlags) { // we won't change the load flags at all. return NS_OK; } //----------------------------------------------------------------------------- // nsWebSocketEstablishedConnection::nsIChannel //----------------------------------------------------------------------------- NOT_IMPLEMENTED_IF_FUNC_1(GetOriginalURI, nsIURI **originalURI) NOT_IMPLEMENTED_IF_FUNC_1(SetOriginalURI, nsIURI *originalURI) NOT_IMPLEMENTED_IF_FUNC_1(GetOwner, nsISupports **owner) NOT_IMPLEMENTED_IF_FUNC_1(SetOwner, nsISupports *owner) NOT_IMPLEMENTED_IF_FUNC_1(SetNotificationCallbacks, nsIInterfaceRequestor *callbacks) NOT_IMPLEMENTED_IF_FUNC_1(GetSecurityInfo, nsISupports **securityInfo) NOT_IMPLEMENTED_IF_FUNC_1(GetContentType, nsACString &value) NOT_IMPLEMENTED_IF_FUNC_1(SetContentType, const nsACString &value) NOT_IMPLEMENTED_IF_FUNC_1(GetContentCharset, nsACString &value) NOT_IMPLEMENTED_IF_FUNC_1(SetContentCharset, const nsACString &value) NOT_IMPLEMENTED_IF_FUNC_1(GetContentLength, PRInt32 *value) NOT_IMPLEMENTED_IF_FUNC_1(SetContentLength, PRInt32 value) NOT_IMPLEMENTED_IF_FUNC_1(Open, nsIInputStream **_retval) NOT_IMPLEMENTED_IF_FUNC_2(AsyncOpen, nsIStreamListener *listener, nsISupports *context) //----------------------------------------------------------------------------- // nsWebSocketEstablishedConnection::nsIHttpAuthenticableChannel //----------------------------------------------------------------------------- NS_IMETHODIMP nsWebSocketEstablishedConnection::GetProxyInfo(nsIProxyInfo **result) { NS_IF_ADDREF(*result = mProxyInfo); return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::GetIsSSL(PRBool *aIsSSL) { *aIsSSL = mOwner->mSecure; return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::GetProxyMethodIsConnect(PRBool *aProxyMethodIsConnect) { *aProxyMethodIsConnect = UsingHttpProxy(); return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::GetURI(nsIURI **aURI) { NS_IF_ADDREF(*aURI = mOwner->mURI); return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::GetNotificationCallbacks(nsIInterfaceRequestor **callbacks) { NS_ADDREF(*callbacks = this); return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::GetRequestMethod(nsACString &method) { if (mAuthenticating) { method.AssignLiteral("CONNECT"); } else { method.AssignLiteral("GET"); } return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::GetServerResponseHeader(nsACString &value) { if (mHeaders[kServerPos].IsEmpty()) { return NS_ERROR_NOT_AVAILABLE; } value.Assign(mHeaders[kServerPos]); return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::GetProxyChallenges(nsACString &value) { if (mHeaders[kProxyAuthenticatePos].IsEmpty()) { return NS_ERROR_NOT_AVAILABLE; } value.Assign(mHeaders[kProxyAuthenticatePos]); return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::GetWWWChallenges(nsACString &value) { return NS_ERROR_NOT_AVAILABLE; } NS_IMETHODIMP nsWebSocketEstablishedConnection::SetProxyCredentials(const nsACString &value) { mProxyCredentials.Assign(value); return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::SetWWWCredentials(const nsACString &value) { mCredentials.Assign(value); return NS_OK; } NS_IMETHODIMP nsWebSocketEstablishedConnection::OnAuthAvailable() { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); if (!mOwner) { return NS_OK; } return Retry(); } NS_IMETHODIMP nsWebSocketEstablishedConnection::OnAuthCancelled(PRBool userCancel) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); if (!mOwner) { return NS_OK; } if (!userCancel) { return FailConnection(); } return Close(); } //----------------------------------------------------------------------------- // nsWebSocketEstablishedConnection::nsIDNSListener //----------------------------------------------------------------------------- NS_IMETHODIMP nsWebSocketEstablishedConnection::OnLookupComplete(nsICancelable *aRequest, nsIDNSRecord *aRec, nsresult aStatus) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); if (!mOwner) { return NS_ERROR_ABORT; } mDNSRequest = nsnull; mFailureStatus = aStatus; ENSURE_SUCCESS_AND_FAIL_IF_FAILED(aStatus, aStatus); nsresult rv; rv = aRec->GetNextAddr(mOwner->mPort, &mPRNetAddr); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); TryConnect(nsnull, this); return NS_OK; } //----------------------------------------------------------------------------- // nsWebSocketEstablishedConnection::nsIProtocolProxyCallback //----------------------------------------------------------------------------- NS_IMETHODIMP nsWebSocketEstablishedConnection::OnProxyAvailable(nsICancelable *aRequest, nsIURI *aUri, nsIProxyInfo *aProxyInfo, nsresult aStatus) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); nsresult rv; if (!mOwner) { return NS_ERROR_ABORT; } if (NS_FAILED(aStatus)) { return ResolveNextProxyAndConnect(); } mProxyInfo = aProxyInfo; if (mProxyInfo) { TryConnect(nsnull, this); } else { // we need the server IP address because it must connect only one instance // per IP address at a time. nsCOMPtr dns = do_GetService(NS_DNSSERVICE_CONTRACTID, &rv); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); nsCOMPtr thread = do_GetMainThread(); rv = dns->AsyncResolve(mOwner->mAsciiHost, 0, this, thread, getter_AddRefs(mDNSRequest)); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); } return NS_OK; } //----------------------------------------------------------------------------- // nsWebSocketEstablishedConnection::nsIInputStreamCallback methods: //----------------------------------------------------------------------------- nsresult nsWebSocketEstablishedConnection::OnInputStreamReady(nsIAsyncInputStream *aStream) { NS_ASSERTION(!NS_IsMainThread(), "Not running on socket thread"); nsresult rv; { MutexAutoLock lockDisconnect(mLockDisconnect); if (!mOwner) { return NS_ERROR_ABORT; } NS_ASSERTION(aStream == mSocketInput, "unexpected stream"); while (PR_TRUE) { if (mBuffer.Length() - mBytesInBuffer < DEFAULT_BUFFER_SIZE) { PRUint32 newLen = mBuffer.Length() + DEFAULT_BUFFER_SIZE; mBuffer.SetLength(newLen); ENSURE_TRUE_AND_FAIL_IF_FAILED(mBuffer.Length() == newLen, NS_ERROR_OUT_OF_MEMORY); } PRUint32 read; rv = aStream->Read(mBuffer.BeginWriting() + mBytesInBuffer, DEFAULT_BUFFER_SIZE, &read); if (rv == NS_BASE_STREAM_WOULD_BLOCK) { break; } mFailureStatus = rv; ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); // check if the stream has been closed if (read == 0) { // If we are asking for credentials then the old connection has been // closed. In this case we have to reset the WebSocket, not Close it. if (mStatus != CONN_RETRYING_TO_AUTHENTICATE) { mStatus = CONN_CLOSED; if (mStatus < CONN_CONNECTED_AND_READY) { FailConnection(); } else { Close(); } } mFailureStatus = NS_BASE_STREAM_CLOSED; return NS_BASE_STREAM_CLOSED; } PRUint32 start = mBytesInBuffer; mBytesInBuffer += read; rv = HandleNewInputString(start); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); } rv = mSocketInput->AsyncWait(this, 0, 0, gWebSocketThread); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); } return NS_OK; } //----------------------------------------------------------------------------- // nsWebSocketEstablishedConnection::nsIOutputStreamCallback methods: //----------------------------------------------------------------------------- nsresult nsWebSocketEstablishedConnection::OnOutputStreamReady(nsIAsyncOutputStream *aStream) { NS_ASSERTION(!NS_IsMainThread(), "Not running on socket thread"); nsresult rv; { MutexAutoLock lockDisconnect(mLockDisconnect); if (!mOwner) { return NS_ERROR_ABORT; } NS_ASSERTION(aStream == mSocketOutput, "unexpected stream"); { MutexAutoLock lockOut(mLockOutgoingMessages); while (PR_TRUE) { if (mOutgoingMessages.GetSize() == 0) { break; } // send what we can of the 1st string nsCString *strToSend = static_cast(mOutgoingMessages.PeekFront()); PRUint32 sizeToSend = strToSend->Length() - mBytesAlreadySentOfFirstOutString; PRBool currentStrHasStartFrameByte = (mBytesAlreadySentOfFirstOutString == 0); PRBool strIsMessage = (mStatus >= CONN_CONNECTED_AND_READY); if (sizeToSend != 0) { PRUint32 written; rv = aStream->Write(strToSend->get() + mBytesAlreadySentOfFirstOutString, sizeToSend, &written); if (rv == NS_BASE_STREAM_WOULD_BLOCK) { break; } // on proxy errors when connecting, try to failover if ((mStatus == CONN_CONNECTING_TO_HTTP_PROXY || (mStatus == CONN_SENDING_INITIAL_REQUEST && mProxyInfo)) && (rv == NS_ERROR_PROXY_CONNECTION_REFUSED || rv == NS_ERROR_UNKNOWN_PROXY_HOST || rv == NS_ERROR_NET_TIMEOUT || rv == NS_ERROR_NET_RESET)) { mProxyFailureReason = rv; return ResolveNextProxyAndConnect(); } mFailureStatus = rv; ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); if (written == 0) { mStatus = CONN_CLOSED; if (mStatus < CONN_CONNECTED_AND_READY) { FailConnection(); } else { Close(); } mFailureStatus = NS_BASE_STREAM_CLOSED; return NS_BASE_STREAM_CLOSED; } if (strIsMessage) { PRBool currentStrHasEndFrameByte = (mBytesAlreadySentOfFirstOutString + written == strToSend->Length()); // START_BYTE_OF_MESSAGE and END_BYTE_OF_MESSAGE bytes don't count if (currentStrHasStartFrameByte) { if (currentStrHasEndFrameByte) { mOutgoingBufferedAmount -= written - 2; } else { mOutgoingBufferedAmount -= written - 1; } } else { if (currentStrHasEndFrameByte) { mOutgoingBufferedAmount -= written - 1; } else { mOutgoingBufferedAmount -= written; } } } mBytesAlreadySentOfFirstOutString += written; } sizeToSend = strToSend->Length() - mBytesAlreadySentOfFirstOutString; if (sizeToSend != 0) { // if different, we try sending what remain after break; } // ok, send the next string mOutgoingMessages.PopFront(); delete strToSend; mBytesAlreadySentOfFirstOutString = 0; } if (mOutgoingMessages.GetSize() != 0) { rv = mSocketOutput->AsyncWait(this, 0, 0, gWebSocketThread); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); } else { if (mStatus == CONN_SENDING_ACK_CLOSE_FRAME && SentAlreadyTheCloseFrame()) { mClosedCleanly = PR_TRUE; mStatus = CONN_CLOSED; return Close(); } if (mStatus == CONN_SENDING_INITIAL_REQUEST || mStatus == CONN_CONNECTING_TO_HTTP_PROXY) { if (mStatus == CONN_SENDING_INITIAL_REQUEST) { mStatus = CONN_WAITING_RESPONSE_FOR_INITIAL_REQUEST; rv = mInitialServerResponseTimer-> InitWithFuncCallback(TimerInitialServerResponseCallback, this, TIMEOUT_WAIT_FOR_SERVER_RESPONSE, nsITimer::TYPE_ONE_SHOT); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); } rv = mSocketInput->AsyncWait(this, 0, 0, gWebSocketThread); ENSURE_SUCCESS_AND_FAIL_IF_FAILED(rv, rv); } } } } return NS_OK; } //----------------------------------------------------------------------------- // nsWebSocketEstablishedConnection::nsIInterfaceRequestor //----------------------------------------------------------------------------- NS_IMETHODIMP nsWebSocketEstablishedConnection::GetInterface(const nsIID &aIID, void **aResult) { NS_ASSERTION(NS_IsMainThread(), "Not running on main thread"); if (aIID.Equals(NS_GET_IID(nsIAuthPrompt)) || aIID.Equals(NS_GET_IID(nsIAuthPrompt2))) { nsresult rv; nsCOMPtr doc = nsContentUtils::GetDocumentFromScriptContext(mOwner->mScriptContext); if (!doc) { return NS_ERROR_NOT_AVAILABLE; } nsCOMPtr wwatch = do_GetService(NS_WINDOWWATCHER_CONTRACTID, &rv); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr outerWindow = doc->GetWindow(); return wwatch->GetPrompt(outerWindow, aIID, aResult); } return NS_ERROR_UNEXPECTED; } //////////////////////////////////////////////////////////////////////////////// // nsWebSocket //////////////////////////////////////////////////////////////////////////////// nsWebSocket::nsWebSocket() : mReadyState(nsIWebSocket::CONNECTING), mOutgoingBufferedAmount(0) { } nsWebSocket::~nsWebSocket() { if (mListenerManager) { mListenerManager->Disconnect(); mListenerManager = nsnull; } } NS_IMPL_CYCLE_COLLECTION_CLASS(nsWebSocket) NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED(nsWebSocket, nsDOMEventTargetWrapperCache) NS_IMPL_CYCLE_COLLECTION_TRAVERSE_NSCOMPTR(mOnOpenListener) NS_IMPL_CYCLE_COLLECTION_TRAVERSE_NSCOMPTR(mOnMessageListener) NS_IMPL_CYCLE_COLLECTION_TRAVERSE_NSCOMPTR(mOnCloseListener) NS_IMPL_CYCLE_COLLECTION_TRAVERSE_NSCOMPTR(mOnErrorListener) NS_IMPL_CYCLE_COLLECTION_TRAVERSE_NSCOMPTR(mPrincipal) NS_IMPL_CYCLE_COLLECTION_TRAVERSE_NSCOMPTR(mURI) NS_CYCLE_COLLECTION_NOTE_EDGE_NAME(cb, "mConnection"); cb.NoteXPCOMChild(static_cast(tmp->mConnection)); NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN_INHERITED(nsWebSocket, nsDOMEventTargetWrapperCache) NS_IMPL_CYCLE_COLLECTION_UNLINK_NSCOMPTR(mOnOpenListener) NS_IMPL_CYCLE_COLLECTION_UNLINK_NSCOMPTR(mOnMessageListener) NS_IMPL_CYCLE_COLLECTION_UNLINK_NSCOMPTR(mOnCloseListener) NS_IMPL_CYCLE_COLLECTION_UNLINK_NSCOMPTR(mOnErrorListener) NS_IMPL_CYCLE_COLLECTION_UNLINK_NSCOMPTR(mPrincipal) NS_IMPL_CYCLE_COLLECTION_UNLINK_NSCOMPTR(mURI) if (tmp->mConnection) { tmp->mConnection->Disconnect(); tmp->mConnection = nsnull; } NS_IMPL_CYCLE_COLLECTION_UNLINK_END DOMCI_DATA(WebSocket, nsWebSocket) NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION_INHERITED(nsWebSocket) NS_INTERFACE_MAP_ENTRY(nsIWebSocket) NS_INTERFACE_MAP_ENTRY(nsIJSNativeInitializer) NS_DOM_INTERFACE_MAP_ENTRY_CLASSINFO(WebSocket) NS_INTERFACE_MAP_END_INHERITING(nsDOMEventTargetWrapperCache) NS_IMPL_ADDREF_INHERITED(nsWebSocket, nsDOMEventTargetWrapperCache) NS_IMPL_RELEASE_INHERITED(nsWebSocket, nsDOMEventTargetWrapperCache) //----------------------------------------------------------------------------- // nsWebSocket::nsIJSNativeInitializer methods: //----------------------------------------------------------------------------- /** * This Initialize method is called from XPConnect via nsIJSNativeInitializer. * It is used for constructing our nsWebSocket from JavaScript. It expects a URL * string parameter and an optional protocol parameter. It also initializes the * principal, the script context and the window owner. */ NS_IMETHODIMP nsWebSocket::Initialize(nsISupports* aOwner, JSContext* aContext, JSObject* aObject, PRUint32 aArgc, jsval* aArgv) { nsAutoString urlParam, protocolParam; PRBool prefEnabled = nsContentUtils::GetBoolPref("network.websocket.enabled", PR_TRUE); if (!prefEnabled) { return NS_ERROR_DOM_SECURITY_ERR; } if (aArgc != 1 && aArgc != 2) { return NS_ERROR_DOM_SYNTAX_ERR; } JSAutoRequest ar(aContext); JSString* jsstr = JS_ValueToString(aContext, aArgv[0]); if (!jsstr) { return NS_ERROR_DOM_SYNTAX_ERR; } urlParam.Assign(reinterpret_cast(JS_GetStringChars(jsstr)), JS_GetStringLength(jsstr)); if (aArgc == 2) { jsstr = JS_ValueToString(aContext, aArgv[1]); if (!jsstr) { return NS_ERROR_DOM_SYNTAX_ERR; } protocolParam. Assign(reinterpret_cast(JS_GetStringChars(jsstr)), JS_GetStringLength(jsstr)); if (protocolParam.IsEmpty()) { return NS_ERROR_DOM_SYNTAX_ERR; } } nsCOMPtr ownerWindow = do_QueryInterface(aOwner); NS_ENSURE_STATE(ownerWindow); nsCOMPtr sgo = do_QueryInterface(aOwner); NS_ENSURE_STATE(sgo); nsCOMPtr scriptContext = sgo->GetContext(); NS_ENSURE_STATE(scriptContext); nsCOMPtr scriptPrincipal(do_QueryInterface(aOwner)); NS_ENSURE_STATE(scriptPrincipal); nsCOMPtr principal = scriptPrincipal->GetPrincipal(); NS_ENSURE_STATE(principal); return Init(principal, scriptContext, ownerWindow, urlParam, protocolParam); } //----------------------------------------------------------------------------- // nsWebSocket methods: //----------------------------------------------------------------------------- nsresult nsWebSocket::EstablishConnection() { NS_ASSERTION(!mConnection, "mConnection should be null"); nsresult rv; nsRefPtr conn = new nsWebSocketEstablishedConnection(); NS_ENSURE_TRUE(conn, NS_ERROR_OUT_OF_MEMORY); rv = conn->Init(this); NS_ENSURE_SUCCESS(rv, rv); mConnection = conn; return NS_OK; } class nsWSCloseEvent : public nsRunnable { public: nsWSCloseEvent(nsWebSocket *aWebSocket, PRBool aWasClean) : mWebSocket(aWebSocket), mWasClean(aWasClean) {} NS_IMETHOD Run() { return mWebSocket->CreateAndDispatchCloseEvent(mWasClean); } private: nsRefPtr mWebSocket; PRBool mWasClean; }; nsresult nsWebSocket::CreateAndDispatchSimpleEvent(const nsString& aName) { nsresult rv; rv = CheckInnerWindowCorrectness(); if (NS_FAILED(rv)) { return NS_OK; } nsCOMPtr event; rv = NS_NewDOMEvent(getter_AddRefs(event), nsnull, nsnull); NS_ENSURE_SUCCESS(rv, rv); // it doesn't bubble, and it isn't cancelable rv = event->InitEvent(aName, PR_FALSE, PR_FALSE); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr privateEvent = do_QueryInterface(event); rv = privateEvent->SetTrusted(PR_TRUE); NS_ENSURE_SUCCESS(rv, rv); return DispatchDOMEvent(nsnull, event, nsnull, nsnull); } nsresult nsWebSocket::CreateAndDispatchMessageEvent(nsCString *aData) { nsresult rv; rv = CheckInnerWindowCorrectness(); if (NS_FAILED(rv)) { return NS_OK; } // create an event that uses the MessageEvent interface, // which does not bubble, is not cancelable, and has no default action nsCOMPtr event; rv = NS_NewDOMMessageEvent(getter_AddRefs(event), nsnull, nsnull); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr messageEvent = do_QueryInterface(event); rv = messageEvent->InitMessageEvent(NS_LITERAL_STRING("message"), PR_FALSE, PR_FALSE, NS_ConvertUTF8toUTF16(*aData), NS_ConvertUTF8toUTF16(mOrigin), EmptyString(), nsnull); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr privateEvent = do_QueryInterface(event); rv = privateEvent->SetTrusted(PR_TRUE); NS_ENSURE_SUCCESS(rv, rv); return DispatchDOMEvent(nsnull, event, nsnull, nsnull); } nsresult nsWebSocket::CreateAndDispatchCloseEvent(PRBool aWasClean) { nsresult rv; rv = CheckInnerWindowCorrectness(); if (NS_FAILED(rv)) { return NS_OK; } // create an event that uses the CloseEvent interface, // which does not bubble, is not cancelable, and has no default action nsCOMPtr event; rv = NS_NewDOMCloseEvent(getter_AddRefs(event), nsnull, nsnull); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr closeEvent = do_QueryInterface(event); rv = closeEvent->InitCloseEvent(NS_LITERAL_STRING("close"), PR_FALSE, PR_FALSE, aWasClean); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr privateEvent = do_QueryInterface(event); rv = privateEvent->SetTrusted(PR_TRUE); NS_ENSURE_SUCCESS(rv, rv); return DispatchDOMEvent(nsnull, event, nsnull, nsnull); } void nsWebSocket::SetReadyState(PRUint16 aNewReadyState) { nsresult rv; if (mReadyState == aNewReadyState) { return; } NS_ASSERTION((aNewReadyState == nsIWebSocket::OPEN) || (aNewReadyState == nsIWebSocket::CLOSING) || (aNewReadyState == nsIWebSocket::CLOSED), "unexpected readyState"); if (aNewReadyState == nsIWebSocket::OPEN) { NS_ASSERTION(mReadyState == nsIWebSocket::CONNECTING, "unexpected readyState transition"); mReadyState = aNewReadyState; rv = CreateAndDispatchSimpleEvent(NS_LITERAL_STRING("open")); if (NS_FAILED(rv)) { NS_WARNING("Failed to dispatch the open event"); } return; } if (aNewReadyState == nsIWebSocket::CLOSING) { NS_ASSERTION((mReadyState == nsIWebSocket::CONNECTING) || (mReadyState == nsIWebSocket::OPEN), "unexpected readyState transition"); mReadyState = aNewReadyState; return; } if (aNewReadyState == nsIWebSocket::CLOSED) { NS_ASSERTION(mReadyState == nsIWebSocket::CLOSING, "unexpected readyState transition"); mReadyState = aNewReadyState; // The close event must be dispatched asynchronously. nsCOMPtr event = new nsWSCloseEvent(this, mConnection->ClosedCleanly()); mOutgoingBufferedAmount += mConnection->GetOutgoingBufferedAmount(); mConnection = nsnull; // this is no longer necessary rv = NS_DispatchToMainThread(event, NS_DISPATCH_NORMAL); if (NS_FAILED(rv)) { NS_WARNING("Failed to dispatch the close event"); } } } nsresult nsWebSocket::ParseURL(const nsString& aURL) { nsresult rv; NS_ENSURE_TRUE(!aURL.IsEmpty(), NS_ERROR_DOM_SYNTAX_ERR); nsCOMPtr uri; rv = NS_NewURI(getter_AddRefs(uri), aURL); NS_ENSURE_SUCCESS(rv, NS_ERROR_DOM_SYNTAX_ERR); nsCOMPtr parsedURL(do_QueryInterface(uri, &rv)); NS_ENSURE_SUCCESS(rv, NS_ERROR_DOM_SYNTAX_ERR); nsCAutoString fragment; rv = parsedURL->GetRef(fragment); NS_ENSURE_TRUE(NS_SUCCEEDED(rv) && fragment.IsEmpty(), NS_ERROR_DOM_SYNTAX_ERR); nsCAutoString scheme; rv = parsedURL->GetScheme(scheme); NS_ENSURE_TRUE(NS_SUCCEEDED(rv) && !scheme.IsEmpty(), NS_ERROR_DOM_SYNTAX_ERR); nsCAutoString host; rv = parsedURL->GetAsciiHost(host); NS_ENSURE_TRUE(NS_SUCCEEDED(rv) && !host.IsEmpty(), NS_ERROR_DOM_SYNTAX_ERR); PRInt32 port; rv = parsedURL->GetPort(&port); NS_ENSURE_SUCCESS(rv, NS_ERROR_DOM_SYNTAX_ERR); rv = NS_CheckPortSafety(port, scheme.get()); NS_ENSURE_SUCCESS(rv, NS_ERROR_DOM_SYNTAX_ERR); nsCAutoString filePath; rv = parsedURL->GetFilePath(filePath); if (filePath.IsEmpty()) { filePath.AssignLiteral("/"); } NS_ENSURE_SUCCESS(rv, NS_ERROR_DOM_SYNTAX_ERR); nsCAutoString query; rv = parsedURL->GetQuery(query); NS_ENSURE_SUCCESS(rv, NS_ERROR_DOM_SYNTAX_ERR); nsXPIDLCString origin; rv = mPrincipal->GetOrigin(getter_Copies(origin)); NS_ENSURE_SUCCESS(rv, NS_ERROR_DOM_SYNTAX_ERR); if (scheme.LowerCaseEqualsLiteral("ws")) { mSecure = PR_FALSE; mPort = (port == -1) ? DEFAULT_WS_SCHEME_PORT : port; } else if (scheme.LowerCaseEqualsLiteral("wss")) { mSecure = PR_TRUE; mPort = (port == -1) ? DEFAULT_WSS_SCHEME_PORT : port; } else { return NS_ERROR_DOM_SYNTAX_ERR; } mOrigin = origin; ToLowerCase(mOrigin); mAsciiHost = host; ToLowerCase(mAsciiHost); mResource = filePath; if (!query.IsEmpty()) { mResource.AppendLiteral("?"); mResource.Append(query); } PRUint32 length = mResource.Length(); PRUint32 i; for (i = 0; i < length; ++i) { if (mResource[i] < static_cast(0x0021) || mResource[i] > static_cast(0x007E)) { return NS_ERROR_DOM_SYNTAX_ERR; } } mOriginalURL = aURL; mURI = parsedURL; return NS_OK; } nsresult nsWebSocket::SetProtocol(const nsString& aProtocol) { if (aProtocol.IsEmpty()) { return NS_ERROR_DOM_SYNTAX_ERR; } PRUint32 length = aProtocol.Length(); PRUint32 i; for (i = 0; i < length; ++i) { if (aProtocol[i] < static_cast(0x0020) || aProtocol[i] > static_cast(0x007E)) { return NS_ERROR_DOM_SYNTAX_ERR; } } CopyUTF16toUTF8(aProtocol, mProtocol); return NS_OK; } //----------------------------------------------------------------------------- // nsWebSocket::nsIWebSocket methods: //----------------------------------------------------------------------------- NS_IMETHODIMP nsWebSocket::GetUrl(nsAString& aURL) { aURL = mOriginalURL; return NS_OK; } NS_IMETHODIMP nsWebSocket::GetReadyState(PRUint16 *aReadyState) { *aReadyState = mReadyState; return NS_OK; } NS_IMETHODIMP nsWebSocket::GetBufferedAmount(PRUint32 *aBufferedAmount) { if (!mConnection) { *aBufferedAmount = mOutgoingBufferedAmount; } else { *aBufferedAmount = mConnection->GetOutgoingBufferedAmount(); } return NS_OK; } #define NS_WEBSOCKET_IMPL_DOMEVENTLISTENER(_eventlistenername, _eventlistener) \ NS_IMETHODIMP \ nsWebSocket::GetOn##_eventlistenername(nsIDOMEventListener * *aEventListener)\ { \ return GetInnerEventListener(_eventlistener, aEventListener); \ } \ \ NS_IMETHODIMP \ nsWebSocket::SetOn##_eventlistenername(nsIDOMEventListener * aEventListener) \ { \ return RemoveAddEventListener(NS_LITERAL_STRING(#_eventlistenername), \ _eventlistener, aEventListener); \ } NS_WEBSOCKET_IMPL_DOMEVENTLISTENER(open, mOnOpenListener) NS_WEBSOCKET_IMPL_DOMEVENTLISTENER(error, mOnErrorListener) NS_WEBSOCKET_IMPL_DOMEVENTLISTENER(message, mOnMessageListener) NS_WEBSOCKET_IMPL_DOMEVENTLISTENER(close, mOnCloseListener) NS_IMETHODIMP nsWebSocket::Send(const nsAString& aData, PRBool *aRet) { *aRet = PR_FALSE; if (mReadyState == nsIWebSocket::CONNECTING) { return NS_ERROR_DOM_INVALID_STATE_ERR; } // We need to check if there isn't unpaired surrogates. PRUint32 i, length = aData.Length(); for (i = 0; i < length; ++i) { if (NS_IS_LOW_SURROGATE(aData[i])) { return NS_ERROR_DOM_SYNTAX_ERR; } if (NS_IS_HIGH_SURROGATE(aData[i])) { if (i + 1 == length || !NS_IS_LOW_SURROGATE(aData[i + 1])) { return NS_ERROR_DOM_SYNTAX_ERR; } ++i; continue; } } if (mReadyState == nsIWebSocket::CLOSING || mReadyState == nsIWebSocket::CLOSED) { mOutgoingBufferedAmount += NS_ConvertUTF16toUTF8(aData).Length(); return NS_OK; } nsresult rv = mConnection->PostMessage(PromiseFlatString(aData)); *aRet = NS_SUCCEEDED(rv); return NS_OK; } NS_IMETHODIMP nsWebSocket::Close() { if (mReadyState == nsIWebSocket::CLOSING || mReadyState == nsIWebSocket::CLOSED) { return NS_OK; } if (mReadyState == nsIWebSocket::CONNECTING) { mConnection->FailConnection(); // We need to set the readyState here because mConnection would set it // only if first connected. Also, let the two readyState changes here // for future extensions (for instance an onreadystatechange event) SetReadyState(nsIWebSocket::CLOSING); SetReadyState(nsIWebSocket::CLOSED); return NS_OK; } // mReadyState == nsIWebSocket::OPEN mConnection->Close(); return NS_OK; } /** * This Init method should only be called by C++ consumers. */ NS_IMETHODIMP nsWebSocket::Init(nsIPrincipal* aPrincipal, nsIScriptContext* aScriptContext, nsPIDOMWindow* aOwnerWindow, const nsAString& aURL, const nsAString& aProtocol) { nsresult rv; NS_ENSURE_ARG(aPrincipal); PRBool prefEnabled = nsContentUtils::GetBoolPref("network.websocket.enabled", PR_TRUE); if (!prefEnabled) { return NS_ERROR_DOM_SECURITY_ERR; } mPrincipal = aPrincipal; mScriptContext = aScriptContext; if (aOwnerWindow) { mOwner = aOwnerWindow->GetCurrentInnerWindow(); } else { mOwner = nsnull; } // parses the url rv = ParseURL(PromiseFlatString(aURL)); NS_ENSURE_SUCCESS(rv, rv); // sets the protocol if (!aProtocol.IsEmpty()) { rv = SetProtocol(PromiseFlatString(aProtocol)); NS_ENSURE_SUCCESS(rv, rv); } // the constructor should throw a SYNTAX_ERROR only if it fails to parse the // url parameter, so we don't care about the EstablishConnection result. EstablishConnection(); return NS_OK; } // static void nsWebSocket::ReleaseGlobals() { if (nsWebSocketEstablishedConnection::sWSsConnecting) { nsWebSocketEstablishedConnection::sWSsConnecting->Clear(); delete nsWebSocketEstablishedConnection::sWSsConnecting; nsWebSocketEstablishedConnection::sWSsConnecting = nsnull; } if (gWebSocketThread) { gWebSocketThread->Shutdown(); NS_RELEASE(gWebSocketThread); } } //////////////////////////////////////////////////////////////////////////////// // nsWSProtocolHandler //////////////////////////////////////////////////////////////////////////////// NS_IMPL_ISUPPORTS2(nsWSProtocolHandler, nsIProtocolHandler, nsIProxiedProtocolHandler) NS_IMETHODIMP nsWSProtocolHandler::GetScheme(nsACString& aScheme) { aScheme.AssignLiteral("ws"); return NS_OK; } NS_IMETHODIMP nsWSProtocolHandler::GetDefaultPort(PRInt32 *aDefaultPort) { *aDefaultPort = DEFAULT_WS_SCHEME_PORT; return NS_OK; } NS_IMETHODIMP nsWSProtocolHandler::GetProtocolFlags(PRUint32 *aProtocolFlags) { *aProtocolFlags = URI_STD | URI_NON_PERSISTABLE | URI_DOES_NOT_RETURN_DATA | ALLOWS_PROXY | ALLOWS_PROXY_HTTP | URI_DANGEROUS_TO_LOAD; return NS_OK; } NS_IMETHODIMP nsWSProtocolHandler::NewURI(const nsACString& aSpec, const char *aCharset, nsIURI *aBaseURI, nsIURI **aURI) { nsresult rv; nsCOMPtr url(do_CreateInstance(NS_STANDARDURL_CONTRACTID, &rv)); NS_ENSURE_SUCCESS(rv, rv); PRInt32 defaultPort; GetDefaultPort(&defaultPort); rv = url->Init(nsIStandardURL::URLTYPE_AUTHORITY, defaultPort, aSpec, aCharset, aBaseURI); NS_ENSURE_SUCCESS(rv, rv); rv = CallQueryInterface(url, aURI); NS_ENSURE_SUCCESS(rv, rv); return NS_OK; } NS_IMETHODIMP nsWSProtocolHandler::NewChannel(nsIURI *aURI, nsIChannel **aChannel) { return NS_ERROR_NOT_AVAILABLE; } NS_IMETHODIMP nsWSProtocolHandler::NewProxiedChannel(nsIURI *aURI, nsIProxyInfo* aProxyInfo, nsIChannel **aChannel) { return NS_ERROR_NOT_AVAILABLE; } NS_IMETHODIMP nsWSProtocolHandler::AllowPort(PRInt32 aPort, const char *aScheme, PRBool *aAllowPort) { PRInt32 defaultPort; GetDefaultPort(&defaultPort); *aAllowPort = (aPort == defaultPort); return NS_OK; } //////////////////////////////////////////////////////////////////////////////// // nsWSSProtocolHandler //////////////////////////////////////////////////////////////////////////////// NS_IMETHODIMP nsWSSProtocolHandler::GetScheme(nsACString& aScheme) { aScheme.AssignLiteral("wss"); return NS_OK; } NS_IMETHODIMP nsWSSProtocolHandler::GetDefaultPort(PRInt32 *aDefaultPort) { *aDefaultPort = DEFAULT_WSS_SCHEME_PORT; return NS_OK; }