Remove separate /plugins endpoint. Fixes.

Author: jan-niestadt

common/src/main/java/nl/inl/blacklab/webservice/WebserviceOperation.java

@@ -41,8 +41,6 @@ public enum WebserviceOperation {
     WRITE_INPUT_FORMAT("write-input-format", HttpMethod.POST, BlsPath.INPUT_FORMATS),
     DELETE_INPUT_FORMAT("delete-input-format", HttpMethod.DELETE, BlsPath.INPUT_FORMATS),
 
-    LIST_PLUGINS("list-plugins", BlsPath.PLUGINS),
-
     ADD_TO_CORPUS("add-to-corpus", HttpMethod.POST, BlsPath.EMPTY),
     DELETE_DOCUMENT("delete-document", HttpMethod.DELETE, BlsPath.DOCS),
 

engine/src/main/java/nl/inl/blacklab/plugins/PluginManager.java

@@ -169,7 +169,6 @@ record UnloadedGroovyPlugin(File scriptFile, BLConfigPlugins pluginConfig) {}
                 QueryFunctionSymbol.class,
                 QueryFunctionUnion.class
         ));
-        QueryExtensions.registerAll(); // register e.g. rspan(), debug functions, etc.
     }
 
     public static synchronized void addWebSafePlugins(List<Class<? extends Plugin>> pluginClasses) {
@@ -195,8 +194,8 @@ public static File getPluginsDir() {
     }
 
     public static synchronized void addPluginType(Class<? extends Plugin> pluginType) {
-        pluginTypes.add(pluginType);
         URLClassLoader cl = getPluginsDirClassLoader(PluginManager.class.getClassLoader());
+        pluginTypes.add(pluginType);
         pluginsByType.put(pluginType, new PluginsOfType<>(pluginType, BlackLab.config().getPlugins(), cl));
     }
 
@@ -225,6 +224,8 @@ public static synchronized void ensureInitialized() {
             pluginsByType.put(pluginClass, new PluginsOfType<>(pluginClass, pluginConfig, cl));
         }
 
+        QueryExtensions.registerAll(); // register e.g. rspan(), debug functions, etc.
+
         findGroovyScripts(pluginConfig);
 
         // Some plugins take a LONG time to init, if we block, we block the loading of the config
@@ -244,6 +245,7 @@ public static synchronized void ensureInitialized() {
     }
 
     private static URLClassLoader getPluginsDirClassLoader(ClassLoader parent) {
+        ensureInitialized();
         List<URL> urlList = new ArrayList<>();
         FilenameFilter filenameFilter = (dir, name) -> name.toLowerCase().endsWith(".jar");
         File[] files = pluginsDir.listFiles(filenameFilter);

engine/src/main/java/nl/inl/blacklab/search/extensions/XFRelations.java

@@ -29,7 +29,6 @@
 import nl.inl.blacklab.search.lucene.SpansAndFilterFactoryUniqueRelations;
 import nl.inl.blacklab.search.matchfilter.ConstraintValue;
 import nl.inl.blacklab.search.results.QueryInfo;
-import nl.inl.blacklab.search.textpattern.TextPattern;
 import nl.inl.blacklab.search.textpattern.TextPatternRelationMatch;
 
 /**
@@ -122,22 +121,21 @@ public void register() {
                 });
 
         // rmatch: Perform an AND operation with the additional requirement that clauses match unique relations.
-        QueryExtensions.register(new QueryFunction("rmatch", List.of(
-                PList.optional("queries", PList.Validator.ALL_QUERIES)),
-                List.of(QueryFunction.VALUE_QUERY_ANY_NGRAM), false) {
-            @Override
-            protected TextPattern.EvalResult applyFunc(QueryExecutionContext context, List<Object> parameters) {
-                if (parameters.isEmpty())
-                    throw new IllegalArgumentException("rmatch() requires one or more queries as arguments");
-                List<BLSpanQuery> tps = ((List<?>)parameters.get(0)).stream().map(o -> {
-                    if (o instanceof BLSpanQuery p)
-                        return p;
-                    throw new InvalidQuery("Non-query parameter to rmatch(): " + o);
-                }).toList();
-                return TextPatternRelationMatch.createRelMatchQuery(context, tps);
+        QueryExtensions.register(
+            "rmatch",
+            List.of(PList.optional("queries", PList.Validator.ALL_QUERIES)),
+            List.of(QueryFunction.VALUE_QUERY_ANY_NGRAM),
+            (QueryInfo queryInfo, QueryExecutionContext context, List<Object> parameters) -> {
+                    if (parameters.isEmpty())
+                        throw new IllegalArgumentException("rmatch() requires one or more queries as arguments");
+                    List<BLSpanQuery> tps = ((List<?>)parameters.get(0)).stream().map(o -> {
+                        if (o instanceof BLSpanQuery p)
+                            return p;
+                        throw new InvalidQuery("Non-query parameter to rmatch(): " + o);
+                    }).toList();
+                    return TextPatternRelationMatch.createRelMatchQuery(context, tps);
             }
-
-        });
+        );
 
         /*
          * rspan: change span mode of a query with an active relation.

server/src/main/java/nl/inl/blacklab/server/BlackLabServer.java

@@ -143,8 +143,8 @@ protected void doOptions(HttpServletRequest request, HttpServletResponse respons
     }
 
     private String optAddAllowOriginHeader(HttpServletResponse responseObject) {
-        String allowOrigin = BlsMain.get() == null ? "*" :
-                BlsMain.get().getSearchManager().config().getProtocol().getAccessControlAllowOrigin();
+        String allowOrigin = BlsMain.getInstance() == null ? "*" :
+                BlsMain.getInstance().getSearchManager().config().getProtocol().getAccessControlAllowOrigin();
         if (allowOrigin != null)
             responseObject.addHeader("Access-Control-Allow-Origin", allowOrigin);
         return allowOrigin;

server/src/main/java/nl/inl/blacklab/server/requesthandlers/RequestHandler.java

@@ -279,11 +279,6 @@ public static RequestHandler create(UserRequestBls userRequest, DataFormat outpu
                     requestHandler = new RequestHandlerCacheInfo(userRequest);
                 } else if (isInputFormatsRequest) {
                     requestHandler = new RequestHandlerListInputFormats(userRequest);
-                } else if (!isNewCorporaEndpoint && indexName.equals(ENDPOINT_PLUGINS)) {
-                    if (resourceOrPathGiven) {
-                        return errorObj.unknownOperation(indexName);
-                    }
-                    requestHandler = new RequestHandlerListPlugins(userRequest);
                 } else if (!isNewCorporaEndpoint && indexName.equals(ENDPOINT_SHARED_WITH_ME)) {
                     if (!user.isLoggedIn())
                         return errorObj.unauthorized("You are not logged in. Log in to see corpora shared with you.");

server/src/main/java/nl/inl/blacklab/server/requesthandlers/RequestHandlerListPlugins.java

@@ -1,6 +1,6 @@
 # Server information
 
-List available corpora and general information about the server environment, such as BlackLab version and whether a user is logged-in.
+List available corpora and general information about the server environment, such as BlackLab version, available corpora and plugins and whether a user is logged-in.
 
 **URL**
 - `/blacklab-server/`
@@ -52,6 +52,8 @@ A server with one corpus named *BaB* and no logged-in user might show this resul
 
 === API `v5`
 
+(some parts of the response are omitted for brevity)
+
 ```jsonc
 {
   "apiVersion": "5.0",
@@ -73,6 +75,61 @@ A server with one corpus named *BaB* and no logged-in user might show this resul
     "loggedIn": false,
     "canCreateIndex": false,
     "debugMode": false
+  },
+  "plugins": {
+    "FileConverter": {
+    },
+    "DocTaskType": {
+    },
+    "HitGroupScorerType": {
+      "coll-dice": {
+        "params": []
+      },
+      "coll-groupsize": {
+        "params": []
+      },
+      "coll-salience": {
+        "params": []
+      }
+    },
+    "IndexSourceType": {
+    },
+    "ProcessingInstruction": [
+      // ...
+    ],
+    "QueryFunction": [
+      "gap": {
+        "params": [
+          {
+            "name": "first",
+            "type": "matchInfo",
+            "required": true
+          },
+          {
+            "name": "second",
+            "type": "matchInfo",
+            "required": true
+          },
+          {
+            "name": "directional",
+            "type": "boolean",
+            "required": false
+          }
+        ]
+      },
+      // ...
+    ],
+    "QueryParserProvider": [
+      "corpusql": {
+        "params": []
+      },
+      "contextql": {
+        "params": []
+      },
+      "json-bql": {
+        "params": []
+      }
+    ]
   }
 }
 ```
@@ -85,4 +142,3 @@ 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). 

site/docs/server/030_rest-api/005_information/010_server-info.md

@@ -8,4 +8,3 @@ Endpoints that provide information about the server and corpora.
 * [Field information](field-info) : `GET /blacklab-server/<corpus-name>/fields/<fieldname>`<br>Information about a (metadata or annotated) field in the corpus, such as a list of values. Also includes spans/relations.
 * [Span and relation types](relations): `GET /blacklab-server/<corpus-name>/relations`<br>What span and relation types occur in the corpus? (now also available on corpus and field info pages)
 * [Schemas](schemas) : `GET /blacklab-server/<corpus-name>/schemas`<br>JSON schemas for (file) formats related to BlackLab.
-* [Plugins](plugins) : `GET /blacklab-server/plugins/`<br>Information about available (web-safe) plugins.

site/docs/server/030_rest-api/005_information/080_plugins.md

@@ -23,7 +23,6 @@
 import nl.inl.blacklab.Constants;
 import nl.inl.blacklab.instrumentation.RequestInstrumentationProvider;
 import nl.inl.blacklab.search.BlackLabIndex;
-import nl.inl.blacklab.server.BlsMain;
 import nl.inl.blacklab.server.config.BLSConfig;
 import nl.inl.blacklab.server.config.BLSConfigDebug;
 import nl.inl.blacklab.server.datastream.DataStream;
@@ -85,9 +84,6 @@ public void inform(SolrCore core) {
 
         BLSConfig config = getConfig(core);
 
-        // Before the plugin system is initialized, add our plugin type to it
-        BlsMain.setUpBlsPlugins();
-
         // Instantiate our search manager from the config
         config.setIsSolr(true);
         searchManager = new SearchManager(config, false);