All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.languagetool.server.ServerTools Maven / Gradle / Ivy
/* LanguageTool, a natural language style checker
* Copyright (C) 2016 Daniel Naber (http://www.danielnaber.de)
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
* USA
*/
package org.languagetool.server;
import com.sun.net.httpserver.HttpExchange;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.languagetool.JLanguageTool;
import java.io.PrintStream;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.Map;
import java.util.TimeZone;
import java.util.regex.Pattern;
/**
* @since 3.4
*/
final class ServerTools {
private final static Pattern sentContentPattern = Pattern.compile(".* ", Pattern.DOTALL);
private ServerTools() {
}
@NotNull
static String getLoggingInfo(String remoteAddress, Exception e, int errorCode, HttpExchange httpExchange, Map params, long runtimeMillis, RequestCounter reqCounter) {
String message = "";
if (e != null) {
message += "An error has occurred: '" + ServerTools.cleanUserTextFromMessage(e.getMessage(), params) + "', sending HTTP code " + errorCode + ". ";
}
message += "Access from " + remoteAddress + ", ";
message += "HTTP user agent: " + getHttpUserAgent(httpExchange) + ", ";
message += "User agent param: " + params.get("useragent") + ", ";
if (params.get("v") != null) {
message += "v: " + params.get("v") + ", ";
}
message += "Referrer: " + getHttpReferrer(httpExchange) + ", ";
message += "language: " + params.get("language") + ", ";
message += "h: " + reqCounter.getHandleCount() + ", ";
message += "r: " + reqCounter.getRequestCount() + ", ";
if (params.get("username") != null) {
message += "user: " + params.get("username") + ", ";
}
if (params.get("apiKey") != null) {
message += "apiKey: " + params.get("apiKey") + ", ";
}
if (params.get("tokenV2") != null) {
message += "tokenV2: " + params.get("tokenV2") + ", ";
}
message += "time: " + runtimeMillis;
return message;
}
@Nullable
static String getHttpUserAgent(HttpExchange httpExchange) {
return httpExchange.getRequestHeaders().getFirst("User-Agent");
}
@Nullable
static String getHttpReferrer(HttpExchange httpExchange) {
return httpExchange.getRequestHeaders().getFirst("Referer");
}
static String getSQLDatetimeString(Calendar date) {
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
return dateFormat.format(date.getTime());
}
static String getSQLDateString(Calendar date) {
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
return dateFormat.format(date.getTime());
}
static void print(String s) {
print(s, System.out);
}
/* replace with structured logging:
check done
cache stats
maybe: (could be combined in table)
Access denied: request size / rate limit / ...
more interesting:
error rate too high
text checking took longer than ...
misc.:
language code unknown
missing arguments
old api
blacklisted referrer
various other exceptions
*/
static void print(String s, PrintStream outputStream) {
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss ZZ");
dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
String now = dateFormat.format(new Date());
outputStream.println(now + " " + s);
}
static void setCommonHeaders(HttpExchange httpExchange, String contentType, String allowOriginUrl) {
httpExchange.getResponseHeaders().set("Content-Type", contentType);
setAllowOrigin(httpExchange, allowOriginUrl);
}
static void setAllowOrigin(HttpExchange httpExchange, String allowOriginUrl) {
if (allowOriginUrl != null) {
httpExchange.getResponseHeaders().set("Access-Control-Allow-Origin", allowOriginUrl);
}
}
static UserLimits getUserLimits(Map params, HTTPServerConfig config) {
if (params.get("token") != null) {
return UserLimits.getLimitsFromToken(config, params.get("token"));
} else if (params.get("username") != null) {
if (params.get("apiKey") != null && params.get("password") != null) {
// TODO: throw exception (but first log to see how often this happens)
print("WARN: apiKey AND password was set: " + params.get("apiKey"), System.err);
}
if (params.get("apiKey") != null) {
return UserLimits.getLimitsByApiKey(config, params.get("username"), params.get("apiKey"));
} else if (params.get("password") != null) {
return UserLimits.getLimitsFromUserAccount(config, params.get("username"), params.get("password"));
} else {
throw new IllegalArgumentException("With 'username' set, you also need to specify 'apiKey'");
}
} else {
if (params.get("apiKey") != null) {
throw new IllegalArgumentException("apiKey was set, but username was not: " + params.get("apiKey"));
}
if (params.get("password") != null) {
throw new IllegalArgumentException("password was set, but username was not");
}
return UserLimits.getDefaultLimits(config);
}
}
@NotNull
static JLanguageTool.Mode getMode(Map params) {
JLanguageTool.Mode mode;
if (params.get("mode") != null) {
String modeParam = params.get("mode");
if ("textLevelOnly".equals(modeParam)) {
mode = JLanguageTool.Mode.TEXTLEVEL_ONLY;
} else if ("allButTextLevelOnly".equals(modeParam)) {
mode = JLanguageTool.Mode.ALL_BUT_TEXTLEVEL_ONLY;
} else if ("all".equals(modeParam)) {
mode = JLanguageTool.Mode.ALL;
} else {
throw new IllegalArgumentException("Mode must be one of 'textLevelOnly', 'allButTextLevelOnly', or 'all' but was: '" + modeParam + "'");
}
} else {
mode = JLanguageTool.Mode.ALL;
}
return mode;
}
@NotNull
static String getModeForLog(JLanguageTool.Mode mode) {
switch (mode) {
case TEXTLEVEL_ONLY: return "tlo";
case ALL_BUT_TEXTLEVEL_ONLY: return "!tlo";
case ALL: return "all";
default: return "?";
}
}
@NotNull
static JLanguageTool.Level getLevel(Map params) {
JLanguageTool.Level level;
if (params.get("level") != null) {
String param = params.get("level");
if ("default".equals(param)) {
level = JLanguageTool.Level.DEFAULT;
} else if ("picky".equals(param)) {
level = JLanguageTool.Level.PICKY;
} else {
throw new IllegalArgumentException("If 'level' is set, it must be set to 'default' or 'picky'");
}
} else {
level = JLanguageTool.Level.DEFAULT;
}
return level;
}
/**
* Remove user-content from message in case parameters require increased privacy.
* @since 5.0
*/
public static String cleanUserTextFromMessage(String s, Map params) {
if (params.getOrDefault("inputLogging", "").equals("no")) {
return sentContentPattern.matcher(s).replaceAll("<< content removed >>");
}
return s;
}
}
