Plugin.localId(). Skip some plugin types in BLS response.

jan-niestadt · jan-niestadt · commit 2f646254fa52 · 2026-07-20T10:43:08.000+02:00
diff --git a/engine/pom.xml b/engine/pom.xml
@@ -184,12 +184,12 @@
         <dependency>
             <groupId>org.apache.groovy</groupId>
             <artifactId>groovy</artifactId>
-            <version>4.0.15</version>
+            <version>4.0.32</version>
         </dependency>
         <dependency>
             <groupId>org.apache.groovy</groupId>
             <artifactId>groovy-jsr223</artifactId>
-            <version>4.0.15</version>
+            <version>4.0.32</version>
         </dependency>
 
     </dependencies>
diff --git a/engine/src/main/java/nl/inl/blacklab/index/IndexSourceTypeFile.java b/engine/src/main/java/nl/inl/blacklab/index/IndexSourceTypeFile.java
@@ -12,7 +12,7 @@
 public class IndexSourceTypeFile extends IndexSourceType {
 
     @Override
-    public String getId() {
+    public String localId() {
         return "file";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/index/IndexSourceTypeFileInArchive.java b/engine/src/main/java/nl/inl/blacklab/index/IndexSourceTypeFileInArchive.java
@@ -12,7 +12,7 @@
 public class IndexSourceTypeFileInArchive extends IndexSourceType {
 
     @Override
-    public String getId() {
+    public String localId() {
         return "archive";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/index/IndexSourceTypeTest.java b/engine/src/main/java/nl/inl/blacklab/index/IndexSourceTypeTest.java
@@ -17,7 +17,7 @@
 public class IndexSourceTypeTest extends IndexSourceType {
 
     @Override
-    public String getId() {
+    public String localId() {
         return "test";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionAppend.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionAppend.java
@@ -31,7 +31,7 @@ public class ProcessingInstructionAppend extends ProcessingInstruction {
     private PluginParam parValue;
 
     @Override
-    public synchronized String getId() {
+    public synchronized String localId() {
         return "append";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionConcatDate.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionConcatDate.java
@@ -34,7 +34,7 @@ public class ProcessingInstructionConcatDate extends ProcessingInstruction {
     private PluginParam parAutofill;
 
     @Override
-    public synchronized String getId() {
+    public synchronized String localId() {
         return "concatDate";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionIdentity.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionIdentity.java
@@ -13,7 +13,7 @@
 public class ProcessingInstructionIdentity extends ProcessingInstruction {
 
     @Override
-    public synchronized String getId() {
+    public synchronized String localId() {
         return "identity";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionIfEmpty.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionIfEmpty.java
@@ -29,7 +29,7 @@ public class ProcessingInstructionIfEmpty extends ProcessingInstruction {
     private PluginParam parSeparator;
 
     @Override
-    public synchronized String getId() {
+    public synchronized String localId() {
         return "ifEmpty"; // "default" as well (old name)
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionMapValues.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionMapValues.java
@@ -18,7 +18,7 @@ public class ProcessingInstructionMapValues extends ProcessingInstruction {
     private PluginParam parTable;
 
     @Override
-    public synchronized String getId() {
+    public synchronized String localId() {
         return "map";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionMultiple.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionMultiple.java
@@ -15,7 +15,7 @@
 public class ProcessingInstructionMultiple extends ProcessingInstruction {
 
     @Override
-    public synchronized String getId() {
+    public synchronized String localId() {
         return "stmt-block"; // (not actually used in config files)
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionParsePos.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionParsePos.java
@@ -20,7 +20,7 @@ public class ProcessingInstructionParsePos extends ProcessingInstruction {
     private PluginParam parField;
 
     @Override
-    public synchronized String getId() {
+    public synchronized String localId() {
         return "parsePos";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionReplace.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionReplace.java
@@ -27,7 +27,7 @@ public class ProcessingInstructionReplace extends ProcessingInstruction {
     private PluginParam parKeep;
 
     @Override
-    public synchronized String getId() {
+    public synchronized String localId() {
         return "replace";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionSort.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionSort.java
@@ -14,7 +14,7 @@
 public class ProcessingInstructionSort extends ProcessingInstruction {
 
     @Override
-    public synchronized String getId() {
+    public synchronized String localId() {
         return "sort";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionSplit.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionSplit.java
@@ -24,7 +24,7 @@ public class ProcessingInstructionSplit extends ProcessingInstruction {
     private PluginParam parKeep;
 
     @Override
-    public synchronized String getId() {
+    public synchronized String localId() {
         return "split";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionStrip.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionStrip.java
@@ -19,7 +19,7 @@ public class ProcessingInstructionStrip extends ProcessingInstruction {
     private PluginParam parChars;
 
     @Override
-    public synchronized String getId() {
+    public synchronized String localId() {
         return "strip";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionUnique.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionUnique.java
@@ -13,7 +13,7 @@
 public class ProcessingInstructionUnique extends ProcessingInstruction {
 
     @Override
-    public synchronized String getId() {
+    public synchronized String localId() {
         return "unique";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/HitGroupScorerType.java b/engine/src/main/java/nl/inl/blacklab/plugins/HitGroupScorerType.java
@@ -56,7 +56,7 @@ public enum Type {
      * @return collocate scorer
      */
     public HitGroupScorer getCollocationScorer(AnnotationSensitivity collocateAnnotation, Query filter, long totalFrequency, long wordFrequency) {
-        throw new PluginException("HitGroupScorerType " + getId() + " does not support collocation scoring");
+        throw new PluginException("HitGroupScorerType " + localId() + " does not support collocation scoring");
     }
 
 }
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/Plugin.java b/engine/src/main/java/nl/inl/blacklab/plugins/Plugin.java
@@ -78,6 +78,27 @@ public String getId() {
         return id;
     }
 
+    /**
+     * Local (short) id for this plugin.
+     *
+     * E.g. local id for QueryFunctionConcat would be "concat".
+     * This is the id we can use to refer to the plugin if we
+     * know the type of plugin, for example in a BCQL query.
+     * If we ask for a QueryFunction "concat", we can resolve
+     * this correctly and not accidentally return a
+     * ProcessingInstruction "concat".
+     *
+     * By default, returns the id, but the plugin type base class
+     * (e.g. QueryFunction) should do something more intelligent, e.g.
+     * try to derive a short id from the id. Plugin implementations can
+     * always override the method to ensure the correct local id.
+     *
+     * @return the local (short) id for this plugin
+     */
+    public String localId() {
+        return getId();
+    }
+
     /**
      * Set the short ID of this plugin. Can only be set once.
      *
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/PluginManager.java b/engine/src/main/java/nl/inl/blacklab/plugins/PluginManager.java
@@ -286,23 +286,23 @@ private static synchronized void findGroovyScripts(BLConfigPlugins pluginConfig)
      */
     static void loadAllGroovyScripts() {
         ensureInitialized();
-        ArrayList<String> ids = new ArrayList<>(unloadedGroovyScripts.keySet());
-        for (String id: ids) {
-            getUnloaded(id);
+        ArrayList<String> scriptNames = new ArrayList<>(unloadedGroovyScripts.keySet());
+        for (String scriptName: scriptNames) {
+            getUnloaded(scriptName);
         }
     }
 
     /**
      * See if there's a groovy script with this name we can load.
      *
-     * @param id  plugin id (groovy script name)
+     * @param scriptName  groovy script name
      * @param <T> plugin type
      */
-    static synchronized <T extends Plugin> void getUnloaded(String id) {
+    static synchronized <T extends Plugin> void getUnloaded(String scriptName) {
         ensureInitialized();
         UnloadedGroovyPlugin unloaded;
         synchronized (unloadedGroovyScripts) {
-            unloaded = unloadedGroovyScripts.remove(id);
+            unloaded = unloadedGroovyScripts.remove(scriptName);
         }
         if (unloaded == null)
             return;
@@ -311,12 +311,12 @@ static synchronized <T extends Plugin> void getUnloaded(String id) {
             Object result = shell.evaluate(FileUtils.readFileToString(unloaded.scriptFile, StandardCharsets.UTF_8));
             if (result instanceof Plugin plugin) {
                 if (plugin.getId() == null) {
-                    plugin.setId(id);
-                } else if (!plugin.getId().equals(id)) {
+                    plugin.setId(scriptName);
+                } else if (!plugin.getId().equals(scriptName)) {
                     throw new PluginException("Groovy plugin overrides getId(): script file is " + unloaded.scriptFile +
                             ", getId() returns " + plugin.getId());
                 }
-                register(plugin, unloaded.pluginConfig, id);
+                register(plugin, unloaded.pluginConfig, scriptName);
             } else {
                 logger.warn("Groovy script " + unloaded.scriptFile + " does not evaluate to a Plugin instance; ignoring.");
             }
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,6 @@ private void loadClasses(BLConfigPlugins pluginConfig, ClassLoader cl) {
                 plugin = it.next();
                 if (plugin.getId() == null)
                     plugin.setId(plugin.getClass().getSimpleName());
-                //logger.info("Loading plugin {}", plugin);
                 register(plugin, pluginConfig, null);
             } catch (ServiceConfigurationError e) {
                 logger.error("Plugin failed to load: " + e.getMessage(), e);
@@ -96,6 +95,8 @@ void register(Plugin plugin, BLConfigPlugins configs, String alternateId) {
             add(id, data);
         if (!StringUtils.isEmpty(alternateId) && !alternateId.equals(id))
             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 (!plugin.getClass().getName().contains("$")) // skip e.g. "Script1$1"
                 add(plugin.getClass().getName(), data);
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/ProcessingInstruction.java b/engine/src/main/java/nl/inl/blacklab/plugins/ProcessingInstruction.java
@@ -48,4 +48,9 @@ public static ProcessingStep fromConfig(ConfigProcessStep configProcessStep) {
 
     public abstract ProcessingStep get(PluginParams param);
 
+    @Override
+    public String localId() {
+        return super.localId().replaceAll("^ProcessingInstruction", "").toLowerCase();
+    }
+
 }
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/QueryFunction.java b/engine/src/main/java/nl/inl/blacklab/plugins/QueryFunction.java
@@ -60,7 +60,7 @@ public QueryFunction(String name, List<PluginParam> argTypes,
     }
 
     @Override
-    public String getId() {
+    public String localId() {
         return name;
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/search/results/hitresults/HitGroupScorerDice.java b/engine/src/main/java/nl/inl/blacklab/search/results/hitresults/HitGroupScorerDice.java
@@ -11,7 +11,7 @@ public class HitGroupScorerDice extends HitGroupScorerType {
     public static final String TYPE_ID = "coll-dice";
 
     @Override
-    public String getId() {
+    public String localId() {
         return TYPE_ID;
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/search/results/hitresults/HitGroupScorerSalience.java b/engine/src/main/java/nl/inl/blacklab/search/results/hitresults/HitGroupScorerSalience.java
@@ -11,7 +11,7 @@ public class HitGroupScorerSalience extends HitGroupScorerType {
     public static final String TYPE_ID = "coll-salience";
 
     @Override
-    public String getId() {
+    public String localId() {
         return TYPE_ID;
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/search/results/hitresults/HitGroupScorerSize.java b/engine/src/main/java/nl/inl/blacklab/search/results/hitresults/HitGroupScorerSize.java
@@ -12,7 +12,7 @@ public class HitGroupScorerSize extends HitGroupScorerType {
     public static final String TYPE_ID = "coll-groupsize";
 
     @Override
-    public String getId() {
+    public String localId() {
         return TYPE_ID;
     }
 
diff --git a/query-parser/src/main/java/nl/inl/blacklab/queryParser/JsonParserProvider.java b/query-parser/src/main/java/nl/inl/blacklab/queryParser/JsonParserProvider.java
@@ -14,7 +14,7 @@
 public class JsonParserProvider extends QueryParserProvider {
 
     @Override
-    public String getId() {
+    public String localId() {
         return "json-bql";
     }
 
diff --git a/query-parser/src/main/java/nl/inl/blacklab/queryParser/contextql/ContextQLParserProvider.java b/query-parser/src/main/java/nl/inl/blacklab/queryParser/contextql/ContextQLParserProvider.java
@@ -8,7 +8,7 @@
 public class ContextQLParserProvider extends QueryParserProvider {
 
     @Override
-    public String getId() {
+    public String localId() {
         return "contextql";
     }
 
diff --git a/query-parser/src/main/java/nl/inl/blacklab/queryParser/corpusql/BcqlParserProvider.java b/query-parser/src/main/java/nl/inl/blacklab/queryParser/corpusql/BcqlParserProvider.java
@@ -9,7 +9,7 @@
 public class BcqlParserProvider extends QueryParserProvider {
 
     @Override
-    public String getId() {
+    public String localId() {
         return "corpusql";
     }
 
diff --git a/site/docs/server/030_rest-api/005_information/010_server-info.md b/site/docs/server/030_rest-api/005_information/010_server-info.md
@@ -85,3 +85,4 @@ The major differences between API `v4` and `v5` are:
 
 - API `v4` includes both `corpora` and `indices`. API `v5` only has `corpora`, which doesn't include custom properties like `displayName` and `description` unless you specify `custom=true`.
 - API `v5` has a `count` object with `tokens` and `documents`, while API `v4` has `tokenCount` and no document count.
+- API `v5` includes `plugins` information as well. For the format, see [here](plugins). 
diff --git a/site/docs/server/030_rest-api/005_information/020_corpus-info.md b/site/docs/server/030_rest-api/005_information/020_corpus-info.md
@@ -285,3 +285,4 @@ The major differences between API `v4` and `v5` are:
 ### Notes
 
 - `versionInfo` gives information about when the corpus was created/updated, as well as what version of BlackLab it was created with.
+- Now includes relations info as well. For the format, see [here](relations).
diff --git a/site/docs/server/030_rest-api/005_information/080_plugins.md b/site/docs/server/030_rest-api/005_information/080_plugins.md
diff --git a/test/data/saved-responses/info/Server info page.json b/test/data/saved-responses/info/Server info page.json
diff --git a/test/data/saved-responses/info/server.json b/test/data/saved-responses/info/server.json
diff --git a/wslib/src/main/java/nl/inl/blacklab/server/lib/results/ResponseStreamer.java b/wslib/src/main/java/nl/inl/blacklab/server/lib/results/ResponseStreamer.java
diff --git a/wslib/src/main/java/nl/inl/blacklab/server/lib/results/ResultListPlugins.java b/wslib/src/main/java/nl/inl/blacklab/server/lib/results/ResultListPlugins.java

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`public class IndexSourceTypeFile extends IndexSourceType {`
`13`	`13`
`14`	`14`	`@Override`
`15`		`- public String getId() {`
	`15`	`+ public String localId() {`
`16`	`16`	`return "file";`
`17`	`17`	`}`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`public class IndexSourceTypeTest extends IndexSourceType {`
`18`	`18`
`19`	`19`	`@Override`
`20`		`- public String getId() {`
	`20`	`+ public String localId() {`
`21`	`21`	`return "test";`
`22`	`22`	`}`
`23`	`23`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public class ProcessingInstructionAppend extends ProcessingInstruction {`
`31`	`31`	`private PluginParam parValue;`
`32`	`32`
`33`	`33`	`@Override`
`34`		`- public synchronized String getId() {`
	`34`	`+ public synchronized String localId() {`
`35`	`35`	`return "append";`
`36`	`36`	`}`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public class ProcessingInstructionConcatDate extends ProcessingInstruction {`
`34`	`34`	`private PluginParam parAutofill;`
`35`	`35`
`36`	`36`	`@Override`
`37`		`- public synchronized String getId() {`
	`37`	`+ public synchronized String localId() {`
`38`	`38`	`return "concatDate";`
`39`	`39`	`}`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`public class ProcessingInstructionIdentity extends ProcessingInstruction {`
`14`	`14`
`15`	`15`	`@Override`
`16`		`- public synchronized String getId() {`
	`16`	`+ public synchronized String localId() {`
`17`	`17`	`return "identity";`
`18`	`18`	`}`
`19`	`19`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public class ProcessingInstructionIfEmpty extends ProcessingInstruction {`
`29`	`29`	`private PluginParam parSeparator;`
`30`	`30`
`31`	`31`	`@Override`
`32`		`- public synchronized String getId() {`
	`32`	`+ public synchronized String localId() {`
`33`	`33`	`return "ifEmpty"; // "default" as well (old name)`
`34`	`34`	`}`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public class ProcessingInstructionMapValues extends ProcessingInstruction {`
`18`	`18`	`private PluginParam parTable;`
`19`	`19`
`20`	`20`	`@Override`
`21`		`- public synchronized String getId() {`
	`21`	`+ public synchronized String localId() {`
`22`	`22`	`return "map";`
`23`	`23`	`}`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`public class ProcessingInstructionMultiple extends ProcessingInstruction {`
`16`	`16`
`17`	`17`	`@Override`
`18`		`- public synchronized String getId() {`
	`18`	`+ public synchronized String localId() {`
`19`	`19`	`return "stmt-block"; // (not actually used in config files)`
`20`	`20`	`}`
`21`	`21`