/*
* PS3 Media Server, for streaming any medias to your PS3.
* Copyright (C) 2008 A.Brochard
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; version 2
* of the License only.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package net.pms.network;
import java.io.IOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.nio.channels.ClosedChannelException;
import java.nio.charset.Charset;
import java.util.Iterator;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import net.pms.PMS;
import net.pms.configuration.RendererConfiguration;
import net.pms.external.StartStopListenerDelegate;
import org.apache.commons.lang3.StringUtils;
import org.jboss.netty.buffer.ChannelBuffer;
import org.jboss.netty.buffer.ChannelBuffers;
import org.jboss.netty.channel.*;
import org.jboss.netty.channel.group.ChannelGroup;
import org.jboss.netty.handler.codec.frame.TooLongFrameException;
import org.jboss.netty.handler.codec.http.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class RequestHandlerV2 extends SimpleChannelUpstreamHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(RequestHandlerV2.class);
private static final Pattern TIMERANGE_PATTERN = Pattern.compile(
"timeseekrange\\.dlna\\.org\\W*npt\\W*=\\W*([\\d.:]+)?-?([\\d.:]+)?",
Pattern.CASE_INSENSITIVE
);
private volatile HttpRequest nettyRequest;
private final ChannelGroup group;
public RequestHandlerV2(ChannelGroup group) {
this.group = group;
}
// Used to filter out known headers when the renderer is not recognized
private final static String[] KNOWN_HEADERS = {
"accept",
"accept-language",
"accept-encoding",
"callback",
"connection",
"content-length",
"content-type",
"date",
"host",
"nt",
"sid",
"timeout",
"user-agent"
};
@Override
public void messageReceived(ChannelHandlerContext ctx, MessageEvent e)
throws Exception {
RequestV2 request = null;
RendererConfiguration renderer = null;
String userAgentString = null;
StringBuilder unknownHeaders = new StringBuilder();
String separator = "";
HttpRequest nettyRequest = this.nettyRequest = (HttpRequest) e.getMessage();
InetSocketAddress remoteAddress = (InetSocketAddress) e.getChannel().getRemoteAddress();
InetAddress ia = remoteAddress.getAddress();
// Apply the IP filter
if (filterIp(ia)) {
e.getChannel().close();
LOGGER.trace("Access denied for address " + ia + " based on IP filter");
return;
}
LOGGER.trace("Opened request handler on socket " + remoteAddress);
PMS.get().getRegistry().disableGoToSleep();
request = new RequestV2(nettyRequest.getMethod().getName(), nettyRequest.getUri().substring(1));
LOGGER.trace("Request: " + nettyRequest.getProtocolVersion().getText() + " : " + request.getMethod() + " : " + request.getArgument());
if (nettyRequest.getProtocolVersion().getMinorVersion() == 0) {
request.setHttp10(true);
}
HttpHeaders headers = nettyRequest.headers();
// The handler makes a couple of attempts to recognize a renderer from its requests.
// IP address matches from previous requests are preferred, when that fails request
// header matches are attempted and if those fail as well we're stuck with the
// default renderer.
// Attempt 1: try to recognize the renderer by its socket address from previous requests
renderer = RendererConfiguration.getRendererConfigurationBySocketAddress(ia);
if (renderer == null) {
// Attempt 2: try to recognize the renderer by matching headers
renderer = RendererConfiguration.getRendererConfigurationByHeaders(headers.entries());
}
if (renderer != null) {
renderer.associateIP(ia);
PMS.get().setRendererFound(renderer);
request.setMediaRenderer(renderer);
}
Set<String> headerNames = headers.names();
Iterator<String> iterator = headerNames.iterator();
while (iterator.hasNext()) {
String name = iterator.next();
String headerLine = name + ": " + headers.get(name);
LOGGER.trace("Received on socket: " + headerLine);
if (headerLine.toUpperCase().startsWith("USER-AGENT")) {
userAgentString = headerLine.substring(headerLine.indexOf(':') + 1).trim();
}
try {
StringTokenizer s = new StringTokenizer(headerLine);
String temp = s.nextToken();
if (temp.toUpperCase().equals("SOAPACTION:")) {
request.setSoapaction(s.nextToken());
} else if (temp.toUpperCase().equals("CALLBACK:")) {
request.setSoapaction(s.nextToken());
} else if (headerLine.toUpperCase().contains("RANGE: BYTES=")) {
String nums = headerLine.substring(
headerLine.toUpperCase().indexOf(
"RANGE: BYTES=") + 13).trim();
StringTokenizer st = new StringTokenizer(nums, "-");
if (!nums.startsWith("-")) {
request.setLowRange(Long.parseLong(st.nextToken()));
}
if (!nums.startsWith("-") && !nums.endsWith("-")) {
request.setHighRange(Long.parseLong(st.nextToken()));
} else {
request.setHighRange(-1);
}
} else if (headerLine.toLowerCase().contains("transfermode.dlna.org:")) {
request.setTransferMode(headerLine.substring(headerLine.toLowerCase().indexOf("transfermode.dlna.org:") + 22).trim());
} else if (headerLine.toLowerCase().contains("getcontentfeatures.dlna.org:")) {
request.setContentFeatures(headerLine.substring(headerLine.toLowerCase().indexOf("getcontentfeatures.dlna.org:") + 28).trim());
} else {
Matcher matcher = TIMERANGE_PATTERN.matcher(headerLine);
if (matcher.find()) {
String first = matcher.group(1);
if (first != null) {
request.setTimeRangeStartString(first);
}
String end = matcher.group(2);
if (end != null) {
request.setTimeRangeEndString(end);
}
} else {
/** If we made it to here, none of the previous header checks matched.
* Unknown headers make interesting logging info when we cannot recognize
* the media renderer, so keep track of the truly unknown ones.
*/
boolean isKnown = false;
// Try to match known headers.
String lowerCaseHeaderLine = headerLine.toLowerCase();
for (String knownHeaderString : KNOWN_HEADERS) {
if (lowerCaseHeaderLine.startsWith(knownHeaderString)) {
isKnown = true;
break;
}
}
// It may be unusual but already known
if (renderer != null) {
String additionalHeader = renderer.getUserAgentAdditionalHttpHeader();
if (StringUtils.isNotBlank(additionalHeader) && lowerCaseHeaderLine.startsWith(additionalHeader)) {
isKnown = true;
}
}
if (!isKnown) {
// Truly unknown header, therefore interesting. Save for later use.
unknownHeaders.append(separator).append(headerLine);
separator = ", ";
}
}
}
} catch (Exception ee) {
LOGGER.error("Error parsing HTTP headers", ee);
}
}
// Still no media renderer recognized?
if (request.getMediaRenderer() == null) {
// Attempt 4: Not really an attempt; all other attempts to recognize
// the renderer have failed. The only option left is to assume the
// default renderer.
request.setMediaRenderer(RendererConfiguration.getDefaultConf());
LOGGER.trace("Using default media renderer: " + request.getMediaRenderer().getRendererName());
if (userAgentString != null && !userAgentString.equals("FDSSDP")) {
// We have found an unknown renderer
LOGGER.info("Media renderer was not recognized. Possible identifying HTTP headers: User-Agent: " + userAgentString
+ ("".equals(unknownHeaders.toString()) ? "" : ", " + unknownHeaders.toString()));
PMS.get().setRendererFound(request.getMediaRenderer());
}
} else {
if (userAgentString != null) {
LOGGER.debug("HTTP User-Agent: " + userAgentString);
}
LOGGER.trace("Recognized media renderer: " + request.getMediaRenderer().getRendererName());
}
if (nettyRequest.headers().contains(HttpHeaders.Names.CONTENT_LENGTH)) {
byte data[] = new byte[(int) HttpHeaders.getContentLength(nettyRequest)];
ChannelBuffer content = nettyRequest.getContent();
content.readBytes(data);
request.setTextContent(new String(data, "UTF-8"));
}
LOGGER.trace("HTTP: " + request.getArgument() + " / " + request.getLowRange() + "-" + request.getHighRange());
writeResponse(e, request, ia);
}
/**
* Applies the IP filter to the specified internet address. Returns true
* if the address is not allowed and therefore should be filtered out,
* false otherwise.
*
* @param inetAddress The internet address to verify.
* @return True when not allowed, false otherwise.
*/
private boolean filterIp(InetAddress inetAddress) {
return !PMS.getConfiguration().getIpFiltering().allowed(inetAddress);
}
private void writeResponse(MessageEvent e, RequestV2 request, InetAddress ia) {
// Decide whether to close the connection or not.
boolean close = HttpHeaders.Values.CLOSE.equalsIgnoreCase(nettyRequest.headers().get(HttpHeaders.Names.CONNECTION)) ||
nettyRequest.getProtocolVersion().equals(HttpVersion.HTTP_1_0) &&
!HttpHeaders.Values.KEEP_ALIVE.equalsIgnoreCase(nettyRequest.headers().get(HttpHeaders.Names.CONNECTION));
// Build the response object.
HttpResponse response;
if (request.getLowRange() != 0 || request.getHighRange() != 0) {
response = new DefaultHttpResponse(
HttpVersion.HTTP_1_1,
HttpResponseStatus.PARTIAL_CONTENT
);
} else {
String soapAction = nettyRequest.headers().get("SOAPACTION");
if (soapAction != null && soapAction.contains("X_GetFeatureList")) {
LOGGER.debug("Invalid action in SOAPACTION: " + soapAction);
response = new DefaultHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.INTERNAL_SERVER_ERROR);
} else {
response = new DefaultHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.OK);
}
}
StartStopListenerDelegate startStopListenerDelegate = new StartStopListenerDelegate(ia.getHostAddress());
try {
request.answer(response, e, close, startStopListenerDelegate);
} catch (IOException e1) {
LOGGER.trace("HTTP request V2 IO error: " + e1.getMessage());
// note: we don't call stop() here in a finally block as
// answer() is non-blocking. we only (may) need to call it
// here in the case of an exception. it's a no-op if it's
// already been called
startStopListenerDelegate.stop();
}
}
@Override
public void exceptionCaught(ChannelHandlerContext ctx, ExceptionEvent e)
throws Exception {
Channel ch = e.getChannel();
Throwable cause = e.getCause();
if (cause instanceof TooLongFrameException) {
sendError(ctx, HttpResponseStatus.BAD_REQUEST);
return;
}
if (cause != null && !cause.getClass().equals(ClosedChannelException.class) && !cause.getClass().equals(IOException.class)) {
LOGGER.debug("Caught exception", cause);
}
if (ch.isConnected()) {
sendError(ctx, HttpResponseStatus.INTERNAL_SERVER_ERROR);
}
e.getChannel().close();
}
private void sendError(ChannelHandlerContext ctx, HttpResponseStatus status) {
HttpResponse response = new DefaultHttpResponse(
HttpVersion.HTTP_1_1, status);
response.headers().set(
HttpHeaders.Names.CONTENT_TYPE, "text/plain; charset=UTF-8");
response.setContent(ChannelBuffers.copiedBuffer(
"Failure: " + status.toString() + "\r\n", Charset.forName("UTF-8")));
// Close the connection as soon as the error message is sent.
ctx.getChannel().write(response).addListener(ChannelFutureListener.CLOSE);
}
@Override
public void channelOpen(ChannelHandlerContext ctx, ChannelStateEvent e)
throws Exception {
// as seen in http://www.jboss.org/netty/community.html#nabble-td2423020
super.channelOpen(ctx, e);
if (group != null) {
group.add(ctx.getChannel());
}
}
/* Uncomment to see channel events in the trace logs
@Override
public void handleUpstream(ChannelHandlerContext ctx, ChannelEvent e) throws Exception {
// Log all channel events.
LOGGER.trace("Channel upstream event: " + e);
super.handleUpstream(ctx, e);
}
*/
}