//
// ========================================================================
// Copyright (c) 1995-2014 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.websocket.common;
import java.nio.ByteBuffer;
import org.eclipse.jetty.util.StringUtil;
import org.eclipse.jetty.util.Utf8Appendable.NotUtf8Exception;
import org.eclipse.jetty.util.Utf8StringBuilder;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.websocket.api.BadPayloadException;
import org.eclipse.jetty.websocket.api.ProtocolException;
import org.eclipse.jetty.websocket.api.StatusCode;
import org.eclipse.jetty.websocket.api.extensions.Frame;
import org.eclipse.jetty.websocket.common.frames.CloseFrame;
public class CloseInfo
{
private static final Logger LOG = Log.getLogger(CloseInfo.class);
private int statusCode;
private String reason;
public CloseInfo()
{
this(StatusCode.NO_CODE,null);
}
public CloseInfo(ByteBuffer payload, boolean validate)
{
this.statusCode = StatusCode.NO_CODE;
this.reason = null;
if ((payload == null) || (payload.remaining() == 0))
{
return; // nothing to do
}
ByteBuffer data = payload.slice();
if ((data.remaining() == 1) && (validate))
{
throw new ProtocolException("Invalid 1 byte payload");
}
if (data.remaining() >= 2)
{
// Status Code
statusCode = 0; // start with 0
statusCode |= (data.get() & 0xFF) << 8;
statusCode |= (data.get() & 0xFF);
if(validate) {
if ((statusCode < StatusCode.NORMAL) || (statusCode == StatusCode.UNDEFINED) || (statusCode == StatusCode.NO_CLOSE)
|| (statusCode == StatusCode.NO_CODE) || ((statusCode > 1011) && (statusCode <= 2999)) || (statusCode >= 5000))
{
throw new ProtocolException("Invalid close code: " + statusCode);
}
}
if (data.remaining() > 0)
{
// Reason
try
{
Utf8StringBuilder utf = new Utf8StringBuilder();
utf.append(data);
reason = utf.toString();
}
catch (NotUtf8Exception e)
{
if (validate)
{
throw new BadPayloadException("Invalid Close Reason",e);
}
else
{
LOG.warn(e);
}
}
catch (RuntimeException e)
{
if (validate)
{
throw new ProtocolException("Invalid Close Reason",e);
}
else
{
LOG.warn(e);
}
}
}
}
}
public CloseInfo(Frame frame)
{
this(frame.getPayload(),false);
}
public CloseInfo(Frame frame, boolean validate)
{
this(frame.getPayload(),validate);
}
public CloseInfo(int statusCode)
{
this(statusCode, null);
}
public CloseInfo(int statusCode, String reason)
{
this.statusCode = statusCode;
this.reason = reason;
}
private ByteBuffer asByteBuffer()
{
if ((statusCode == StatusCode.NO_CLOSE) || (statusCode == StatusCode.NO_CODE) || (statusCode == (-1)))
{
// codes that are not allowed to be used in endpoint.
return null;
}
int len = 2; // status code
byte utf[] = null;
if (StringUtil.isNotBlank(reason))
{
utf = StringUtil.getUtf8Bytes(reason);
len += utf.length;
}
ByteBuffer buf = ByteBuffer.allocate(len);
buf.put((byte)((statusCode >>> 8) & 0xFF));
buf.put((byte)((statusCode >>> 0) & 0xFF));
if (utf != null)
{
buf.put(utf,0,utf.length);
}
buf.flip();
return buf;
}
public CloseFrame asFrame()
{
CloseFrame frame = new CloseFrame();
frame.setFin(true);
frame.setPayload(asByteBuffer());
return frame;
}
public String getReason()
{
return reason;
}
public int getStatusCode()
{
return statusCode;
}
public boolean isHarsh()
{
return !((statusCode == StatusCode.NORMAL) || (statusCode == StatusCode.NO_CODE));
}
public boolean isAbnormal()
{
return (statusCode == StatusCode.ABNORMAL);
}
@Override
public String toString()
{
return String.format("CloseInfo[code=%d,reason=%s]",statusCode,reason);
}
}