Bug 954108 - Implement a general Sockets object for JavaScript protocols, r=florian.
This commit is contained in:
Patrick Cloke
Родитель
1ab5e37e9a
Коммит
5dd55c71d1
|
|
@ -0,0 +1,474 @@
|
|||
/* ***** 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 JSIRC Library
|
||||
*
|
||||
* The Initial Developer of the Original Code is New Dimensions Consulting, Inc.
|
||||
* Portions created by the Initial Developer are Copyright (C) 1999
|
||||
* the Initial Developer. All Rights Reserved.
|
||||
*
|
||||
* Contributor(s):
|
||||
* Robert Ginda, <rginda@ndcico.com>, original author
|
||||
* Peter Van der Beken, <peter.vanderbeken@pandora.be>, necko-only version
|
||||
* Stephen Clavering <mozilla@clav.me.uk>, extensively rewritten for
|
||||
* MSNMessenger (http://msnmsgr.mozdev.org/)
|
||||
* Benoît Renard <benoit@gawab.com>, MSNMessenger
|
||||
* Patrick Cloke, <clokep@gmail.com>, updated, extended and generalized for
|
||||
* Instantbird (http://www.instantbird.com)
|
||||
*
|
||||
* Alternatively, the contents of this file may be used under the terms of
|
||||
* either 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 ***** */
|
||||
|
||||
/*
|
||||
* Combines a lot of the Mozilla networking interfaces into a sane interface for
|
||||
* simple(r) use of sockets code.
|
||||
*
|
||||
* This implements nsIServerSocketListener, nsIStreamListener,
|
||||
* nsIRequestObserver, nsITransportEventSink, nsIBadCertListener2,
|
||||
* nsISSLErrorListener, and nsIProtocolProxyCallback.
|
||||
*
|
||||
* This uses nsISocketTransportServices, nsIServerSocket, nsIThreadManager,
|
||||
* nsIBinaryInputStream, nsIScriptableInputStream, nsIInputStreamPump,
|
||||
* nsIProxyService, nsIProxyInfo.
|
||||
*
|
||||
* High-level methods:
|
||||
* .connect(<host>, <port>[, ("starttls" | "ssl" | "udp") [, <proxy>]])
|
||||
* .disconnect()
|
||||
* .reconnect()
|
||||
* .listen(port)
|
||||
* .send(String data)
|
||||
* .isAlive()
|
||||
* High-level properties:
|
||||
* XXX Need to include properties here
|
||||
*
|
||||
* Users should "subclass" this object, i.e. set their .__proto__ to be it. And
|
||||
* then implement:
|
||||
* onConnection()
|
||||
* onConnectionHeard()
|
||||
* onConnectionTimedOut()
|
||||
* onConnectionReset()
|
||||
* onDataReceived(data)
|
||||
* onBinaryDataReceived(ArrayBuffer data, int length)
|
||||
* onTransportStatus(nsISocketTransport transport, nsresult status,
|
||||
* unsigned long progress, unsigned longprogressMax)
|
||||
* log(message)
|
||||
*/
|
||||
|
||||
/*
|
||||
* To Do:
|
||||
* Add a message queue to keep from flooding a server (just an array, just
|
||||
* keep shifting the first element off and calling as setTimeout for the
|
||||
* desired flood time?).
|
||||
*/
|
||||
|
||||
var EXPORTED_SYMBOLS = ["Socket"];
|
||||
|
||||
const {classes: Cc, interfaces: Ci, results: Cr, utils: Cu} = Components;
|
||||
Cu.import("resource://gre/modules/Services.jsm");
|
||||
|
||||
// Network errors see: netwerk/base/public/nsNetError.h
|
||||
const NS_ERROR_MODULE_NETWORK = 2152398848;
|
||||
const NS_ERROR_CONNECTION_REFUSED = NS_ERROR_MODULE_NETWORK + 13;
|
||||
const NS_ERROR_NET_TIMEOUT = NS_ERROR_MODULE_NETWORK + 14;
|
||||
const NS_ERROR_NET_RESET = NS_ERROR_MODULE_NETWORK + 20;
|
||||
const NS_ERROR_UNKNOWN_HOST = NS_ERROR_MODULE_NETWORK + 30;
|
||||
const NS_ERROR_UNKNOWN_PROXY_HOST = NS_ERROR_MODULE_NETWORK + 42;
|
||||
const NS_ERROR_PROXY_CONNECTION_REFUSED = NS_ERROR_MODULE_NETWORK + 72;
|
||||
|
||||
const BinaryInputStream =
|
||||
Components.Constructor("@mozilla.org/binaryinputstream;1",
|
||||
"nsIBinaryInputStream", "setInputStream");
|
||||
const BinaryOutputStream =
|
||||
Components.Constructor("@mozilla.org/binaryoutputstream;1",
|
||||
"nsIBinaryOutputStream", "setOutputStream");
|
||||
const ScriptableInputStream =
|
||||
Components.Constructor("@mozilla.org/scriptableinputstream;1",
|
||||
"nsIScriptableInputStream", "init");
|
||||
const ServerSocket =
|
||||
Components.Constructor("@mozilla.org/network/server-socket;1",
|
||||
"nsIServerSocket", "init");
|
||||
const InputStreamPump =
|
||||
Components.Constructor("@mozilla.org/network/input-stream-pump;1",
|
||||
"nsIInputStreamPump", "init");
|
||||
|
||||
const Socket = {
|
||||
// Use this to use binary mode for the
|
||||
binaryMode: false,
|
||||
|
||||
// Set this for non-binary mode to automatically parse the stream into chunks
|
||||
// separated by delimiter.
|
||||
delimiter: null,
|
||||
|
||||
// Set this for binary mode to split after a certain number of bytes have
|
||||
// been received.
|
||||
inputSegmentSize: 0,
|
||||
|
||||
// Set this for the segment size of outgoing binary streams.
|
||||
outputSegmentSize: 0,
|
||||
|
||||
// Use this to specify a URI scheme to the hostname when resolving the proxy,
|
||||
// this may be unnecessary for some protocols.
|
||||
uriScheme: "http://",
|
||||
|
||||
// Flags used by nsIProxyService when resolving a proxy.
|
||||
proxyFlags: Ci.nsIProtocolProxyService.RESOLVE_PREFER_SOCKS_PROXY,
|
||||
|
||||
// Time for nsISocketTransport to continue trying before reporting a failure,
|
||||
// 0 is forever.
|
||||
connectTimeout: 0,
|
||||
readWriteTimeout: 0,
|
||||
|
||||
/*
|
||||
*****************************************************************************
|
||||
******************************* Public methods ******************************
|
||||
*****************************************************************************
|
||||
*/
|
||||
// Synchronously open a connection.
|
||||
connect: function(aHost, aPort, aSecurity, aProxy) {
|
||||
this.log("Connecting to: " + aHost + ":" + aPort);
|
||||
this.host = aHost;
|
||||
this.port = aPort;
|
||||
|
||||
// Array of security options
|
||||
this.security = aSecurity || [];
|
||||
|
||||
// Choose a proxy, use the given one, otherwise get one from the proxy
|
||||
// service
|
||||
if (aProxy)
|
||||
this._createTransport(aProxy);
|
||||
else {
|
||||
try {
|
||||
// Attempt to get a default proxy from the proxy service.
|
||||
let proxyService = Cc["@mozilla.org/network/protocol-proxy-service;1"]
|
||||
.getService(Ci.nsIProtocolProxyService);
|
||||
|
||||
// Add a URI scheme since, by default, some protocols (i.e. IRC) don't
|
||||
// have a URI scheme before the host.
|
||||
let uri = Services.io.newURI(this.uriScheme + this.host, null, null);
|
||||
this._proxyCancel = proxyService.asyncResolve(uri, this.proxyFlags, this);
|
||||
} catch(e) {
|
||||
// We had some error getting the proxy service, just don't use one.
|
||||
this._createTransport(null);
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
// Reconnect to the current settings stored in the socket.
|
||||
reconnect: function() {
|
||||
// If there's nothing to reconnect to or we're connected, do nothing
|
||||
if (!this.isAlive() && this.host && this.port) {
|
||||
this.disconnect();
|
||||
this.connect(this.host, this.port, this.security, this.proxy);
|
||||
}
|
||||
},
|
||||
|
||||
// Disconnect all open streams.
|
||||
disconnect: function() {
|
||||
this.log("Disconnect");
|
||||
|
||||
// Close all input and output streams.
|
||||
if ("_inputStream" in this) {
|
||||
this._inputStream.close();
|
||||
delete this._inputStream;
|
||||
}
|
||||
if ("_outputStream" in this) {
|
||||
this._outputStream.close();
|
||||
delete this._outputStream;
|
||||
}
|
||||
if ("transport" in this) {
|
||||
this.transport.close(Cr.NS_OK);
|
||||
delete this.transport;
|
||||
}
|
||||
|
||||
if ("_proxyCancel" in this) {
|
||||
this._proxyCancel.cancel(Cr.NS_ERROR_ABORT); // Has to give a failure code
|
||||
delete this._proxyCancel;
|
||||
}
|
||||
},
|
||||
|
||||
// Listen for a connection on a port.
|
||||
// XXX take a timeout and then call stopListening
|
||||
listen: function(port) {
|
||||
this.log("Listening on port " + port);
|
||||
|
||||
this.serverSocket = new ServerSocket(port, false, -1);
|
||||
this.serverSocket.asyncListen(this);
|
||||
},
|
||||
|
||||
// Stop listening for a connection.
|
||||
stopListening: function() {
|
||||
this.log("Stop listening");
|
||||
// Close the socket to stop listening.
|
||||
if ("serverSocket" in this)
|
||||
this.serverSocket.close();
|
||||
},
|
||||
|
||||
// Send data on the output stream.
|
||||
sendData: function(/* string */ aData) {
|
||||
this.log("Send data: <" + aData + ">");
|
||||
|
||||
try {
|
||||
this._outputStream.write(aData + this.delimiter,
|
||||
aData.length + this.delimiter.length);
|
||||
} catch(e) {
|
||||
Cu.reportError(e);
|
||||
}
|
||||
},
|
||||
|
||||
sendBinaryData: function(/* ArrayBuffer */ aData) {
|
||||
this.log("Sending binary data data: <" + aData + ">");
|
||||
|
||||
let uint8 = Uint8Array(aData);
|
||||
|
||||
// Since there doesn't seem to be a uint8.get() method for the byte array
|
||||
let byteArray = [];
|
||||
for (let i = 0; i < uint8.byteLength; i++)
|
||||
byteArray.push(uint8[i]);
|
||||
try {
|
||||
// Send the data as a byte array
|
||||
this._binaryOutputStream.writeByteArray(byteArray, byteArray.length);
|
||||
} catch(e) {
|
||||
Cu.reportError(e);
|
||||
}
|
||||
},
|
||||
|
||||
isAlive: function() {
|
||||
if (!this.transport)
|
||||
return false;
|
||||
return this.transport.isAlive();
|
||||
},
|
||||
|
||||
/*
|
||||
*****************************************************************************
|
||||
***************************** Interface methods *****************************
|
||||
*****************************************************************************
|
||||
*/
|
||||
/*
|
||||
* nsIProtocolProxyCallback methods
|
||||
*/
|
||||
onProxyAvailable: function(aRequest, aURI, aProxyInfo, aStatus) {
|
||||
this._createTransport(aProxyInfo);
|
||||
delete this._proxyCancel;
|
||||
},
|
||||
|
||||
/*
|
||||
* nsIServerSocketListener methods
|
||||
*/
|
||||
// Called after a client connection is accepted when we're listening for one.
|
||||
onSocketAccepted: function(aServerSocket, aTransport) {
|
||||
this.log("onSocketAccepted");
|
||||
// Store the values
|
||||
this.transport = aTransport;
|
||||
this.host = this.transport.host;
|
||||
this.port = this.transport.port;
|
||||
|
||||
this._resetBuffers();
|
||||
this._openStreams();
|
||||
|
||||
this.onConnectionHeard();
|
||||
this.stopListening();
|
||||
},
|
||||
// Called when the listening socket stops for some reason.
|
||||
// The server socket is effectively dead after this notification.
|
||||
onStopListening: function(aSocket, aStatus) {
|
||||
this.log("onStopListening");
|
||||
if ("serverSocket" in this)
|
||||
delete this.serverSocket;
|
||||
},
|
||||
|
||||
/*
|
||||
* nsIStreamListener methods
|
||||
*/
|
||||
// onDataAvailable, called by Mozilla's networking code.
|
||||
// Buffers the data, and parses it into discrete messages.
|
||||
onDataAvailable: function(aRequest, aContext, aInputStream, aOffset, aCount) {
|
||||
if (this.binaryMode) {
|
||||
// Load the data from the stream
|
||||
this._incomingDataBuffer = this._incomingDataBuffer
|
||||
.concat(this._binaryInputStream
|
||||
.readByteArray(aCount));
|
||||
|
||||
let size = this.inputSegmentSize || this._incomingDataBuffer.length;
|
||||
this.log(size + " " + this._incomingDataBuffer.length);
|
||||
while (this._incomingDataBuffer.length >= size) {
|
||||
let buffer = new ArrayBuffer(size);
|
||||
|
||||
// Create a new ArraybufferView
|
||||
let uintArray = new Uint8Array(buffer);
|
||||
|
||||
// Set the data into the array while saving the extra data
|
||||
uintArray.set(this._incomingDataBuffer.splice(0, size));
|
||||
|
||||
// Notify we've received data
|
||||
this.onBinaryDataReceived(buffer);
|
||||
}
|
||||
} else {
|
||||
if (this.delimiter) {
|
||||
// Load the data from the stream
|
||||
this._incomingDataBuffer += this._scriptableInputStream.read(aCount);
|
||||
let data = this._incomingDataBuffer.split(this.delimiter);
|
||||
|
||||
// Store the (possibly) incomplete part
|
||||
this._incomingDataBuffer = data.pop();
|
||||
|
||||
// Send each string to the handle data function
|
||||
data.forEach(this.onDataReceived, this);
|
||||
} else {
|
||||
// Send the whole string to the handle data function
|
||||
this.onDataReceived(this._scriptableInputStream.read(aCount));
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
/*
|
||||
* nsIRequestObserver methods
|
||||
*/
|
||||
// Signifies the beginning of an async request
|
||||
onStartRequest: function(aRequest, aContext) {
|
||||
this.log("onStartRequest");
|
||||
},
|
||||
// Called to signify the end of an asynchronous request.
|
||||
onStopRequest: function(aRequest, aContext, aStatus) {
|
||||
this.log("onStopRequest (" + aStatus + ")");
|
||||
if (aStatus == NS_ERROR_NET_RESET)
|
||||
this.onConnectionReset();
|
||||
},
|
||||
|
||||
/*
|
||||
* nsIBadCertListener2
|
||||
*/
|
||||
// Called when there's an error, return true to suppress the modal alert.
|
||||
notifyCertProblem: function(aSocketInfo, aStatus, aTargetSite) true,
|
||||
|
||||
/*
|
||||
* nsISSLErrorListener
|
||||
*/
|
||||
notifySSLError: function(aSocketInfo, aError, aTargetSite) true,
|
||||
|
||||
/*
|
||||
*****************************************************************************
|
||||
****************************** Private methods ******************************
|
||||
*****************************************************************************
|
||||
*/
|
||||
_resetBuffers: function() {
|
||||
this._incomingDataBuffer = this.binaryMode ? [] : "";
|
||||
this._outgoingDataBuffer = [];
|
||||
},
|
||||
|
||||
_createTransport: function(aProxy) {
|
||||
this.proxy = aProxy;
|
||||
|
||||
// Empty incoming and outgoing data storage buffers
|
||||
this._resetBuffers();
|
||||
|
||||
// Create a socket transport
|
||||
let socketTS = Cc["@mozilla.org/network/socket-transport-service;1"]
|
||||
.getService(Ci.nsISocketTransportService);
|
||||
this.transport = socketTS.createTransport(this.security,
|
||||
this.security.length, this.host,
|
||||
this.port, this.proxy);
|
||||
|
||||
this._openStreams();
|
||||
},
|
||||
|
||||
// Open the incoming and outgoing sockets.
|
||||
_openStreams: function() {
|
||||
// Security notification callbacks (must support nsIBadCertListener2 and
|
||||
// nsISSLErrorListener for SSL connections, and possibly other interfaces).
|
||||
this.transport.securityCallbacks = this;
|
||||
|
||||
// Set the timeouts for the nsISocketTransport for both a connect event and
|
||||
// a read/write. Only set them if the user has provided them.
|
||||
if (this.connectTimeout) {
|
||||
this.transport.setTimeout(Ci.nsISocketTransport.TIMEOUT_CONNECT,
|
||||
this.connectTimeout);
|
||||
}
|
||||
if (this.readWriteTimeout) {
|
||||
this.transport.setTimeout(Ci.nsISocketTransport.TIMEOUT_READ_WRITE,
|
||||
this.connectTimeout);
|
||||
}
|
||||
|
||||
this.transport.setEventSink(this, Services.tm.currentThread);
|
||||
|
||||
// No limit on the output stream buffer
|
||||
this._outputStream = this.transport.openOutputStream(0, // flags
|
||||
this.outputSegmentSize, // Use default segment size
|
||||
-1); // Segment count
|
||||
if (!this._outputStream)
|
||||
throw "Error getting output stream.";
|
||||
|
||||
this._inputStream = this.transport.openInputStream(0, // flags
|
||||
0, // Use default segment size
|
||||
0); // Use default segment count
|
||||
if (!this._inputStream)
|
||||
throw "Error getting input stream.";
|
||||
|
||||
if (this.binaryMode) {
|
||||
// Handle binary mode
|
||||
this._binaryInputStream = new BinaryInputStream(this._inputStream);
|
||||
this._binaryOutputStream = new BinaryOutputStream(this._outputStream);
|
||||
} else {
|
||||
// Handle character mode
|
||||
this._scriptableInputStream =
|
||||
new ScriptableInputStream(this._inputStream);
|
||||
}
|
||||
|
||||
this.pump = new InputStreamPump(this._inputStream, // Data to read
|
||||
-1, // Current offset
|
||||
-1, // Read all data
|
||||
0, // Use default segment size
|
||||
0, // Use default segment length
|
||||
false); // Do not close when done
|
||||
this.pump.asyncRead(this, this);
|
||||
|
||||
// Notify that connection is finished.
|
||||
this.onConnection();
|
||||
},
|
||||
|
||||
/*
|
||||
*****************************************************************************
|
||||
********************* Methods for subtypes to override **********************
|
||||
*****************************************************************************
|
||||
*/
|
||||
log: function(aString) { },
|
||||
// Called when a connection is established.
|
||||
onConnection: function() { },
|
||||
// Called when a socket is accepted after listening.
|
||||
onConnectionHeard: function() { },
|
||||
// Called when a connection times out.
|
||||
onConnectionTimedOut: function() { },
|
||||
// Called when a socket request's network is reset
|
||||
onConnectionReset: function() { },
|
||||
|
||||
// Called when ASCII data is available.
|
||||
onDataReceived: function(/*string */ aData) { },
|
||||
|
||||
// Called when binary data is available.
|
||||
onBinaryDataReceived: function(/* ArrayBuffer */ aData) { },
|
||||
|
||||
/*
|
||||
* nsITransportEventSink methods
|
||||
*/
|
||||
onTransportStatus: function(aTransport, aStatus, aProgress, aProgressmax) { }
|
||||
};
|
||||
Загрузка…
Ссылка в новой задаче