Package org.languagetool.server

Class TextChecker

java.lang.Object

org.languagetool.server.TextChecker

Direct Known Subclasses:

V2TextChecker

abstract class TextChecker
extends Object

Since:

3.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	TextChecker.QueryParams

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final AbTestService	AB_TEST_SERVICE
private final ResultCache	cache
private static final int	CACHE_STATS_PRINT
private static final Pattern	COMMA_WHITESPACE_PATTERN
protected final HTTPServerConfig	config
protected static final int	CONTEXT_SIZE
private final DatabaseLogger	databaseLogger
private static final String	ENCODING
private final ExecutorService	executorService
private final Map<String,Integer>	languageCheckCounts
private final LanguageIdentifier	languageIdentifier
private final Long	logServerId
private static final List<String>	onlyTestClients	List of clients enabled for restricted rules A/B testing.
private static final List<String>	onlyTestLanguages	List of languages enabled for restricted rules A/B testing.
private static final List<String>	onlyTestRules	List of rule IDs enabled for restricted rules A/B testing.
private static final List<String>	onlyTestUsers	List of usernames for A/B testing with restricted rules.
private final Set<DatabasePingLogEntry>	pings
private static final int	PINGS_CLEAN_MILLIS
private static final int	PINGS_MAX_SIZE
private long	pingsCleanDateMillis
(package private) PipelinePool	pipelinePool
private final Random	random
private final RequestCounter	reqCounter
private static final String	SPAN_NAME_PREFIX
private final Queue<Runnable>	workQueue

Constructor Summary

Constructors

Constructor	Description
TextChecker(HTTPServerConfig config, boolean internalServer, Queue<Runnable> workQueue, RequestCounter reqCounter)

Method Summary

Modifier and Type	Method	Description
boolean	checkerQueueAlmostFull()
protected void	checkParams(Map<String,String> parameters)
(package private) void	checkText(AnnotatedText aText, HttpExchange httpExchange, Map<String,String> params, ErrorRequestLimiter errorRequestLimiter, String remoteAddress)
(package private) DetectedLanguage	detectLanguageOfString(String text, String fallbackLanguage, List<String> preferredVariants, List<String> noopLangs, List<String> preferredLangs)
(package private) DetectedLanguage	detectLanguageOfString(String text, String fallbackLanguage, List<String> preferredVariants, List<String> noopLangs, List<String> preferredLangs, boolean forcePreferredLanguages)
private Map<Language,AnnotatedTextBuilder>	getBuilderMap(List<FragmentWithLanguage> fragments, Set<Language> maybeUsedLangs)
private List<CategoryId>	getCategoryIds(String paramName, Map<String,String> parameters)
protected List<String>	getCommaSeparatedStrings(String paramName, Map<String,String> parameters)
protected abstract List<String>	getDisabledRuleIds(Map<String,String> parameters)
protected abstract List<String>	getEnabledRuleIds(Map<String,String> parameters)
protected abstract DetectedLanguage	getLanguage(String text, Map<String,String> parameters, List<String> preferredVariants, List<String> additionalDetectLangs, List<String> preferredLangs, boolean testMode)
protected abstract boolean	getLanguageAutoDetect(Map<String,String> parameters)
private Language	getLanguageVariantForCode(String langCode, List<String> preferredVariants)
private List<CheckResults>	getPipelineResults(AnnotatedText aText, Language lang, Language motherTongue, TextChecker.QueryParams params, UserConfig userConfig, RuleMatchListener listener)
protected abstract List<String>	getPreferredVariants(Map<String,String> parameters)
protected abstract String	getResponse(AnnotatedText text, Language language, DetectedLanguage lang, Language motherTongue, List<CheckResults> matches, List<RuleMatch> hiddenMatches, String incompleteResultReason, int compactMode, boolean showPremiumHint, JLanguageTool.Mode mode)
private Map<String,Integer>	getRuleMatchCount(List<CheckResults> res)
private List<CheckResults>	getRuleMatches(AnnotatedText aText, Language lang, Language motherTongue, Map<String,String> parameters, TextChecker.QueryParams params, UserConfig userConfig, RuleMatchListener listener)
private Map<String,Object[]>	getRuleValues(Map<String,String> parameters)
private List<String>	getUserDictWords(UserLimits limits, List<String> groups)
private List<Rule>	getUserRules(UserLimits limits, Language lang, List<String> groups)
private boolean	isOptInThirdPartyAI(UserLimits limits, Map<String,String> params, HTTPServerConfig config)
protected static Language	parseLanguage(String code)
private void	prewarmPipelinePool()
protected abstract void	setHeaders(HttpExchange httpExchange)
private boolean	shouldRunRestrictedRulesTest(Map<String,String> params, String agent, Language lang, List<String> abTest)
(package private) void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PINGS_CLEAN_MILLIS

private static final int PINGS_CLEAN_MILLIS

See Also:

• Constant Field Values

PINGS_MAX_SIZE

private static final int PINGS_MAX_SIZE

See Also:

• Constant Field Values

SPAN_NAME_PREFIX

private static final String SPAN_NAME_PREFIX

See Also:

• Constant Field Values

COMMA_WHITESPACE_PATTERN

private static final Pattern COMMA_WHITESPACE_PATTERN

AB_TEST_SERVICE

static final AbTestService AB_TEST_SERVICE

CONTEXT_SIZE

protected static final int CONTEXT_SIZE

See Also:

• Constant Field Values

config

protected final HTTPServerConfig config

ENCODING

private static final String ENCODING

See Also:

• Constant Field Values

CACHE_STATS_PRINT

private static final int CACHE_STATS_PRINT

See Also:

• Constant Field Values

languageCheckCounts

private final Map<String,Integer> languageCheckCounts

workQueue

private final Queue<Runnable> workQueue

reqCounter

private final RequestCounter reqCounter

languageIdentifier

private final LanguageIdentifier languageIdentifier

executorService

private final ExecutorService executorService

cache

private final ResultCache cache

databaseLogger

private final DatabaseLogger databaseLogger

logServerId

private final Long logServerId

random

private final Random random

pings

private final Set<DatabasePingLogEntry> pings

pingsCleanDateMillis

private long pingsCleanDateMillis

pipelinePool

PipelinePool pipelinePool

onlyTestUsers

private static final List<String> onlyTestUsers

List of usernames for A/B testing with restricted rules. Populated from LT_TEST_ONLY_USERS environment variable. Format: comma-separated list of usernames

onlyTestRules

private static final List<String> onlyTestRules

List of rule IDs enabled for restricted rules A/B testing. Populated from LT_TEST_ONLY_RULES environment variable. Format: comma-separated list of rule IDs

onlyTestLanguages

private static final List<String> onlyTestLanguages

List of languages enabled for restricted rules A/B testing. Populated from LT_TEST_ONLY_LANGUAGES environment variable. Format: comma-separated list of language codes

onlyTestClients

private static final List<String> onlyTestClients

List of clients enabled for restricted rules A/B testing. Populated from LT_TEST_ONLY_CLIENTS environment variable. Format: comma-separated list of client identifiers

Constructor Details

TextChecker

TextChecker(HTTPServerConfig config,
 boolean internalServer,
 Queue<Runnable> workQueue,
 RequestCounter reqCounter)

Method Details

setHeaders

protected abstract void setHeaders(HttpExchange httpExchange)

getResponse

protected abstract String getResponse(AnnotatedText text,
 Language language,
 DetectedLanguage lang,
 Language motherTongue,
 List<CheckResults> matches,
 List<RuleMatch> hiddenMatches,
 String incompleteResultReason,
 int compactMode,
 boolean showPremiumHint,
 JLanguageTool.Mode mode)

getPreferredVariants

@NotNull
protected abstract List<String> getPreferredVariants(Map<String,String> parameters)

getLanguage

protected abstract DetectedLanguage getLanguage(String text,
 Map<String,String> parameters,
 List<String> preferredVariants,
 List<String> additionalDetectLangs,
 List<String> preferredLangs,
 boolean testMode)

getLanguageAutoDetect

protected abstract boolean getLanguageAutoDetect(Map<String,String> parameters)

getEnabledRuleIds

@NotNull
protected abstract List<String> getEnabledRuleIds(Map<String,String> parameters)

getDisabledRuleIds

@NotNull
protected abstract List<String> getDisabledRuleIds(Map<String,String> parameters)

parseLanguage

protected static Language parseLanguage(String code)
                                 throws BadRequestException

Throws:

BadRequestException

prewarmPipelinePool

private void prewarmPipelinePool()

shutdownNow

void shutdownNow()

isOptInThirdPartyAI

private boolean isOptInThirdPartyAI(UserLimits limits,
 Map<String,String> params,
 HTTPServerConfig config)

shouldRunRestrictedRulesTest

private boolean shouldRunRestrictedRulesTest(Map<String,String> params,
 String agent,
 Language lang,
 List<String> abTest)

checkText

void checkText(AnnotatedText aText,
 HttpExchange httpExchange,
 Map<String,String> params,
 ErrorRequestLimiter errorRequestLimiter,
 String remoteAddress)
        throws Exception

Throws:

Exception

checkerQueueAlmostFull

public boolean checkerQueueAlmostFull()

getRuleMatchCount

@NotNull
private Map<String,Integer> getRuleMatchCount(List<CheckResults> res)

getRuleValues

private Map<String,Object[]> getRuleValues(Map<String,String> parameters)

getUserDictWords

private List<String> getUserDictWords(UserLimits limits,
 List<String> groups)

getUserRules

private List<Rule> getUserRules(UserLimits limits,
 Language lang,
 List<String> groups)

checkParams

protected void checkParams(Map<String,String> parameters)

getRuleMatches

private List<CheckResults> getRuleMatches(AnnotatedText aText,
 Language lang,
 Language motherTongue,
 Map<String,String> parameters,
 TextChecker.QueryParams params,
 UserConfig userConfig,
 RuleMatchListener listener)
                                   throws Exception

Throws:

Exception

getLanguageVariantForCode

private Language getLanguageVariantForCode(String langCode,
 List<String> preferredVariants)

getPipelineResults

private List<CheckResults> getPipelineResults(AnnotatedText aText,
 Language lang,
 Language motherTongue,
 TextChecker.QueryParams params,
 UserConfig userConfig,
 RuleMatchListener listener)
                                       throws Exception

Throws:

Exception

getBuilderMap

@NotNull
private Map<Language,AnnotatedTextBuilder> getBuilderMap(List<FragmentWithLanguage> fragments,
 Set<Language> maybeUsedLangs)

getCategoryIds

@NotNull
private List<CategoryId> getCategoryIds(String paramName,
 Map<String,String> parameters)

getCommaSeparatedStrings

@NotNull
protected List<String> getCommaSeparatedStrings(String paramName,
 Map<String,String> parameters)

detectLanguageOfString

DetectedLanguage detectLanguageOfString(String text,
 String fallbackLanguage,
 List<String> preferredVariants,
 List<String> noopLangs,
 List<String> preferredLangs)

detectLanguageOfString

DetectedLanguage detectLanguageOfString(String text,
 String fallbackLanguage,
 List<String> preferredVariants,
 List<String> noopLangs,
 List<String> preferredLangs,
 boolean forcePreferredLanguages)