mirror of
https://github.com/apache/cordova-android.git
synced 2026-05-11 00:00:05 +08:00
refactored code, added license, added onError handler
This commit is contained in:
Animesh Kumar
@@ -1,30 +1,27 @@
|
||||
/*
|
||||
* In DroidGap class, attach WebSocketFactoy like this,
|
||||
* appView.addJavascriptInterface(new WebSocketFactory(appView), "WebSocketFactory");
|
||||
* Copyright (c) 2010 Animesh Kumar (https://github.com/anismiles)
|
||||
*
|
||||
* Now, in your html file,
|
||||
* 1. Include websocket.js
|
||||
* <script type="text/javascript" charset="utf-8" src="js/websocket.js"></script>
|
||||
* 2. Create WebSocket object, and override event methods,
|
||||
* Permission is hereby granted, free of charge, to any person
|
||||
* obtaining a copy of this software and associated documentation
|
||||
* files (the "Software"), to deal in the Software without
|
||||
* restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the
|
||||
* Software is furnished to do so, subject to the following
|
||||
* conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be
|
||||
* included in all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||
* OTHER DEALINGS IN THE SOFTWARE.
|
||||
*
|
||||
* // new socket
|
||||
* var socket = new WebSocket('ws://122.168.196.27:8082/');
|
||||
*
|
||||
* // push a message after the connection is established.
|
||||
* socket.onopen = function() {
|
||||
* socket.send('--message--')
|
||||
* };
|
||||
*
|
||||
* // alerts message pushed from server
|
||||
* socket.onmessage = function(msg) {
|
||||
* alert(JSON.stringify(msg));
|
||||
* };
|
||||
*
|
||||
* // alert close event
|
||||
* socket.onclose = function() {
|
||||
* alert('closed');
|
||||
* };
|
||||
*
|
||||
*/
|
||||
(function() {
|
||||
|
||||
@@ -37,6 +34,7 @@
|
||||
this.onopen = null;
|
||||
this.onmessage = null;
|
||||
this.onclose = null;
|
||||
this.onerror = null;
|
||||
|
||||
// get a new websocket object from factory (check com.strumsoft.websocket.WebSocketFactory.java)
|
||||
this.socket = WebSocketFactory.getInstance(url);
|
||||
@@ -60,6 +58,10 @@
|
||||
WebSocket.store[evt._target]['onclose'].call(global, evt._data);
|
||||
}
|
||||
|
||||
WebSocket.onerror = function (evt) {
|
||||
WebSocket.store[evt._target]['onerror'].call(global, evt._data);
|
||||
}
|
||||
|
||||
WebSocket.prototype.send = function(data) {
|
||||
this.socket.send(data);
|
||||
}
|
||||
|
||||
@@ -1,295 +0,0 @@
|
||||
package com.phonegap.websocket;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.UnsupportedEncodingException;
|
||||
import java.net.URI;
|
||||
import java.nio.ByteBuffer;
|
||||
import java.nio.channels.NotYetConnectedException;
|
||||
import java.nio.channels.SocketChannel;
|
||||
import java.security.NoSuchAlgorithmException;
|
||||
import java.util.Random;
|
||||
import java.util.concurrent.BlockingQueue;
|
||||
|
||||
/**
|
||||
* @author http://github.com/anismiles
|
||||
*
|
||||
*/
|
||||
public final class Protocol {
|
||||
|
||||
public enum Draft {
|
||||
DRAFT75,
|
||||
DRAFT76
|
||||
}
|
||||
|
||||
// Constants
|
||||
public static final int DEFAULT_PORT = 80;
|
||||
public static final String UTF8_CHARSET = "UTF-8";
|
||||
public static final byte CR = (byte) 0x0D;
|
||||
public static final byte LF = (byte) 0x0A;
|
||||
public static final byte START_OF_FRAME = (byte) 0x00;
|
||||
public static final byte END_OF_FRAME = (byte) 0xFF;
|
||||
|
||||
// Instance Varables
|
||||
private final SocketChannel socketChannel;
|
||||
private boolean handshakeComplete;
|
||||
private WebSocket webSocket;
|
||||
private ByteBuffer buffer;
|
||||
private ByteBuffer remoteHandshake;
|
||||
private ByteBuffer currentFrame;
|
||||
private BlockingQueue<ByteBuffer> bufferQueue;
|
||||
private Object bufferQueueMutex = new Object();
|
||||
|
||||
private int number1 = 0;
|
||||
private int number2 = 0;
|
||||
private byte[] key3 = null;
|
||||
|
||||
protected Protocol(SocketChannel socketChannel, BlockingQueue<ByteBuffer> bufferQueue,
|
||||
WebSocket webSocket) {
|
||||
this.socketChannel = socketChannel;
|
||||
this.bufferQueue = bufferQueue;
|
||||
this.handshakeComplete = false;
|
||||
this.remoteHandshake = this.currentFrame = null;
|
||||
this.buffer = ByteBuffer.allocate(1);
|
||||
this.webSocket = webSocket;
|
||||
}
|
||||
|
||||
protected void writeHandshake() throws IOException {
|
||||
URI uri = this.webSocket.getUri();
|
||||
String path = uri.getPath();
|
||||
if (path.indexOf("/") != 0) {
|
||||
path = "/" + path;
|
||||
}
|
||||
|
||||
int port = uri.getPort();
|
||||
if (port == -1) {
|
||||
port = Protocol.DEFAULT_PORT;
|
||||
}
|
||||
|
||||
String host = uri.getHost() + (port != Protocol.DEFAULT_PORT ? ":" + port : "");
|
||||
String origin = "*"; // TODO: Make 'origin' configurable
|
||||
String request = "GET " + path + " HTTP/1.1\r\n" + "Upgrade: WebSocket\r\n"
|
||||
+ "Connection: Upgrade\r\n" + "Host: " + host + "\r\n" + "Origin: "
|
||||
+ origin + "\r\n";
|
||||
|
||||
// Add randon keys for Draft76
|
||||
if (this.webSocket.getDraft() == Protocol.Draft.DRAFT76) {
|
||||
request += "Sec-WebSocket-Key1: " + this.generateRandomKey() + "\r\n";
|
||||
request += "Sec-WebSocket-Key2: " + this.generateRandomKey() + "\r\n";
|
||||
this.key3 = new byte[8];
|
||||
(new Random()).nextBytes(this.key3);
|
||||
}
|
||||
|
||||
request += "\r\n";
|
||||
write(request.getBytes(Protocol.UTF8_CHARSET));
|
||||
if (this.key3 != null) {
|
||||
write(this.key3);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
protected void read() throws IOException, NoSuchAlgorithmException {
|
||||
this.buffer.rewind();
|
||||
|
||||
int bytesRead = -1;
|
||||
try {
|
||||
bytesRead = this.socketChannel.read(this.buffer);
|
||||
} catch (Exception ex) {
|
||||
}
|
||||
|
||||
if (bytesRead == -1) {
|
||||
close();
|
||||
} else if (bytesRead > 0) {
|
||||
this.buffer.rewind();
|
||||
|
||||
if (!this.handshakeComplete) {
|
||||
readHandshake();
|
||||
} else {
|
||||
readFrame();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
protected void close() throws IOException {
|
||||
this.socketChannel.close();
|
||||
// fire onClose method
|
||||
this.webSocket.onClose();
|
||||
}
|
||||
|
||||
protected boolean send(String text) throws IOException {
|
||||
if (!this.handshakeComplete)
|
||||
throw new NotYetConnectedException();
|
||||
if (text == null)
|
||||
throw new NullPointerException("Cannot send 'null' data to a WebSocket.");
|
||||
|
||||
// Get 'text' into a WebSocket "frame" of bytes
|
||||
byte[] textBytes = text.getBytes(UTF8_CHARSET.toString());
|
||||
ByteBuffer b = ByteBuffer.allocate(textBytes.length + 2);
|
||||
b.put(START_OF_FRAME);
|
||||
b.put(textBytes);
|
||||
b.put(END_OF_FRAME);
|
||||
b.rewind();
|
||||
|
||||
// See if we have any backlog that needs to be sent first
|
||||
if (write()) {
|
||||
// Write the ByteBuffer to the socket
|
||||
this.socketChannel.write(b);
|
||||
}
|
||||
|
||||
// If we didn't get it all sent, add it to the buffer of buffers
|
||||
if (b.remaining() > 0) {
|
||||
if (!this.bufferQueue.offer(b)) {
|
||||
throw new IOException("Buffers are full, message could not be sent to"
|
||||
+ this.socketChannel.socket().getRemoteSocketAddress());
|
||||
}
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
private boolean write() throws IOException {
|
||||
synchronized (this.bufferQueueMutex) {
|
||||
ByteBuffer buffer = this.bufferQueue.peek();
|
||||
while (buffer != null) {
|
||||
this.socketChannel.write(buffer);
|
||||
if (buffer.remaining() > 0) {
|
||||
return false; // Didn't finish this buffer. There's more to
|
||||
// send.
|
||||
} else {
|
||||
this.bufferQueue.poll(); // Buffer finished. Remove it.
|
||||
buffer = this.bufferQueue.peek();
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
protected void write(byte[] bytes) throws IOException {
|
||||
this.socketChannel.write(ByteBuffer.wrap(bytes));
|
||||
}
|
||||
|
||||
private void readFrame() throws UnsupportedEncodingException {
|
||||
byte newestByte = this.buffer.get();
|
||||
|
||||
if (newestByte == START_OF_FRAME) { // Beginning of Frame
|
||||
this.currentFrame = null;
|
||||
|
||||
} else if (newestByte == END_OF_FRAME) { // End of Frame
|
||||
String textFrame = null;
|
||||
// currentFrame will be null if END_OF_FRAME was send directly after
|
||||
// START_OF_FRAME, thus we will send 'null' as the sent message.
|
||||
if (this.currentFrame != null) {
|
||||
textFrame = new String(this.currentFrame.array(), UTF8_CHARSET.toString());
|
||||
}
|
||||
// fire onMessage method
|
||||
this.webSocket.onMessage(textFrame);
|
||||
|
||||
} else { // Regular frame data, add to current frame buffer
|
||||
ByteBuffer frame = ByteBuffer.allocate((this.currentFrame != null ? this.currentFrame
|
||||
.capacity() : 0)
|
||||
+ this.buffer.capacity());
|
||||
if (this.currentFrame != null) {
|
||||
this.currentFrame.rewind();
|
||||
frame.put(this.currentFrame);
|
||||
}
|
||||
frame.put(newestByte);
|
||||
this.currentFrame = frame;
|
||||
}
|
||||
}
|
||||
|
||||
private void readHandshake() throws IOException, NoSuchAlgorithmException {
|
||||
ByteBuffer ch = ByteBuffer.allocate((this.remoteHandshake != null ? this.remoteHandshake
|
||||
.capacity() : 0)
|
||||
+ this.buffer.capacity());
|
||||
if (this.remoteHandshake != null) {
|
||||
this.remoteHandshake.rewind();
|
||||
ch.put(this.remoteHandshake);
|
||||
}
|
||||
ch.put(this.buffer);
|
||||
this.remoteHandshake = ch;
|
||||
byte[] h = this.remoteHandshake.array();
|
||||
// If the ByteBuffer contains 16 random bytes, and ends with
|
||||
// 0x0D 0x0A 0x0D 0x0A (or two CRLFs), then the client
|
||||
// handshake is complete for Draft 76 Client.
|
||||
if ((h.length >= 20 && h[h.length - 20] == CR && h[h.length - 19] == LF
|
||||
&& h[h.length - 18] == CR && h[h.length - 17] == LF)) {
|
||||
readHandshake(new byte[] { h[h.length - 16], h[h.length - 15], h[h.length - 14],
|
||||
h[h.length - 13], h[h.length - 12], h[h.length - 11], h[h.length - 10],
|
||||
h[h.length - 9], h[h.length - 8], h[h.length - 7], h[h.length - 6],
|
||||
h[h.length - 5], h[h.length - 4], h[h.length - 3], h[h.length - 2],
|
||||
h[h.length - 1] });
|
||||
|
||||
// If the ByteBuffer contains 8 random bytes,ends with
|
||||
// 0x0D 0x0A 0x0D 0x0A (or two CRLFs), and the response
|
||||
// contains Sec-WebSocket-Key1 then the client
|
||||
// handshake is complete for Draft 76 Server.
|
||||
} else if ((h.length >= 12 && h[h.length - 12] == CR && h[h.length - 11] == LF
|
||||
&& h[h.length - 10] == CR && h[h.length - 9] == LF)
|
||||
&& new String(this.remoteHandshake.array(), UTF8_CHARSET)
|
||||
.contains("Sec-WebSocket-Key1")) {// ************************
|
||||
readHandshake(new byte[] { h[h.length - 8], h[h.length - 7], h[h.length - 6],
|
||||
h[h.length - 5], h[h.length - 4], h[h.length - 3], h[h.length - 2],
|
||||
h[h.length - 1] });
|
||||
|
||||
// Consider Draft 75, and the Flash Security Policy
|
||||
// Request edge-case.
|
||||
} else if ((h.length >= 4 && h[h.length - 4] == CR && h[h.length - 3] == LF
|
||||
&& h[h.length - 2] == CR && h[h.length - 1] == LF)
|
||||
&& !(new String(this.remoteHandshake.array(), UTF8_CHARSET).contains("Sec"))
|
||||
|| (h.length == 23 && h[h.length - 1] == 0)) {
|
||||
readHandshake(null);
|
||||
}
|
||||
}
|
||||
|
||||
private void readHandshake(byte[] handShakeBody) throws IOException,
|
||||
NoSuchAlgorithmException {
|
||||
//byte[] handshakeBytes = this.remoteHandshake.array();
|
||||
//String handshake = new String(handshakeBytes, UTF8_CHARSET);
|
||||
this.handshakeComplete = true;
|
||||
|
||||
boolean isConnectionReady = true;
|
||||
if (this.webSocket.getDraft() == Protocol.Draft.DRAFT76) {
|
||||
// TODO: Draft76 specific stuffs
|
||||
// store result in isConnectionReady
|
||||
}
|
||||
|
||||
if (isConnectionReady) {
|
||||
// fire onOpen method
|
||||
this.webSocket.onOpen();
|
||||
} else {
|
||||
close();
|
||||
}
|
||||
}
|
||||
|
||||
private String generateRandomKey() {
|
||||
Random r = new Random();
|
||||
long maxNumber = 4294967295L;
|
||||
long spaces = r.nextInt(12) + 1;
|
||||
int max = new Long(maxNumber / spaces).intValue();
|
||||
max = Math.abs(max);
|
||||
int number = r.nextInt(max) + 1;
|
||||
if (this.number1 == 0) {
|
||||
this.number1 = number;
|
||||
} else {
|
||||
this.number2 = number;
|
||||
}
|
||||
long product = number * spaces;
|
||||
String key = Long.toString(product);
|
||||
int numChars = r.nextInt(12);
|
||||
for (int i = 0; i < numChars; i++) {
|
||||
int position = r.nextInt(key.length());
|
||||
position = Math.abs(position);
|
||||
char randChar = (char) (r.nextInt(95) + 33);
|
||||
// exclude numbers here
|
||||
if (randChar >= 48 && randChar <= 57) {
|
||||
randChar -= 15;
|
||||
}
|
||||
key = new StringBuilder(key).insert(position, randChar).toString();
|
||||
}
|
||||
for (int i = 0; i < spaces; i++) {
|
||||
int position = r.nextInt(key.length() - 1) + 1;
|
||||
position = Math.abs(position);
|
||||
key = new StringBuilder(key).insert(position, "\u0020").toString();
|
||||
}
|
||||
return key;
|
||||
}
|
||||
}
|
||||
@@ -1,89 +1,359 @@
|
||||
/*
|
||||
* Copyright (c) 2010 Nathan Rajlich (https://github.com/TooTallNate)
|
||||
* Copyright (c) 2010 Animesh Kumar (https://github.com/anismiles)
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person
|
||||
* obtaining a copy of this software and associated documentation
|
||||
* files (the "Software"), to deal in the Software without
|
||||
* restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the
|
||||
* Software is furnished to do so, subject to the following
|
||||
* conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be
|
||||
* included in all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||
* OTHER DEALINGS IN THE SOFTWARE.
|
||||
*
|
||||
*/
|
||||
package com.phonegap.websocket;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.UnsupportedEncodingException;
|
||||
import java.net.InetSocketAddress;
|
||||
import java.net.URI;
|
||||
import java.nio.ByteBuffer;
|
||||
import java.nio.channels.NotYetConnectedException;
|
||||
import java.nio.channels.SelectionKey;
|
||||
import java.nio.channels.Selector;
|
||||
import java.nio.channels.SocketChannel;
|
||||
import java.security.MessageDigest;
|
||||
import java.security.NoSuchAlgorithmException;
|
||||
import java.util.Iterator;
|
||||
import java.util.Random;
|
||||
import java.util.Set;
|
||||
import java.util.concurrent.BlockingQueue;
|
||||
import java.util.concurrent.LinkedBlockingQueue;
|
||||
|
||||
import android.webkit.WebView;
|
||||
|
||||
/**
|
||||
* @author http://github.com/anismiles
|
||||
* The <tt>WebSocket</tt> is an implementation of WebSocket Client API, and
|
||||
* expects a valid "ws://" URI to connect to. When connected, an instance
|
||||
* recieves important events related to the life of the connection, like
|
||||
* <var>onOpen</var>, <var>onClose</var>, <var>onError</var> and
|
||||
* <var>onMessage</var>. An instance can send messages to the server via the
|
||||
* <var>send</var> method.
|
||||
*
|
||||
* @author Animesh Kumar
|
||||
*/
|
||||
public class WebSocket implements Runnable {
|
||||
|
||||
// Constants
|
||||
/**
|
||||
* Enum for WebSocket Draft
|
||||
*/
|
||||
public enum Draft {
|
||||
DRAFT75, DRAFT76
|
||||
}
|
||||
|
||||
////////////////// CONSTANT
|
||||
/**
|
||||
* An empty string
|
||||
*/
|
||||
private static String BLANK_MESSAGE = "";
|
||||
/**
|
||||
* The javascript method name for onOpen event.
|
||||
*/
|
||||
private static String EVENT_ON_OPEN = "onopen";
|
||||
/**
|
||||
* The javascript method name for onMessage event.
|
||||
*/
|
||||
private static String EVENT_ON_MESSAGE = "onmessage";
|
||||
/**
|
||||
* The javascript method name for onClose event.
|
||||
*/
|
||||
private static String EVENT_ON_CLOSE = "onclose";
|
||||
/**
|
||||
* The javascript method name for onError event.
|
||||
*/
|
||||
private static String EVENT_ON_ERROR = "onerror";
|
||||
/**
|
||||
* The default port of WebSockets, as defined in the spec.
|
||||
*/
|
||||
public static final int DEFAULT_PORT = 80;
|
||||
/**
|
||||
* The WebSocket protocol expects UTF-8 encoded bytes.
|
||||
*/
|
||||
public static final String UTF8_CHARSET = "UTF-8";
|
||||
/**
|
||||
* The byte representing Carriage Return, or \r
|
||||
*/
|
||||
public static final byte DATA_CR = (byte) 0x0D;
|
||||
/**
|
||||
* The byte representing Line Feed, or \n
|
||||
*/
|
||||
public static final byte DATA_LF = (byte) 0x0A;
|
||||
/**
|
||||
* The byte representing the beginning of a WebSocket text frame.
|
||||
*/
|
||||
public static final byte DATA_START_OF_FRAME = (byte) 0x00;
|
||||
/**
|
||||
* The byte representing the end of a WebSocket text frame.
|
||||
*/
|
||||
public static final byte DATA_END_OF_FRAME = (byte) 0xFF;
|
||||
|
||||
// Instance Variables
|
||||
////////////////// INSTANCE Variables
|
||||
/**
|
||||
* The WebView instance from Phonegap DroidGap
|
||||
*/
|
||||
private WebView appView;
|
||||
/**
|
||||
* The unique id for this instance (helps to bind this to javascript events)
|
||||
*/
|
||||
private String id;
|
||||
/**
|
||||
* The URI this client is supposed to connect to.
|
||||
*/
|
||||
private URI uri;
|
||||
/**
|
||||
* The port of the websocket server
|
||||
*/
|
||||
private int port;
|
||||
private Protocol protocol;
|
||||
private Protocol.Draft draft;
|
||||
private SocketChannel channel;
|
||||
/**
|
||||
* The Draft of the WebSocket protocol the Client is adhering to.
|
||||
*/
|
||||
private Draft draft;
|
||||
/**
|
||||
* The <tt>SocketChannel</tt> instance to use for this server connection.
|
||||
* This is used to read and write data to.
|
||||
*/
|
||||
private SocketChannel socketChannel;
|
||||
/**
|
||||
* The 'Selector' used to get event keys from the underlying socket.
|
||||
*/
|
||||
private Selector selector;
|
||||
/**
|
||||
* Keeps track of whether or not the client thread should continue running.
|
||||
*/
|
||||
private boolean running;
|
||||
/**
|
||||
* Internally used to determine whether to recieve data as part of the
|
||||
* remote handshake, or as part of a text frame.
|
||||
*/
|
||||
private boolean handshakeComplete;
|
||||
/**
|
||||
* The 1-byte buffer reused throughout the WebSocket connection to read
|
||||
* data.
|
||||
*/
|
||||
private ByteBuffer buffer;
|
||||
/**
|
||||
* The bytes that make up the remote handshake.
|
||||
*/
|
||||
private ByteBuffer remoteHandshake;
|
||||
/**
|
||||
* The bytes that make up the current text frame being read.
|
||||
*/
|
||||
private ByteBuffer currentFrame;
|
||||
/**
|
||||
* Queue of buffers that need to be sent to the client.
|
||||
*/
|
||||
private BlockingQueue<ByteBuffer> bufferQueue;
|
||||
/**
|
||||
* Lock object to ensure that data is sent from the bufferQueue in the
|
||||
* proper order
|
||||
*/
|
||||
private Object bufferQueueMutex = new Object();
|
||||
/**
|
||||
* Number 1 used in handshake
|
||||
*/
|
||||
private int number1 = 0;
|
||||
/**
|
||||
* Number 2 used in handshake
|
||||
*/
|
||||
private int number2 = 0;
|
||||
/**
|
||||
* Key3 used in handshake
|
||||
*/
|
||||
private byte[] key3 = null;
|
||||
|
||||
// Constructor (only used from Factory)
|
||||
protected WebSocket(WebView appView, URI uri, Protocol.Draft draft, String id) {
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* Note: this is protected because it's supposed to be instantiated from
|
||||
* {@link WebSocketFactory} only.
|
||||
*
|
||||
* @param appView
|
||||
* {@link android.webkit.WebView}
|
||||
* @param uri
|
||||
* websocket server {@link URI}
|
||||
* @param draft
|
||||
* websocket server {@link Draft} implementation (75/76)
|
||||
* @param id
|
||||
* unique id for this instance
|
||||
*/
|
||||
protected WebSocket(WebView appView, URI uri, Draft draft, String id) {
|
||||
this.appView = appView;
|
||||
this.uri = uri;
|
||||
this.draft = draft;
|
||||
|
||||
// port
|
||||
port = uri.getPort();
|
||||
if (port == -1) {
|
||||
port = Protocol.DEFAULT_PORT;
|
||||
port = DEFAULT_PORT;
|
||||
}
|
||||
|
||||
|
||||
// Id
|
||||
this.id = id;
|
||||
this.id = id;
|
||||
|
||||
this.bufferQueue = new LinkedBlockingQueue<ByteBuffer>();
|
||||
this.handshakeComplete = false;
|
||||
this.remoteHandshake = this.currentFrame = null;
|
||||
this.buffer = ByteBuffer.allocate(1);
|
||||
}
|
||||
|
||||
// start a thread and connect to server
|
||||
// //////////////////////////////////////////////////////////////////////////////////////
|
||||
// /////////////////////////// WEB SOCKET API Methods
|
||||
// ///////////////////////////////////
|
||||
// //////////////////////////////////////////////////////////////////////////////////////
|
||||
/**
|
||||
* Starts a new Thread and connects to server
|
||||
*/
|
||||
public void connect() {
|
||||
this.running = true;
|
||||
(new Thread(this)).start();
|
||||
}
|
||||
|
||||
// close connection
|
||||
public void close() throws IOException {
|
||||
this.running = false;
|
||||
selector.wakeup();
|
||||
protocol.close();
|
||||
}
|
||||
|
||||
// send message
|
||||
public void send(String msg) throws IOException {
|
||||
protocol.send(msg);
|
||||
}
|
||||
|
||||
public void run() {
|
||||
// TODO: Reconnection Logic
|
||||
try {
|
||||
_connect();
|
||||
} catch (IOException e) {
|
||||
this.onError(e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes connection with server
|
||||
*/
|
||||
public void close() {
|
||||
// close socket channel
|
||||
try {
|
||||
this.socketChannel.close();
|
||||
} catch (IOException e) {
|
||||
this.onError(e);
|
||||
}
|
||||
this.running = false;
|
||||
selector.wakeup();
|
||||
|
||||
// fire onClose method
|
||||
this.onClose();
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends <var>text</var> to server
|
||||
*
|
||||
* @param text
|
||||
* String to send to server
|
||||
*/
|
||||
public void send(String text) {
|
||||
try {
|
||||
_send(text);
|
||||
} catch (IOException e) {
|
||||
this.onError(e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Called when an entire text frame has been recieved.
|
||||
*
|
||||
* @param msg
|
||||
* Message from websocket server
|
||||
*/
|
||||
public void onMessage(String msg) {
|
||||
appView.loadUrl(buildJavaScriptData(EVENT_ON_MESSAGE, msg));
|
||||
}
|
||||
|
||||
public void onOpen() {
|
||||
appView.loadUrl(buildJavaScriptData(EVENT_ON_OPEN, BLANK_MESSAGE));
|
||||
}
|
||||
|
||||
public void onClose() {
|
||||
appView.loadUrl(buildJavaScriptData(EVENT_ON_CLOSE, BLANK_MESSAGE));
|
||||
}
|
||||
|
||||
public void onError(Throwable t) {
|
||||
String msg = t.getMessage();
|
||||
appView.loadUrl(buildJavaScriptData(EVENT_ON_ERROR, msg));
|
||||
}
|
||||
|
||||
public String getId() {
|
||||
return id;
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds text for javascript engine to invoke proper event method with proper data.
|
||||
*
|
||||
* @param event websocket event (onOpen, onMessage etc.)
|
||||
* @param msg Text message received from websocket server
|
||||
* @return
|
||||
*/
|
||||
private String buildJavaScriptData(String event, String msg) {
|
||||
String _d = "javascript:WebSocket." + event + "(" + "{" + "\"_target\":\"" + id + "\","
|
||||
+ "\"_data\":'" + msg + "'" + "}" + ")";
|
||||
return _d;
|
||||
}
|
||||
|
||||
// //////////////////////////////////////////////////////////////////////////////////////
|
||||
// /////////////////////////// WEB SOCKET Internal Methods
|
||||
// //////////////////////////////
|
||||
// //////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
private boolean _send(String text) throws IOException {
|
||||
if (!this.handshakeComplete) {
|
||||
throw new NotYetConnectedException();
|
||||
}
|
||||
if (text == null) {
|
||||
throw new NullPointerException("Cannot send 'null' data to a WebSocket.");
|
||||
}
|
||||
|
||||
// Get 'text' into a WebSocket "frame" of bytes
|
||||
byte[] textBytes = text.getBytes(UTF8_CHARSET.toString());
|
||||
ByteBuffer b = ByteBuffer.allocate(textBytes.length + 2);
|
||||
b.put(DATA_START_OF_FRAME);
|
||||
b.put(textBytes);
|
||||
b.put(DATA_END_OF_FRAME);
|
||||
b.rewind();
|
||||
|
||||
// See if we have any backlog that needs to be sent first
|
||||
if (_write()) {
|
||||
// Write the ByteBuffer to the socket
|
||||
this.socketChannel.write(b);
|
||||
}
|
||||
|
||||
// If we didn't get it all sent, add it to the buffer of buffers
|
||||
if (b.remaining() > 0) {
|
||||
if (!this.bufferQueue.offer(b)) {
|
||||
throw new IOException("Buffers are full, message could not be sent to"
|
||||
+ this.socketChannel.socket().getRemoteSocketAddress());
|
||||
}
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
// actual connection logic
|
||||
private void _connect() throws IOException {
|
||||
|
||||
channel = SocketChannel.open();
|
||||
channel.configureBlocking(false);
|
||||
channel.connect(new InetSocketAddress(uri.getHost(), port));
|
||||
socketChannel = SocketChannel.open();
|
||||
socketChannel.configureBlocking(false);
|
||||
socketChannel.connect(new InetSocketAddress(uri.getHost(), port));
|
||||
|
||||
// More info:
|
||||
// http://groups.google.com/group/android-developers/browse_thread/thread/45a8b53e9bf60d82
|
||||
@@ -92,8 +362,7 @@ public class WebSocket implements Runnable {
|
||||
System.setProperty("java.net.preferIPv6Addresses", "false");
|
||||
|
||||
selector = Selector.open();
|
||||
this.protocol = new Protocol(channel, new LinkedBlockingQueue<ByteBuffer>(), this);
|
||||
channel.register(selector, SelectionKey.OP_CONNECT);
|
||||
socketChannel.register(selector, SelectionKey.OP_CONNECT);
|
||||
|
||||
// Continuous loop that is only supposed to end when "close" is called.
|
||||
while (this.running) {
|
||||
@@ -105,49 +374,233 @@ public class WebSocket implements Runnable {
|
||||
SelectionKey key = i.next();
|
||||
i.remove();
|
||||
if (key.isConnectable()) {
|
||||
if (channel.isConnectionPending()) {
|
||||
channel.finishConnect();
|
||||
if (socketChannel.isConnectionPending()) {
|
||||
socketChannel.finishConnect();
|
||||
}
|
||||
channel.register(selector, SelectionKey.OP_READ);
|
||||
protocol.writeHandshake();
|
||||
socketChannel.register(selector, SelectionKey.OP_READ);
|
||||
_writeHandshake();
|
||||
}
|
||||
if (key.isReadable()) {
|
||||
try {
|
||||
protocol.read();
|
||||
} catch (NoSuchAlgorithmException e) {
|
||||
_read();
|
||||
} catch (NoSuchAlgorithmException nsa) {
|
||||
this.onError(nsa);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public void onMessage(String message) {
|
||||
appView.loadUrl(buildJavaScriptData(EVENT_ON_MESSAGE, message));
|
||||
private void _writeHandshake() throws IOException {
|
||||
String path = this.uri.getPath();
|
||||
if (path.indexOf("/") != 0) {
|
||||
path = "/" + path;
|
||||
}
|
||||
|
||||
String host = uri.getHost() + (port != DEFAULT_PORT ? ":" + port : "");
|
||||
String origin = "*"; // TODO: Make 'origin' configurable
|
||||
String request = "GET " + path + " HTTP/1.1\r\n" + "Upgrade: WebSocket\r\n"
|
||||
+ "Connection: Upgrade\r\n" + "Host: " + host + "\r\n" + "Origin: " + origin
|
||||
+ "\r\n";
|
||||
|
||||
// Add randon keys for Draft76
|
||||
if (this.draft == Draft.DRAFT76) {
|
||||
request += "Sec-WebSocket-Key1: " + this._randomKey() + "\r\n";
|
||||
request += "Sec-WebSocket-Key2: " + this._randomKey() + "\r\n";
|
||||
this.key3 = new byte[8];
|
||||
(new Random()).nextBytes(this.key3);
|
||||
}
|
||||
|
||||
request += "\r\n";
|
||||
_write(request.getBytes(UTF8_CHARSET));
|
||||
if (this.key3 != null) {
|
||||
_write(this.key3);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public void onOpen() {
|
||||
appView.loadUrl(buildJavaScriptData(EVENT_ON_OPEN, BLANK_MESSAGE));
|
||||
private boolean _write() throws IOException {
|
||||
synchronized (this.bufferQueueMutex) {
|
||||
ByteBuffer buffer = this.bufferQueue.peek();
|
||||
while (buffer != null) {
|
||||
this.socketChannel.write(buffer);
|
||||
if (buffer.remaining() > 0) {
|
||||
return false; // Didn't finish this buffer. There's more to
|
||||
// send.
|
||||
} else {
|
||||
this.bufferQueue.poll(); // Buffer finished. Remove it.
|
||||
buffer = this.bufferQueue.peek();
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
public void onClose() {
|
||||
appView.loadUrl(buildJavaScriptData(EVENT_ON_CLOSE, BLANK_MESSAGE));
|
||||
private void _write(byte[] bytes) throws IOException {
|
||||
this.socketChannel.write(ByteBuffer.wrap(bytes));
|
||||
}
|
||||
|
||||
public String getId() {
|
||||
return id;
|
||||
private void _read() throws IOException, NoSuchAlgorithmException {
|
||||
this.buffer.rewind();
|
||||
|
||||
int bytesRead = -1;
|
||||
try {
|
||||
bytesRead = this.socketChannel.read(this.buffer);
|
||||
} catch (Exception ex) {
|
||||
}
|
||||
|
||||
if (bytesRead == -1) {
|
||||
close();
|
||||
} else if (bytesRead > 0) {
|
||||
this.buffer.rewind();
|
||||
|
||||
if (!this.handshakeComplete) {
|
||||
_readHandshake();
|
||||
} else {
|
||||
_readFrame();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
protected Protocol.Draft getDraft() {
|
||||
return draft;
|
||||
private void _readFrame() throws UnsupportedEncodingException {
|
||||
byte newestByte = this.buffer.get();
|
||||
|
||||
if (newestByte == DATA_START_OF_FRAME) { // Beginning of Frame
|
||||
this.currentFrame = null;
|
||||
|
||||
} else if (newestByte == DATA_END_OF_FRAME) { // End of Frame
|
||||
String textFrame = null;
|
||||
// currentFrame will be null if END_OF_FRAME was send directly after
|
||||
// START_OF_FRAME, thus we will send 'null' as the sent message.
|
||||
if (this.currentFrame != null) {
|
||||
textFrame = new String(this.currentFrame.array(), UTF8_CHARSET.toString());
|
||||
}
|
||||
// fire onMessage method
|
||||
this.onMessage(textFrame);
|
||||
|
||||
} else { // Regular frame data, add to current frame buffer
|
||||
ByteBuffer frame = ByteBuffer.allocate((this.currentFrame != null ? this.currentFrame
|
||||
.capacity() : 0)
|
||||
+ this.buffer.capacity());
|
||||
if (this.currentFrame != null) {
|
||||
this.currentFrame.rewind();
|
||||
frame.put(this.currentFrame);
|
||||
}
|
||||
frame.put(newestByte);
|
||||
this.currentFrame = frame;
|
||||
}
|
||||
}
|
||||
|
||||
protected URI getUri() {
|
||||
return uri;
|
||||
private void _readHandshake() throws IOException, NoSuchAlgorithmException {
|
||||
ByteBuffer ch = ByteBuffer.allocate((this.remoteHandshake != null ? this.remoteHandshake
|
||||
.capacity() : 0)
|
||||
+ this.buffer.capacity());
|
||||
if (this.remoteHandshake != null) {
|
||||
this.remoteHandshake.rewind();
|
||||
ch.put(this.remoteHandshake);
|
||||
}
|
||||
ch.put(this.buffer);
|
||||
this.remoteHandshake = ch;
|
||||
byte[] h = this.remoteHandshake.array();
|
||||
// If the ByteBuffer contains 16 random bytes, and ends with
|
||||
// 0x0D 0x0A 0x0D 0x0A (or two CRLFs), then the client
|
||||
// handshake is complete for Draft 76 Client.
|
||||
if ((h.length >= 20 && h[h.length - 20] == DATA_CR && h[h.length - 19] == DATA_LF
|
||||
&& h[h.length - 18] == DATA_CR && h[h.length - 17] == DATA_LF)) {
|
||||
_readHandshake(new byte[] { h[h.length - 16], h[h.length - 15], h[h.length - 14],
|
||||
h[h.length - 13], h[h.length - 12], h[h.length - 11], h[h.length - 10],
|
||||
h[h.length - 9], h[h.length - 8], h[h.length - 7], h[h.length - 6],
|
||||
h[h.length - 5], h[h.length - 4], h[h.length - 3], h[h.length - 2],
|
||||
h[h.length - 1] });
|
||||
|
||||
// If the ByteBuffer contains 8 random bytes,ends with
|
||||
// 0x0D 0x0A 0x0D 0x0A (or two CRLFs), and the response
|
||||
// contains Sec-WebSocket-Key1 then the client
|
||||
// handshake is complete for Draft 76 Server.
|
||||
} else if ((h.length >= 12 && h[h.length - 12] == DATA_CR && h[h.length - 11] == DATA_LF
|
||||
&& h[h.length - 10] == DATA_CR && h[h.length - 9] == DATA_LF)
|
||||
&& new String(this.remoteHandshake.array(), UTF8_CHARSET)
|
||||
.contains("Sec-WebSocket-Key1")) {// ************************
|
||||
_readHandshake(new byte[] { h[h.length - 8], h[h.length - 7], h[h.length - 6],
|
||||
h[h.length - 5], h[h.length - 4], h[h.length - 3], h[h.length - 2],
|
||||
h[h.length - 1] });
|
||||
|
||||
// Consider Draft 75, and the Flash Security Policy
|
||||
// Request edge-case.
|
||||
} else if ((h.length >= 4 && h[h.length - 4] == DATA_CR && h[h.length - 3] == DATA_LF
|
||||
&& h[h.length - 2] == DATA_CR && h[h.length - 1] == DATA_LF)
|
||||
&& !(new String(this.remoteHandshake.array(), UTF8_CHARSET).contains("Sec"))
|
||||
|| (h.length == 23 && h[h.length - 1] == 0)) {
|
||||
_readHandshake(null);
|
||||
}
|
||||
}
|
||||
|
||||
private String buildJavaScriptData(String event, String msg) {
|
||||
String _d = "javascript:WebSocket." + event + "(" + "{" + "\"_target\":\"" + id + "\","
|
||||
+ "\"_data\":'" + msg + "'" + "}" + ")";
|
||||
return _d;
|
||||
private void _readHandshake(byte[] handShakeBody) throws IOException, NoSuchAlgorithmException {
|
||||
// byte[] handshakeBytes = this.remoteHandshake.array();
|
||||
// String handshake = new String(handshakeBytes, UTF8_CHARSET);
|
||||
// TODO: Do some parsing of the returned handshake, and close connection
|
||||
// in received anything unexpected!
|
||||
|
||||
this.handshakeComplete = true;
|
||||
boolean isConnectionReady = true;
|
||||
|
||||
if (this.draft == WebSocket.Draft.DRAFT76) {
|
||||
if (handShakeBody == null) {
|
||||
isConnectionReady = true;
|
||||
}
|
||||
byte[] challenge = new byte[] { (byte) (this.number1 >> 24),
|
||||
(byte) ((this.number1 << 8) >> 24), (byte) ((this.number1 << 16) >> 24),
|
||||
(byte) ((this.number1 << 24) >> 24), (byte) (this.number2 >> 24),
|
||||
(byte) ((this.number2 << 8) >> 24), (byte) ((this.number2 << 16) >> 24),
|
||||
(byte) ((this.number2 << 24) >> 24), this.key3[0], this.key3[1], this.key3[2],
|
||||
this.key3[3], this.key3[4], this.key3[5], this.key3[6], this.key3[7] };
|
||||
MessageDigest md5 = MessageDigest.getInstance("MD5");
|
||||
byte[] expected = md5.digest(challenge);
|
||||
for (int i = 0; i < handShakeBody.length; i++) {
|
||||
if (expected[i] != handShakeBody[i]) {
|
||||
isConnectionReady = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (isConnectionReady) {
|
||||
// fire onOpen method
|
||||
this.onOpen();
|
||||
} else {
|
||||
close();
|
||||
}
|
||||
}
|
||||
|
||||
private String _randomKey() {
|
||||
Random r = new Random();
|
||||
long maxNumber = 4294967295L;
|
||||
long spaces = r.nextInt(12) + 1;
|
||||
int max = new Long(maxNumber / spaces).intValue();
|
||||
max = Math.abs(max);
|
||||
int number = r.nextInt(max) + 1;
|
||||
if (this.number1 == 0) {
|
||||
this.number1 = number;
|
||||
} else {
|
||||
this.number2 = number;
|
||||
}
|
||||
long product = number * spaces;
|
||||
String key = Long.toString(product);
|
||||
int numChars = r.nextInt(12);
|
||||
for (int i = 0; i < numChars; i++) {
|
||||
int position = r.nextInt(key.length());
|
||||
position = Math.abs(position);
|
||||
char randChar = (char) (r.nextInt(95) + 33);
|
||||
// exclude numbers here
|
||||
if (randChar >= 48 && randChar <= 57) {
|
||||
randChar -= 15;
|
||||
}
|
||||
key = new StringBuilder(key).insert(position, randChar).toString();
|
||||
}
|
||||
for (int i = 0; i < spaces; i++) {
|
||||
int position = r.nextInt(key.length() - 1) + 1;
|
||||
position = Math.abs(position);
|
||||
key = new StringBuilder(key).insert(position, "\u0020").toString();
|
||||
}
|
||||
return key;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,15 +1,42 @@
|
||||
/*
|
||||
* Copyright (c) 2010 Animesh Kumar (https://github.com/anismiles)
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person
|
||||
* obtaining a copy of this software and associated documentation
|
||||
* files (the "Software"), to deal in the Software without
|
||||
* restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the
|
||||
* Software is furnished to do so, subject to the following
|
||||
* conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be
|
||||
* included in all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||
* OTHER DEALINGS IN THE SOFTWARE.
|
||||
*
|
||||
*/
|
||||
package com.phonegap.websocket;
|
||||
|
||||
import java.net.URI;
|
||||
import java.net.URISyntaxException;
|
||||
import java.util.Random;
|
||||
|
||||
|
||||
import android.webkit.WebView;
|
||||
|
||||
/**
|
||||
* @author http://github.com/anismiles
|
||||
*
|
||||
* The <tt>WebSocketFactory</tt> is like a helper class to instantiate new
|
||||
* WebSocket instaces especially from Javascript side. It expects a valid
|
||||
* "ws://" URI.
|
||||
*
|
||||
* @author Animesh Kumar
|
||||
*/
|
||||
public class WebSocketFactory {
|
||||
|
||||
@@ -18,25 +45,31 @@ public class WebSocketFactory {
|
||||
|
||||
/**
|
||||
* Instantiates a new web socket factory.
|
||||
*
|
||||
* @param appView the app view
|
||||
*
|
||||
* @param appView
|
||||
* the app view
|
||||
*/
|
||||
public WebSocketFactory(WebView appView) {
|
||||
this.appView = appView;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the web socket.
|
||||
*
|
||||
* @param url the url
|
||||
* @return the web socket
|
||||
* @throws URISyntaxException the uRI syntax exception
|
||||
*/
|
||||
public WebSocket getInstance(String url) throws URISyntaxException {
|
||||
// random id
|
||||
String id = "WebSocket." + new Random().nextInt(100);
|
||||
WebSocket socket = new WebSocket(appView, new URI(url), Protocol.Draft.DRAFT75, id);
|
||||
return getInstance(url, WebSocket.Draft.DRAFT75);
|
||||
}
|
||||
|
||||
public WebSocket getInstance(String url, WebSocket.Draft draft) throws URISyntaxException {
|
||||
WebSocket socket = new WebSocket(appView, new URI(url), draft, getRandonUniqueId());
|
||||
socket.connect();
|
||||
return socket;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates random unique ids for WebSocket instances
|
||||
*
|
||||
* @return String
|
||||
*/
|
||||
private String getRandonUniqueId() {
|
||||
return "WEBSOCKET." + new Random().nextInt(100);
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user