de.fraunhofer.iosb.ilt.frostserver.http.common.HttpRequestDecoder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of FROST-Server.HTTP.Common Show documentation
Show all versions of FROST-Server.HTTP.Common Show documentation
HTTP bindings for the FROST-Server.
The newest version!
/*
* Copyright (C) 2024 Fraunhofer Institut IOSB, Fraunhoferstr. 1, D 76131
* Karlsruhe, Germany.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see {
private static final Logger LOGGER = LoggerFactory.getLogger(HttpRequestDecoder.class.getName());
@DefaultValueBoolean(false)
public static final String TAG_AUTODETECT_ROOT_URL = "autodetectRootUrl";
@DefaultValueBoolean(false)
public static final String TAG_USE_X_HEADERS = "useXForwardedHeaders";
@DefaultValue("X-Forwarded-Host")
public static final String TAG_HEADER_XF_HOST = "XForwardedHostHeader";
@DefaultValue("X-Forwarded-Path")
public static final String TAG_HEADER_XF_PATH = "XForwardedPathHeader";
@DefaultValue("X-Forwarded-Port")
public static final String TAG_HEADER_XF_PORT = "XForwardedPortHeader";
@DefaultValue("X-Forwarded-Proto")
public static final String TAG_HEADER_XF_PROTO = "XForwardedProtoHeader";
private final CoreSettings coreSettings;
private final boolean autodetectRootUrl;
private final boolean useXHeaders;
private String headerXfHost;
private String headerXfPath;
private String headerXfPort;
private String headerXfProto;
private HttpRequestDecoder(CoreSettings coreSettings) {
this.coreSettings = coreSettings;
setSettings(coreSettings.getHttpSettings().getSubSettings("requestDecoder."));
String serviceRootUrl = coreSettings.getQueryDefaults().getServiceRootUrl();
boolean myAutodetectRootUrl = getBoolean(TAG_AUTODETECT_ROOT_URL);
if (!myAutodetectRootUrl && StringHelper.isNullOrEmpty(serviceRootUrl)) {
LOGGER.warn("serviceRootUrl is not set and autodetectRootUrl is false! Setting autodetectRootUrl to true!");
autodetectRootUrl = true;
} else {
autodetectRootUrl = myAutodetectRootUrl;
}
useXHeaders = getBoolean(TAG_USE_X_HEADERS);
if (useXHeaders) {
headerXfHost = get(TAG_HEADER_XF_HOST);
headerXfPath = get(TAG_HEADER_XF_PATH);
headerXfPort = get(TAG_HEADER_XF_PORT);
headerXfProto = get(TAG_HEADER_XF_PROTO);
}
}
public ServiceRequest serviceRequestFromHttpRequest(HttpServletRequest request) throws IOException {
if (request.getCharacterEncoding() == null) {
request.setCharacterEncoding(StandardCharsets.UTF_8.name());
}
// request.getPathInfo() is decoded, breaking urls that contain //
// (ids that are urls)
final String requestURI = request.getRequestURI();
final String contextPath = request.getContextPath();
final String servletPath = request.getServletPath();
final String basePath = contextPath + servletPath;
final String pathInfo;
if (requestURI.startsWith(basePath)) {
pathInfo = StringHelper.urlDecode(requestURI.substring(basePath.length()));
} else {
pathInfo = request.getPathInfo();
}
final int idxSlash2 = pathInfo.indexOf('/', 1);
final String path;
final Version version;
if (idxSlash2 > 0) {
path = pathInfo.substring(idxSlash2);
version = coreSettings.getPluginManager().getVersion(pathInfo.substring(1, idxSlash2));
} else {
path = "";
version = coreSettings.getPluginManager().getVersion(pathInfo.substring(1));
}
if (version == null) {
return null;
}
QueryDefaults queryDefaults = coreSettings.getQueryDefaults().copy();
if (autodetectRootUrl) {
String detectedRootUrl = generateRootUrl(request, version, basePath);
LOGGER.debug("Detected serviceRootURL: {}", detectedRootUrl);
queryDefaults.setServiceRootUrl(detectedRootUrl);
}
final PluginService plugin = coreSettings.getPluginManager().getServiceForPath(version, path);
if (plugin == null) {
return null;
}
final HttpMethod method = HttpMethod.fromString(request.getMethod());
final String requestType = PluginManager.decodeRequestType(plugin, version, path, method, request.getContentType());
final boolean head = method == HttpMethod.HEAD;
final Map> parameterMap = UrlHelper.splitQuery(request.getQueryString());
decodeAccepHeader(request, parameterMap);
decodePreferHeader(request, parameterMap);
final ServiceRequest serviceRequest = new ServiceRequest()
.setCoreSettings(coreSettings)
.setQueryDefaults(queryDefaults)
.setVersion(version)
.setRequestType(requestType)
.setHead(head)
.setUrlPath(path)
.setUrlQuery(request.getQueryString() != null
? StringHelper.urlDecode(request.getQueryString())
: null)
.setContent(request.getInputStream())
.setContentType(request.getContentType())
.setParameterMap(parameterMap)
.setUpdateMode(RequestTypeUtils.CREATE.equals(requestType) ? UpdateMode.INSERT_STA_11 : UpdateMode.UPDATE_STA_11)
.setUserPrincipal(PrincipalExtended.fromPrincipal(request.getUserPrincipal()));
Enumeration attributeNames = request.getAttributeNames();
while (attributeNames.hasMoreElements()) {
String name = attributeNames.nextElement();
serviceRequest.setAttribute(name, request.getAttribute(name));
}
logServiceRequest(request, serviceRequest);
return serviceRequest;
}
private String generateRootUrl(HttpServletRequest request, Version version, String reqBasePath) {
if (useXHeaders) {
String xfHost = request.getHeader(headerXfHost);
String xfProto = request.getHeader(headerXfProto);
String xfPort = request.getHeader(headerXfPort);
String xfPath = request.getHeader(headerXfPath);
String basePath;
if (!StringHelper.isNullOrEmpty(xfPath)) {
basePath = xfPath;
} else {
basePath = reqBasePath;
}
int versionIdx = xfPath.indexOf(version.urlPart);
if (versionIdx > 0) {
basePath = xfPath.substring(0, versionIdx - 1);
}
return xfProto + "://" + xfHost + ":" + xfPort + basePath;
} else {
final String requestURL = request.getRequestURL().toString();
int versionIdx = requestURL.indexOf(version.urlPart);
return requestURL.substring(0, versionIdx - 1);
}
}
@Override
public HttpRequestDecoder getThis() {
return this;
}
static ServiceRequest serviceRequestFromHttpRequest(CoreSettings coreSettings, HttpServletRequest request) throws IOException {
final Object requestDecoder = coreSettings.getRequestDecoder();
if (requestDecoder instanceof HttpRequestDecoder hrd) {
return hrd.serviceRequestFromHttpRequest(request);
}
LOGGER.info("Creating new HttpRequestDecoder");
HttpRequestDecoder hrd = new HttpRequestDecoder(coreSettings);
coreSettings.setRequestDecoder(hrd);
return hrd.serviceRequestFromHttpRequest(request);
}
public static void logServiceRequest(HttpServletRequest request, ServiceRequest serivceRequest) {
if (LOGGER.isDebugEnabled()) {
final StringBuilder headers = new StringBuilder();
Enumeration headerNames = request.getHeaderNames();
while (headerNames.hasMoreElements()) {
String name = headerNames.nextElement();
Enumeration values = request.getHeaders(name);
while (values.hasMoreElements()) {
headers.append("\n - ").append(name).append(" -> ").append(values.nextElement());
}
}
LOGGER.debug("Request: {} {} {}{}", request.getMethod(), request.getRequestURI(), serivceRequest.getUrlQuery(), headers);
}
}
private static void decodeAccepHeader(HttpServletRequest request, final Map> parameterMap) {
String accept = request.getHeader(HEADER_ACCEPT);
if (accept != null) {
parameterMap.putIfAbsent(HEADER_ACCEPT, Arrays.asList(accept));
}
}
private static void decodePreferHeader(HttpServletRequest request, final Map> parameterMap) {
LinkedHashMap prefer = new LinkedHashMap<>();
for (Enumeration en = request.getHeaders(HEADER_PREFER); en.hasMoreElements();) {
UrlHelper.decodePrefer(en.nextElement(), prefer);
}
for (Map.Entry entry : prefer.entrySet()) {
parameterMap.putIfAbsent(entry.getKey(), Arrays.asList(entry.getValue()));
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy