mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-04-05 06:48:45 +00:00
5481fbc249
* Handle missing values in painless Throw an exception for `doc['field'].value` if this document is missing a value for the `field`. For 7.0: This is the default behaviour from 7.0 For 6.x: To enable this behavior from 6.x, a user can set a jvm.option: `-Des.script.exception_for_missing_value=true` on a node. If a user does not enable this behavior, a deprecation warning is logged on start up. Closes #29286
116 lines
4.8 KiB
Java
116 lines
4.8 KiB
Java
/*
|
|
* Licensed to Elasticsearch under one or more contributor
|
|
* license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright
|
|
* ownership. Elasticsearch licenses this file to you under
|
|
* the Apache License, Version 2.0 (the "License"); you may
|
|
* not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
* KIND, either express or implied. See the License for the
|
|
* specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
|
|
package org.elasticsearch.script;
|
|
|
|
import java.util.Collections;
|
|
import java.util.HashMap;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
import java.util.function.Function;
|
|
import java.util.stream.Collectors;
|
|
import java.util.stream.Stream;
|
|
|
|
import org.elasticsearch.common.settings.ClusterSettings;
|
|
import org.elasticsearch.common.settings.Settings;
|
|
import org.elasticsearch.plugins.ScriptPlugin;
|
|
import org.elasticsearch.search.aggregations.pipeline.movfn.MovingFunctionScript;
|
|
import org.elasticsearch.common.Booleans;
|
|
import org.elasticsearch.common.logging.DeprecationLogger;
|
|
import org.elasticsearch.common.logging.Loggers;
|
|
|
|
/**
|
|
* Manages building {@link ScriptService}.
|
|
*/
|
|
public class ScriptModule {
|
|
|
|
public static final Map<String, ScriptContext<?>> CORE_CONTEXTS;
|
|
static {
|
|
CORE_CONTEXTS = Stream.of(
|
|
SearchScript.CONTEXT,
|
|
SearchScript.AGGS_CONTEXT,
|
|
ScoreScript.CONTEXT,
|
|
SearchScript.SCRIPT_SORT_CONTEXT,
|
|
SearchScript.TERMS_SET_QUERY_CONTEXT,
|
|
ExecutableScript.CONTEXT,
|
|
ExecutableScript.AGGS_CONTEXT,
|
|
ExecutableScript.UPDATE_CONTEXT,
|
|
ExecutableScript.INGEST_CONTEXT,
|
|
FilterScript.CONTEXT,
|
|
SimilarityScript.CONTEXT,
|
|
SimilarityWeightScript.CONTEXT,
|
|
TemplateScript.CONTEXT,
|
|
MovingFunctionScript.CONTEXT,
|
|
ScriptedMetricAggContexts.InitScript.CONTEXT,
|
|
ScriptedMetricAggContexts.MapScript.CONTEXT,
|
|
ScriptedMetricAggContexts.CombineScript.CONTEXT,
|
|
ScriptedMetricAggContexts.ReduceScript.CONTEXT
|
|
).collect(Collectors.toMap(c -> c.name, Function.identity()));
|
|
}
|
|
|
|
public static final boolean EXCEPTION_FOR_MISSING_VALUE =
|
|
Booleans.parseBoolean(System.getProperty("es.scripting.exception_for_missing_value", "false"));
|
|
|
|
private static final DeprecationLogger DEPRECATION_LOGGER = new DeprecationLogger(Loggers.getLogger(ScriptModule.class));
|
|
|
|
private final ScriptService scriptService;
|
|
|
|
public ScriptModule(Settings settings, List<ScriptPlugin> scriptPlugins) {
|
|
Map<String, ScriptEngine> engines = new HashMap<>();
|
|
Map<String, ScriptContext<?>> contexts = new HashMap<>(CORE_CONTEXTS);
|
|
for (ScriptPlugin plugin : scriptPlugins) {
|
|
for (ScriptContext context : plugin.getContexts()) {
|
|
ScriptContext oldContext = contexts.put(context.name, context);
|
|
if (oldContext != null) {
|
|
throw new IllegalArgumentException("Context name [" + context.name + "] defined twice");
|
|
}
|
|
}
|
|
}
|
|
for (ScriptPlugin plugin : scriptPlugins) {
|
|
ScriptEngine engine = plugin.getScriptEngine(settings, contexts.values());
|
|
if (engine != null) {
|
|
ScriptEngine existing = engines.put(engine.getType(), engine);
|
|
if (existing != null) {
|
|
throw new IllegalArgumentException("scripting language [" + engine.getType() + "] defined for engine [" +
|
|
existing.getClass().getName() + "] and [" + engine.getClass().getName());
|
|
}
|
|
}
|
|
}
|
|
if (EXCEPTION_FOR_MISSING_VALUE == false)
|
|
DEPRECATION_LOGGER.deprecated("Script: returning default values for missing document values is deprecated. " +
|
|
"Set system property '-Des.scripting.exception_for_missing_value=true' " +
|
|
"to make behaviour compatible with future major versions.");
|
|
scriptService = new ScriptService(settings, Collections.unmodifiableMap(engines), Collections.unmodifiableMap(contexts));
|
|
}
|
|
|
|
/**
|
|
* Service responsible for managing scripts.
|
|
*/
|
|
public ScriptService getScriptService() {
|
|
return scriptService;
|
|
}
|
|
|
|
/**
|
|
* Allow the script service to register any settings update handlers on the cluster settings
|
|
*/
|
|
public void registerClusterSettingsListeners(ClusterSettings clusterSettings) {
|
|
scriptService.registerClusterSettingsListeners(clusterSettings);
|
|
}
|
|
}
|