Skip to content

Commit

Permalink
Fix for #325 [websocket] WebSocket + Comet issue using the Http11NioP…
Browse files Browse the repository at this point in the history 
…rotocol
  • Loading branch information
@jfarcand
jfarcand committed May 1, 2012
1 parent ce635f1 commit 5163867
Show file tree
Hide file tree
Showing 4 changed files with 280 additions and 143 deletions.
145 changes: 4 additions & 141 deletions modules/cpr/src/main/java/org/atmosphere/container/Tomcat7AsyncSupportWithWebSocket.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,171 +31,34 @@
*/
package org.atmosphere.container;

import org.apache.catalina.connector.RequestFacade;
import org.apache.catalina.websocket.StreamInbound;
import org.atmosphere.cpr.AtmosphereConfig;
import org.atmosphere.cpr.AtmosphereFramework;
import org.atmosphere.cpr.AtmosphereRequest;
import org.atmosphere.cpr.AtmosphereResponse;
import org.atmosphere.websocket.WebSocket;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;

/**
* Tomcat's WebSocket support. This code has been adapted from {@link org.apache.catalina.websocket.WebSocketServlet}
*/
public class Tomcat7AsyncSupportWithWebSocket extends Servlet30CometSupport {
public class Tomcat7AsyncSupportWithWebSocket extends Tomcat7CometSupport implements TomcatWebSocketUtil.Delegate {
private static final Logger logger = LoggerFactory.getLogger(Tomcat7AsyncSupportWithWebSocket.class);
private static final long serialVersionUID = 1L;
private static byte[] WS_ACCEPT;

private Queue<MessageDigest> sha1Helpers = new ConcurrentLinkedQueue<MessageDigest>();

public Tomcat7AsyncSupportWithWebSocket(AtmosphereConfig config) {
super(config);
}

@Override
public void init(ServletConfig sc) throws ServletException {
try {
WS_ACCEPT = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11".getBytes("ISO_8859_1");
} catch (Exception e) {
throw new ServletException(e);
}
}

@Override
public AtmosphereFramework.Action service(AtmosphereRequest req, AtmosphereResponse res) throws IOException, ServletException {
// First, handshake
if (req.getAttribute(WebSocket.WEBSOCKET_SUSPEND) == null) {
// Information required to send the server handshake message
String key;
String subProtocol = null;

if (!headerContainsToken(req, "Upgrade", "websocket")) {
return super.service(req, res);
}

if (!headerContainsToken(req, "Connection", "upgrade")) {
return super.service(req, res);
}

if (!headerContainsToken(req, "sec-websocket-version", "13")) {
logger.debug("WebSocket version not supported. Downgrading to Comet");
res.sendError(501, "Websocket protocol not supported");
return new AtmosphereFramework.Action(AtmosphereFramework.Action.TYPE.CANCELLED);
}

key = req.getHeader("Sec-WebSocket-Key");
if (key == null) {
return super.service(req, res);
}

// If we got this far, all is good. Accept the connection.
res.setHeader("Upgrade", "websocket");
res.setHeader("Connection", "upgrade");
res.setHeader("Sec-WebSocket-Accept", getWebSocketAccept(key));

if (subProtocol != null) {
res.setHeader("Sec-WebSocket-Protocol", subProtocol);
}

HttpServletRequest hsr = req.wrappedRequest();
while (hsr instanceof HttpServletRequestWrapper)
hsr = (HttpServletRequest) ((HttpServletRequestWrapper) hsr).getRequest();

RequestFacade facade = (RequestFacade) hsr;
StreamInbound inbound = new TomcatWebSocketHandler(AtmosphereRequest.loadInMemory(req, true), config.framework(), config.framework().getWebSocketProtocol());
facade.doUpgrade(inbound);
return new AtmosphereFramework.Action(AtmosphereFramework.Action.TYPE.CREATED);
}

AtmosphereFramework.Action action = suspended(req, res);
if (action.type == AtmosphereFramework.Action.TYPE.SUSPEND) {
logger.debug("Suspending resonse: {}", res);
} else if (action.type == AtmosphereFramework.Action.TYPE.RESUME) {
logger.debug("Resume resonse: {}", res);
req.setAttribute(WebSocket.WEBSOCKET_RESUME, true);
}
return action;
}

/*
* This only works for tokens. Quoted strings need more sophisticated
* parsing.
*/
private boolean headerContainsToken(HttpServletRequest req,
String headerName, String target) {
Enumeration<String> headers = req.getHeaders(headerName);
while (headers.hasMoreElements()) {
String header = headers.nextElement();
String[] tokens = header.split(",");
for (String token : tokens) {
if (target.equalsIgnoreCase(token.trim())) {
return true;
}
}
}
return false;
}


/*
* This only works for tokens. Quoted strings need more sophisticated
* parsing.
*/
private List<String> getTokensFromHeader(HttpServletRequest req,
String headerName) {
List<String> result = new ArrayList<String>();

Enumeration<String> headers = req.getHeaders(headerName);
while (headers.hasMoreElements()) {
String header = headers.nextElement();
String[] tokens = header.split(",");
for (String token : tokens) {
result.add(token.trim());
}
}
return result;
return TomcatWebSocketUtil.doService(req, res, this, config);
}


private String getWebSocketAccept(String key) throws ServletException {

MessageDigest sha1Helper = sha1Helpers.poll();
if (sha1Helper == null) {
try {
sha1Helper = MessageDigest.getInstance("SHA1");
} catch (NoSuchAlgorithmException e) {
throw new ServletException(e);
}
}

sha1Helper.reset();
try {
sha1Helper.update(key.getBytes("ISO_8859_1"));
} catch (UnsupportedEncodingException e) {
throw new ServletException(e);
}
String result = org.apache.catalina.util.Base64.encode(sha1Helper.digest(WS_ACCEPT));

sha1Helpers.add(sha1Helper);

return result;
public AtmosphereFramework.Action doService(AtmosphereRequest req, AtmosphereResponse res) throws IOException, ServletException {
return super.service(req, res);
}

@Override
Expand Down
69 changes: 69 additions & 0 deletions ...les/cpr/src/main/java/org/atmosphere/container/Tomcat7BlockingIOSupportWithWebSocket.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*
* Copyright 2012 Jeanfrancois Arcand
*
* Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.atmosphere.container;

import org.atmosphere.cpr.AtmosphereConfig;
import org.atmosphere.cpr.AtmosphereFramework;
import org.atmosphere.cpr.AtmosphereRequest;
import org.atmosphere.cpr.AtmosphereResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.ServletException;
import java.io.IOException;

/**
* Tomcat's WebSocket support. This code has been adapted from {@link org.apache.catalina.websocket.WebSocketServlet}
*/
public class Tomcat7BlockingIOSupportWithWebSocket extends Servlet30CometSupport implements TomcatWebSocketUtil.Delegate {
private static final Logger logger = LoggerFactory.getLogger(Tomcat7BlockingIOSupportWithWebSocket.class);
private static final long serialVersionUID = 1L;

public Tomcat7BlockingIOSupportWithWebSocket(AtmosphereConfig config) {
super(config);
}

@Override
public AtmosphereFramework.Action service(AtmosphereRequest req, AtmosphereResponse res) throws IOException, ServletException {
return TomcatWebSocketUtil.doService(req, res, this, config);
}

public AtmosphereFramework.Action doService(AtmosphereRequest req, AtmosphereResponse res) throws IOException, ServletException {
return super.service(req, res);
}

@Override
public boolean supportWebSocket() {
return true;
}
}

Loading

0 comments on commit 5163867

Please sign in to comment.