include builtin QueryFunctions in plugins response.

jan-niestadt · jan-niestadt · commit 81b050018821 · 2026-07-20T10:43:08.000+02:00
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/Plugin.java b/engine/src/main/java/nl/inl/blacklab/plugins/Plugin.java
@@ -37,7 +37,7 @@ public void configure(Map<String, Object> config, File pluginDir) {
         this.pluginDir = pluginDir;
     }
 
-    private PluginDescriptor descriptor = new PluginDescriptor();
+    private final PluginDescriptor descriptor = new PluginDescriptor();
 
     public PluginParam addParam(PluginParam spec) {
         return descriptor.addParam(spec);
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/PluginManager.java b/engine/src/main/java/nl/inl/blacklab/plugins/PluginManager.java
@@ -316,7 +316,7 @@ static synchronized <T extends Plugin> void getUnloaded(String scriptName) {
                     throw new PluginException("Groovy plugin overrides getId(): script file is " + unloaded.scriptFile +
                             ", getId() returns " + plugin.getId());
                 }
-                register(plugin, unloaded.pluginConfig, scriptName);
+                register(plugin, unloaded.pluginConfig, scriptName, true);
             } else {
                 logger.warn("Groovy script " + unloaded.scriptFile + " does not evaluate to a Plugin instance; ignoring.");
             }
@@ -325,11 +325,11 @@ static synchronized <T extends Plugin> void getUnloaded(String scriptName) {
         }
     }
 
-    private static void register(Plugin plugin, BLConfigPlugins pluginConfig, String scriptFileName) {
+    private static void register(Plugin plugin, BLConfigPlugins pluginConfig, String scriptFileName, boolean registerClassName) {
         ensureInitialized();
         for (Class<? extends Plugin> pluginClass: pluginTypes) {
             if (pluginClass.isInstance(plugin)) {
-                type(pluginClass).register(pluginClass.cast(plugin), pluginConfig, scriptFileName);
+                type(pluginClass).register(pluginClass.cast(plugin), pluginConfig, scriptFileName, registerClassName);
             }
         }
     }
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/PluginsOfType.java b/engine/src/main/java/nl/inl/blacklab/plugins/PluginsOfType.java
@@ -64,7 +64,7 @@ private void loadClasses(BLConfigPlugins pluginConfig, ClassLoader cl) {
                 plugin = it.next();
                 if (plugin.getId() == null)
                     plugin.setId(plugin.getClass().getSimpleName());
-                register(plugin, pluginConfig, null);
+                register(plugin, pluginConfig, null, true);
             } catch (ServiceConfigurationError e) {
                 logger.error("Plugin failed to load: " + e.getMessage(), e);
             } catch (Exception e) {
@@ -75,7 +75,7 @@ private void loadClasses(BLConfigPlugins pluginConfig, ClassLoader cl) {
         }
     }
 
-    void register(Plugin plugin, BLConfigPlugins configs, String alternateId) {
+    void register(Plugin plugin, BLConfigPlugins configs, String alternateId, boolean registerClassName) {
         String id = plugin.getId();
         if (id != null && !PLUGIN_ID_PATTERN.matcher(id).matches()) {
             logger.warn("Plugin id " + id + " (class " + plugin.getClass().getName() +
@@ -97,14 +97,19 @@ void register(Plugin plugin, BLConfigPlugins configs, String alternateId) {
             add(alternateId, data); // e.g. groovy script name without extension
         if (!plugin.localId().equals(id)) // localId is e.g. function name, so "abs" for QueryFunctionAbs
             add(plugin.localId(), data);
-        if (!plugin.getClass().isAnonymousClass()) {
+        if (registerClassName && !plugin.getClass().isAnonymousClass()) {
             if (!plugin.getClass().getName().contains("$")) // skip e.g. "Script1$1"
                 add(plugin.getClass().getName(), data);
             if (!plugin.getClass().getSimpleName().matches("\\d+")) // skip e.g. "1"
                 add(plugin.getClass().getSimpleName(), data);
         }
     }
 
+    public void add(String id, Plugin plugin) {
+        PluginData<T> data = new PluginData<>((T) plugin, null, null);
+        add(id, data);
+    }
+
     private void add(String id, PluginData<T> data) {
         if (BlackLab.isPluginAllowed(data.getPlugin())) {
             synchronized (this) {
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/QueryFunction.java b/engine/src/main/java/nl/inl/blacklab/plugins/QueryFunction.java
@@ -15,6 +15,7 @@
 import nl.inl.blacklab.plugins.param.PString;
 import nl.inl.blacklab.plugins.param.PluginParam;
 import nl.inl.blacklab.search.QueryExecutionContext;
+import nl.inl.blacklab.search.extensions.QueryFunctionLambda;
 import nl.inl.blacklab.search.indexmetadata.RelationUtil;
 import nl.inl.blacklab.search.lucene.SpanQueryAnyToken;
 import nl.inl.blacklab.search.lucene.SpanQueryDefaultValue;
@@ -30,7 +31,10 @@ public abstract class QueryFunction extends Plugin implements TextPattern.EvalRe
     /** Default value for a query parameter that means "any span" (<code><'.*' //></code>) */
     public static final String VALUE_ANY_SPAN = "_ANY_SPAN_";
 
-    /** Function name */
+    /** Function name
+     * <p>
+     * (this is the plugin's localId; id must be globally unique so cannot just be e.g. "abs"
+     *  or name collision would be likely) */
     private final String name;
 
     /** Parameter types */
@@ -59,6 +63,12 @@ public QueryFunction(String name, List<PluginParam> argTypes,
         this.relationsFunction = relationsFunction;
     }
 
+    @Override
+    public String getId() {
+        String id = super.getId();
+        return id == null ? (this instanceof QueryFunctionLambda ? name : getClass().getSimpleName()) : id;
+    }
+
     @Override
     public String localId() {
         return name;
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/param/PluginDescriptor.java b/engine/src/main/java/nl/inl/blacklab/plugins/param/PluginDescriptor.java
@@ -11,16 +11,6 @@
  */
 public final class PluginDescriptor {
 
-    public static final PluginDescriptor NO_PARAMETERS = new PluginDescriptor(Map.of());
-
-    public static PluginDescriptor of(PluginParam... params) {
-        Map<String, PluginParam> paramsMap = new HashMap<>();
-        for (PluginParam param: params) {
-            paramsMap.put(param.name(), param);
-        }
-        return new PluginDescriptor(paramsMap);
-    }
-
     private final Map<String, PluginParam> params;
 
     private boolean frozen;
diff --git a/engine/src/main/java/nl/inl/blacklab/search/extensions/QueryExtensions.java b/engine/src/main/java/nl/inl/blacklab/search/extensions/QueryExtensions.java
@@ -1,9 +1,7 @@
 package nl.inl.blacklab.search.extensions;
 
 import java.util.Collections;
-import java.util.HashMap;
 import java.util.List;
-import java.util.Map;
 
 import nl.inl.blacklab.plugins.PluginManager;
 import nl.inl.blacklab.plugins.QueryFunction;
@@ -17,9 +15,6 @@ public class QueryExtensions {
     private QueryExtensions() {
     }
 
-    /** Registry of extension functions by name */
-    private static final Map<String, QueryFunction> functions = new HashMap<>();
-
     static {
         register(XFDebug.class);      // Debug functions such as _ident(), _FI1(), _FI2()
         register(XFRelations.class);  // Functions for working with relations
@@ -62,7 +57,7 @@ private static void register(String name, List<PluginParam> argTypes, List<Objec
     }
 
     public static void register(QueryFunction func) {
-        functions.put(func.getName(), func);
+        PluginManager.type(QueryFunction.class).add(func.getName(), func);
     }
 
     public static void registerRelationsFunction(String name, List<PluginParam> argTypes, List<Object> defaultValues,
@@ -92,10 +87,7 @@ public static boolean exists(String name) {
     }
 
     private static QueryFunction getInternal(String name) {
-        QueryFunction queryFunction = functions.get(name);
-        return queryFunction == null ?
-                PluginManager.type(QueryFunction.class).getIfExists(name).orElse(null) :
-                queryFunction;
+        return PluginManager.type(QueryFunction.class).getIfExists(name).orElse(null);
     }
 
 }
diff --git a/test/data/saved-responses/info/Server info page.json b/test/data/saved-responses/info/Server info page.json
@@ -253,6 +253,74 @@
       {
         "id": "QueryFunctionUnion",
         "localId": "union"
+      },
+      {
+        "id": "_adjust",
+        "localId": "_adjust"
+      },
+      {
+        "id": "_edge",
+        "localId": "_edge"
+      },
+      {
+        "id": "_fimatch",
+        "localId": "_fimatch"
+      },
+      {
+        "id": "_FI1",
+        "localId": "_FI1"
+      },
+      {
+        "id": "_FI2",
+        "localId": "_FI2"
+      },
+      {
+        "id": "_ident",
+        "localId": "_ident"
+      },
+      {
+        "id": "_indoc",
+        "localId": "_indoc"
+      },
+      {
+        "id": "_lenfilter",
+        "localId": "_lenfilter"
+      },
+      {
+        "id": "_posfilter",
+        "localId": "_posfilter"
+      },
+      {
+        "id": "rel",
+        "localId": "rel"
+      },
+      {
+        "id": "rspan",
+        "localId": "rspan"
+      },
+      {
+        "id": "cspan",
+        "localId": "cspan"
+      },
+      {
+        "id": "rfield",
+        "localId": "rfield"
+      },
+      {
+        "id": "rcapture",
+        "localId": "rcapture"
+      },
+      {
+        "id": "punctBefore",
+        "localId": "punctBefore"
+      },
+      {
+        "id": "punctAfter",
+        "localId": "punctAfter"
+      },
+      {
+        "id": "with-spans",
+        "localId": "with-spans"
       }
     ],
     "QueryParserProvider": [
diff --git a/test/data/saved-responses/info/server.json b/test/data/saved-responses/info/server.json
@@ -253,6 +253,74 @@
       {
         "id": "QueryFunctionUnion",
         "localId": "union"
+      },
+      {
+        "id": "_adjust",
+        "localId": "_adjust"
+      },
+      {
+        "id": "_edge",
+        "localId": "_edge"
+      },
+      {
+        "id": "_fimatch",
+        "localId": "_fimatch"
+      },
+      {
+        "id": "_FI1",
+        "localId": "_FI1"
+      },
+      {
+        "id": "_FI2",
+        "localId": "_FI2"
+      },
+      {
+        "id": "_ident",
+        "localId": "_ident"
+      },
+      {
+        "id": "_indoc",
+        "localId": "_indoc"
+      },
+      {
+        "id": "_lenfilter",
+        "localId": "_lenfilter"
+      },
+      {
+        "id": "_posfilter",
+        "localId": "_posfilter"
+      },
+      {
+        "id": "rel",
+        "localId": "rel"
+      },
+      {
+        "id": "rspan",
+        "localId": "rspan"
+      },
+      {
+        "id": "cspan",
+        "localId": "cspan"
+      },
+      {
+        "id": "rfield",
+        "localId": "rfield"
+      },
+      {
+        "id": "rcapture",
+        "localId": "rcapture"
+      },
+      {
+        "id": "punctBefore",
+        "localId": "punctBefore"
+      },
+      {
+        "id": "punctAfter",
+        "localId": "punctAfter"
+      },
+      {
+        "id": "with-spans",
+        "localId": "with-spans"
       }
     ],
     "QueryParserProvider": [

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public void configure(Map<String, Object> config, File pluginDir) {`
`37`	`37`	`this.pluginDir = pluginDir;`
`38`	`38`	`}`
`39`	`39`
`40`		`- private PluginDescriptor descriptor = new PluginDescriptor();`
	`40`	`+ private final PluginDescriptor descriptor = new PluginDescriptor();`
`41`	`41`
`42`	`42`	`public PluginParam addParam(PluginParam spec) {`
`43`	`43`	`return descriptor.addParam(spec);`
Original file line number	Diff line number	Diff line change
`@@ -316,7 +316,7 @@ static synchronized <T extends Plugin> void getUnloaded(String scriptName) {`
`316`	`316`	`throw new PluginException("Groovy plugin overrides getId(): script file is " + unloaded.scriptFile +`
`317`	`317`	`", getId() returns " + plugin.getId());`
`318`	`318`	`}`
`319`		`- register(plugin, unloaded.pluginConfig, scriptName);`
	`319`	`+ register(plugin, unloaded.pluginConfig, scriptName, true);`
`320`	`320`	`} else {`
`321`	`321`	`logger.warn("Groovy script " + unloaded.scriptFile + " does not evaluate to a Plugin instance; ignoring.");`
`322`	`322`	`}`
`@@ -325,11 +325,11 @@ static synchronized <T extends Plugin> void getUnloaded(String scriptName) {`
`325`	`325`	`}`
`326`	`326`	`}`
`327`	`327`
`328`		`- private static void register(Plugin plugin, BLConfigPlugins pluginConfig, String scriptFileName) {`
	`328`	`+ private static void register(Plugin plugin, BLConfigPlugins pluginConfig, String scriptFileName, boolean registerClassName) {`
`329`	`329`	`ensureInitialized();`
`330`	`330`	`for (Class<? extends Plugin> pluginClass: pluginTypes) {`
`331`	`331`	`if (pluginClass.isInstance(plugin)) {`
`332`		`- type(pluginClass).register(pluginClass.cast(plugin), pluginConfig, scriptFileName);`
	`332`	`+ type(pluginClass).register(pluginClass.cast(plugin), pluginConfig, scriptFileName, registerClassName);`
`333`	`333`	`}`
`334`	`334`	`}`
`335`	`335`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,7 @@`
`1`	`1`	`package nl.inl.blacklab.search.extensions;`
`2`	`2`
`3`	`3`	`import java.util.Collections;`
`4`		`-import java.util.HashMap;`
`5`	`4`	`import java.util.List;`
`6`		`-import java.util.Map;`
`7`	`5`
`8`	`6`	`import nl.inl.blacklab.plugins.PluginManager;`
`9`	`7`	`import nl.inl.blacklab.plugins.QueryFunction;`
`@@ -17,9 +15,6 @@ public class QueryExtensions {`
`17`	`15`	`private QueryExtensions() {`
`18`	`16`	`}`
`19`	`17`
`20`		`- /** Registry of extension functions by name */`
`21`		`- private static final Map<String, QueryFunction> functions = new HashMap<>();`
`22`		`-`
`23`	`18`	`static {`
`24`	`19`	`register(XFDebug.class); // Debug functions such as _ident(), _FI1(), _FI2()`
`25`	`20`	`register(XFRelations.class); // Functions for working with relations`
`@@ -62,7 +57,7 @@ private static void register(String name, List<PluginParam> argTypes, List<Objec`
`62`	`57`	`}`
`63`	`58`
`64`	`59`	`public static void register(QueryFunction func) {`
`65`		`- functions.put(func.getName(), func);`
	`60`	`+ PluginManager.type(QueryFunction.class).add(func.getName(), func);`
`66`	`61`	`}`
`67`	`62`
`68`	`63`	`public static void registerRelationsFunction(String name, List<PluginParam> argTypes, List<Object> defaultValues,`
`@@ -92,10 +87,7 @@ public static boolean exists(String name) {`
`92`	`87`	`}`
`93`	`88`
`94`	`89`	`private static QueryFunction getInternal(String name) {`
`95`		`- QueryFunction queryFunction = functions.get(name);`
`96`		`- return queryFunction == null ?`
`97`		`- PluginManager.type(QueryFunction.class).getIfExists(name).orElse(null) :`
`98`		`- queryFunction;`
	`90`	`+ return PluginManager.type(QueryFunction.class).getIfExists(name).orElse(null);`
`99`	`91`	`}`
`100`	`92`
`101`	`93`	`}`