Author: kkolinko Date: Tue Jun 1 16:05:20 2010 New Revision: 950137 URL: http://svn.apache.org/viewvc?rev=950137&view=rev Log: Improve the ChatServlet comet example and fix some issues there It is merge of r935105 from trunk.
Added: tomcat/tc6.0.x/trunk/webapps/examples/jsp/chat/index.jsp - copied unchanged from r935105, tomcat/trunk/webapps/examples/jsp/chat/index.jsp Removed: tomcat/tc6.0.x/trunk/webapps/examples/jsp/chat/chat.jsp Modified: tomcat/tc6.0.x/trunk/ (props changed) tomcat/tc6.0.x/trunk/STATUS.txt tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml tomcat/tc6.0.x/trunk/webapps/examples/WEB-INF/classes/chat/ChatServlet.java tomcat/tc6.0.x/trunk/webapps/examples/jsp/chat/login.jsp tomcat/tc6.0.x/trunk/webapps/examples/jsp/chat/post.jsp Propchange: tomcat/tc6.0.x/trunk/ ------------------------------------------------------------------------------ --- svn:mergeinfo (original) +++ svn:mergeinfo Tue Jun 1 16:05:20 2010 @@ -1 +1 @@ -/tomcat/trunk:601180,606992,612607,630314,640888,652744,653247,666232,673796,673820,677910,683969,683982,684001,684081,684234,684269-684270,685177,687503,687645,689402,690781,691392,691805,692748,693378,694992,695053,695311,696780,696782,698012,698227,698236,698613,699427,699634,701355,709294,709811,709816,710063,710066,710125,710205,711126,711600,712461,712467,713953,714002,718360,719119,719124,719602,719626,719628,720046,720069,721040,721286,721708,721886,723404,723738,726052,727303,728032,728768,728947,729057,729567,729569,729571,729681,729809,729815,729934,730250,730590,731651,732859,732863,734734,740675,740684,742677,742697,742714,744160,744238,746321,746384,746425,747834,747863,748344,750258,750291,750921,751286-751287,751289,751295,752323,753039,757335,757774,758249,758365,758596,758616,758664,759074,761601,762868,762929,762936-762937,763166,763183,763193,763228,763262,763298,763302,763325,763599,763611,763654,763681,763706,764985,764997,765662,768335,769979,770716,77 0809,770876,772872,776921,776924,776935,776945,777464,777466,777576,777625,778379,778523-778524,781528,781779,782145,782791,783316,783696,783724,783756,783762,783766,783863,783934,784453,784602,784614,785381,785688,785768,785859,786468,786487,786490,786496,786667,787627,787770,787985,789389,790405,791041,791184,791194,791224,791243,791326,791328,791789,792740,793372,793757,793882,793981,794082,794673,794822,795043,795152,795210,795457,795466,797168,797425,797596,797607,802727,802940,804462,804544,804734,805153,809131,809603,810916,810977,812125,812137,812432,813001,813013,813866,814180,814708,814876,815972,816252,817442,817822,819339,819361,820110,820132,820874,820954,821397,828196,828201,828210,828225,828759,830378-830379,830999,831106,831774,831785,831828,831850,831860,832214,832218,833121,833545,834047,835036,835336,836405,881396,881412,883130,883134,883146,883165,883177,883362,883565,884341,885038,885231,885241,885260,885901,885991,886019,888072,889363,889606,889716,8901 39,890265,890349-890350,890417,891185-891187,891583,892198,892341,892415,892464,892555,892812,892814,892817,892843,892887,893321,893493,894580,894586,894805,894831,895013,895045,895057,895191,895392,895703,896370,896384,897380-897381,897776,898126,898256,898468,898527,898555,898558,898718,898836,898906,899284,899348,899420,899653,899769-899770,899783,899788,899792,899916,899918-899919,899935,899949,903916,905020,905151,905722,905728,905735,907311,907513,907538,907652,907819,907825,907864,908002,908721,908754,908759,909097,909206,909212,909525,909636,909869,909875,909887,910266,910370,910442,910471,910485,910974,915226,915737,915861,916097,916141,916157,916170,917598,917633,918093,918489,918594,918684,918787,918792,918799,918803,918885,919851,919914,920025,920055,920298,920449,920596,920824,920840,921444,922010,926716,927062,927621,928482,928695,928732,928798,931709,932357,932967,935983,939491,939551,940064,941356,941463,944409,944416,945808,945835,945841,946686 +/tomcat/trunk:601180,606992,612607,630314,640888,652744,653247,666232,673796,673820,677910,683969,683982,684001,684081,684234,684269-684270,685177,687503,687645,689402,690781,691392,691805,692748,693378,694992,695053,695311,696780,696782,698012,698227,698236,698613,699427,699634,701355,709294,709811,709816,710063,710066,710125,710205,711126,711600,712461,712467,713953,714002,718360,719119,719124,719602,719626,719628,720046,720069,721040,721286,721708,721886,723404,723738,726052,727303,728032,728768,728947,729057,729567,729569,729571,729681,729809,729815,729934,730250,730590,731651,732859,732863,734734,740675,740684,742677,742697,742714,744160,744238,746321,746384,746425,747834,747863,748344,750258,750291,750921,751286-751287,751289,751295,752323,753039,757335,757774,758249,758365,758596,758616,758664,759074,761601,762868,762929,762936-762937,763166,763183,763193,763228,763262,763298,763302,763325,763599,763611,763654,763681,763706,764985,764997,765662,768335,769979,770716,77 0809,770876,772872,776921,776924,776935,776945,777464,777466,777576,777625,778379,778523-778524,781528,781779,782145,782791,783316,783696,783724,783756,783762,783766,783863,783934,784453,784602,784614,785381,785688,785768,785859,786468,786487,786490,786496,786667,787627,787770,787985,789389,790405,791041,791184,791194,791224,791243,791326,791328,791789,792740,793372,793757,793882,793981,794082,794673,794822,795043,795152,795210,795457,795466,797168,797425,797596,797607,802727,802940,804462,804544,804734,805153,809131,809603,810916,810977,812125,812137,812432,813001,813013,813866,814180,814708,814876,815972,816252,817442,817822,819339,819361,820110,820132,820874,820954,821397,828196,828201,828210,828225,828759,830378-830379,830999,831106,831774,831785,831828,831850,831860,832214,832218,833121,833545,834047,835036,835336,836405,881396,881412,883130,883134,883146,883165,883177,883362,883565,884341,885038,885231,885241,885260,885901,885991,886019,888072,889363,889606,889716,8901 39,890265,890349-890350,890417,891185-891187,891583,892198,892341,892415,892464,892555,892812,892814,892817,892843,892887,893321,893493,894580,894586,894805,894831,895013,895045,895057,895191,895392,895703,896370,896384,897380-897381,897776,898126,898256,898468,898527,898555,898558,898718,898836,898906,899284,899348,899420,899653,899769-899770,899783,899788,899792,899916,899918-899919,899935,899949,903916,905020,905151,905722,905728,905735,907311,907513,907538,907652,907819,907825,907864,908002,908721,908754,908759,909097,909206,909212,909525,909636,909869,909875,909887,910266,910370,910442,910471,910485,910974,915226,915737,915861,916097,916141,916157,916170,917598,917633,918093,918489,918594,918684,918787,918792,918799,918803,918885,919851,919914,920025,920055,920298,920449,920596,920824,920840,921444,922010,926716,927062,927621,928482,928695,928732,928798,931709,932357,932967,935105,935983,939491,939551,940064,941356,941463,944409,944416,945808,945835,945841,946686 Modified: tomcat/tc6.0.x/trunk/STATUS.txt URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/STATUS.txt?rev=950137&r1=950136&r2=950137&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/STATUS.txt (original) +++ tomcat/tc6.0.x/trunk/STATUS.txt Tue Jun 1 16:05:20 2010 @@ -75,11 +75,6 @@ PATCHES PROPOSED TO BACKPORT: +1: markt -1: -* Improve the ChatServlet comet example and fix some issues there - http://svn.apache.org/viewvc?rev=935105&view=rev - +1: kkolinko, markt, rjung - -1: - * Configure Tomcat to use HttpOnly for session cookies by default http://people.apache.org/~kkolinko/patches/2010-04-21_tc6_context_httpOnly.patch +1: kkolinko Modified: tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml?rev=950137&r1=950136&r2=950137&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml (original) +++ tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml Tue Jun 1 16:05:20 2010 @@ -228,6 +228,10 @@ Add support for displaying the Spring Security user name (if present) in the Manager application. (markt) </add> + <update> + Improve the ChatServlet <a href="aio.html">Comet</a> example + (/examples/jsp/chat/). (kkolinko) + </update> </changelog> </subsection> <subsection name="Other"> Modified: tomcat/tc6.0.x/trunk/webapps/examples/WEB-INF/classes/chat/ChatServlet.java URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/examples/WEB-INF/classes/chat/ChatServlet.java?rev=950137&r1=950136&r2=950137&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/webapps/examples/WEB-INF/classes/chat/ChatServlet.java (original) +++ tomcat/tc6.0.x/trunk/webapps/examples/WEB-INF/classes/chat/ChatServlet.java Tue Jun 1 16:05:20 2010 @@ -39,6 +39,8 @@ import javax.servlet.http.HttpServletRes public class ChatServlet extends HttpServlet implements CometProcessor { + private static final String CHARSET = "UTF-8"; + protected ArrayList<HttpServletResponse> connections = new ArrayList<HttpServletResponse>(); protected MessageSender messageSender = null; @@ -78,7 +80,7 @@ public class ChatServlet if ("login".equals(action)) { String nickname = request.getParameter("nickname"); request.getSession(true).setAttribute("nickname", nickname); - response.sendRedirect("post.jsp"); + response.sendRedirect("index.jsp"); event.close(); return; } else { @@ -111,15 +113,20 @@ public class ChatServlet protected void begin(CometEvent event, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { log("Begin for session: " + request.getSession(true).getId()); - + + response.setContentType("text/html; charset=" + CHARSET); + PrintWriter writer = response.getWriter(); - writer.println("<!doctype html public \"-//w3c//dtd html 4.0 transitional//en\">"); + writer.println("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">"); writer.println("<html><head><title>JSP Chat</title></head><body bgcolor=\"#FFFFFF\">"); + writer.println("<div>Welcome to the chat. <a href='chat'>Click here to reload this window</a></div>"); writer.flush(); synchronized(connections) { connections.add(response); } + + messageSender.send("Tomcat", request.getSession(true).getAttribute("nickname") + " joined the chat."); } protected void end(CometEvent event, HttpServletRequest request, HttpServletResponse response) @@ -133,7 +140,6 @@ public class ChatServlet writer.println("</body></html>"); event.close(); - } protected void error(CometEvent event, HttpServletRequest request, HttpServletResponse response) @@ -166,10 +172,12 @@ public class ChatServlet protected void service(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { // Compatibility method: equivalent method using the regular connection model + response.setContentType("text/html; charset=" + CHARSET); PrintWriter writer = response.getWriter(); - writer.println("<!doctype html public \"-//w3c//dtd html 4.0 transitional//en\">"); + writer.println("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">"); writer.println("<html><head><title>JSP Chat</title></head><body bgcolor=\"#FFFFFF\">"); - writer.println("Chat example only supports Comet processing"); + writer.println("Chat example only supports Comet processing. "); + writer.println("Configure a connector that supports Comet and try again."); writer.println("</body></html>"); } @@ -187,6 +195,9 @@ public class ChatServlet public void stop() { running = false; + synchronized (messages) { + messages.notify(); + } } /** @@ -212,34 +223,29 @@ public class ChatServlet // Loop until we receive a shutdown command while (running) { - // Loop if endpoint is paused - - if (messages.size() == 0) { + String[] pendingMessages; + synchronized (messages) { try { - synchronized (messages) { + if (messages.size() == 0) { messages.wait(); } } catch (InterruptedException e) { // Ignore } + pendingMessages = messages.toArray(new String[0]); + messages.clear(); } synchronized (connections) { - String[] pendingMessages = null; - synchronized (messages) { - pendingMessages = messages.toArray(new String[0]); - messages.clear(); - } for (int i = 0; i < connections.size(); i++) { try { PrintWriter writer = connections.get(i).getWriter(); for (int j = 0; j < pendingMessages.length; j++) { - // FIXME: Add HTML filtering - writer.println(pendingMessages[j] + "<br/>"); + writer.println("<div>"+filter(pendingMessages[j]) + "</div>"); } writer.flush(); } catch (IOException e) { - log("IOExeption sending message", e); + log("IOException sending message", e); } } } @@ -250,7 +256,38 @@ public class ChatServlet } - - - + /** + * Filter the specified message string for characters that are sensitive + * in HTML. + * + * @param message The message string to be filtered + * @author Copied from org.apache.catalina.util.RequestUtil#filter(String) + */ + protected static String filter(String message) { + if (message == null) + return (null); + + char content[] = new char[message.length()]; + message.getChars(0, message.length(), content, 0); + StringBuilder result = new StringBuilder(content.length + 50); + for (int i = 0; i < content.length; i++) { + switch (content[i]) { + case '<': + result.append("<"); + break; + case '>': + result.append(">"); + break; + case '&': + result.append("&"); + break; + case '"': + result.append("""); + break; + default: + result.append(content[i]); + } + } + return (result.toString()); + } } Modified: tomcat/tc6.0.x/trunk/webapps/examples/jsp/chat/login.jsp URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/examples/jsp/chat/login.jsp?rev=950137&r1=950136&r2=950137&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/webapps/examples/jsp/chat/login.jsp (original) +++ tomcat/tc6.0.x/trunk/webapps/examples/jsp/chat/login.jsp Tue Jun 1 16:05:20 2010 @@ -1,4 +1,5 @@ -<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<%...@page contentType="text/html; charset=UTF-8" %> <html> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -22,9 +23,10 @@ <body bgcolor="#FFFFFF"> -<form method="POST" action='chat' name="loginForm"> -<input type="hidden" name="action" value="login"/> -Nickname: <input type="text" name="nickname"/> +<form method="POST" action='chat' target="_top" name="loginForm"> +<input type="hidden" name="action" value="login"> +Nickname: <input type="text" name="nickname"> +<input type="submit"> </form> </body> Modified: tomcat/tc6.0.x/trunk/webapps/examples/jsp/chat/post.jsp URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/examples/jsp/chat/post.jsp?rev=950137&r1=950136&r2=950137&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/webapps/examples/jsp/chat/post.jsp (original) +++ tomcat/tc6.0.x/trunk/webapps/examples/jsp/chat/post.jsp Tue Jun 1 16:05:20 2010 @@ -1,4 +1,5 @@ -<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<%...@page contentType="text/html; charset=UTF-8" %> <html> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -23,14 +24,32 @@ <body bgcolor="#FFFFFF"> <form method="POST" action='chat' name="postForm"> -<input type="hidden" name="action" value="post"/> -Message: <input type="text" name="message"/> +<input type="hidden" name="action" value="post"> +Message: <input type="text" name="message"> +<input type="submit"> </form> <br> -<br> - -<a href="javascript:openWindow('http://127.0.0.1:8080/examples/jsp/chat/chat', 640, 480 ,0 ,0 ,0 ,0 ,0 ,1 ,10 ,10 )">Click to open chat window</a> - +<% + String serverName = request.getServerName(); + if ("localhost".equals(serverName)) { + serverName = "127.0.0.1"; + } else if ("127.0.0.1".equals(serverName)) { + serverName = "localhost"; + } + + String chatUrl = request.getScheme() + "://" + serverName + ":" + + request.getServerPort() + request.getContextPath() + + request.getServletPath(); + + // strip "post.jsp" from the address + chatUrl = chatUrl.substring(0, chatUrl.lastIndexOf("/") + 1); +%> +<a target="_blank" href="<%=chatUrl %>">Click to open a new chat window</a> +<em>Note</em>: To avoid hitting the limit on the count of simultaneous +connections to the same host, imposed by the +<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec8.html#sec8.1.4">HTTP specification</a>, +the second chat window should be opened using a different URL, e.g. with +an IP address instead of the host name. </body> </html> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org