Make plugins response uniform in structure.

Author: jan-niestadt

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

@@ -43,6 +43,7 @@
 import nl.inl.blacklab.indexers.config.process.ProcessingInstructionStrip;
 import nl.inl.blacklab.indexers.config.process.ProcessingInstructionUnique;
 import nl.inl.blacklab.search.BlackLab;
+import nl.inl.blacklab.search.extensions.QueryExtensions;
 import nl.inl.blacklab.search.extensions.QueryFunctionAbs;
 import nl.inl.blacklab.search.extensions.QueryFunctionEnd;
 import nl.inl.blacklab.search.extensions.QueryFunctionFixedSpan;
@@ -109,6 +110,12 @@ public class PluginManager {
 
     private static final Set<Class<? extends Plugin>> safePluginClasses = new HashSet<>();
 
+    /** Groovy plugin script we've found but not loaded yet. We don't yet know its plugin type. */
+    record UnloadedGroovyPlugin(File scriptFile, BLConfigPlugins pluginConfig) {}
+
+    /** Groovy plugin scripts we've found but not loaded yet. We don't yet know their plugin type. */
+    private static final Map<String, UnloadedGroovyPlugin> unloadedGroovyScripts = new LinkedHashMap<>();
+
     static {
         addWebSafePlugins(List.of(
                 // FileConverter
@@ -162,6 +169,7 @@ public class PluginManager {
                 QueryFunctionSymbol.class,
                 QueryFunctionUnion.class
         ));
+        QueryExtensions.registerAll(); // register e.g. rspan(), debug functions, etc.
     }
 
     public static synchronized void addWebSafePlugins(List<Class<? extends Plugin>> pluginClasses) {
@@ -173,17 +181,6 @@ public static synchronized <T extends Plugin> boolean isAllowed(Plugin plugin) {
         return safePluginClasses.contains(plugin.getClass());
     }
 
-    private static synchronized void ensureInitialized() {
-        if (!isInitialized)
-            initialize(BlackLab.config().getPlugins(), BlackLab.configDir());
-    }
-
-    /** Groovy plugin script we've found but not loaded yet. We don't yet know its plugin type. */
-    record UnloadedGroovyPlugin(File scriptFile, BLConfigPlugins pluginConfig) {}
-
-    /** Groovy plugin scripts we've found but not loaded yet. We don't yet know their plugin type. */
-    private static final Map<String, UnloadedGroovyPlugin> unloadedGroovyScripts = new LinkedHashMap<>();
-
     // Nothing to do; initialization happens when the blacklab config is loaded.
     // The blacklab Config is automatically loaded when the first BlackLabIndex is
     // opened, or earlier by a user library.
@@ -198,23 +195,23 @@ public static File getPluginsDir() {
     }
 
     public static synchronized void addPluginType(Class<? extends Plugin> pluginType) {
-        if (isInitialized)
-            throw new IllegalStateException("Cannot add plugin type after initialization");
         pluginTypes.add(pluginType);
+        URLClassLoader cl = getPluginsDirClassLoader(PluginManager.class.getClassLoader());
+        pluginsByType.put(pluginType, new PluginsOfType<>(pluginType, BlackLab.config().getPlugins(), cl));
     }
 
     /**
      * Attempts to load and initialize all plugin classes and scripts in the plugin
      * directory (and classes on the classpath), passing the values in the config
      * to the matching plugin.
-     *
-     * @param pluginConfig configurations per plugin id
-     * @param configDir directory where plugins and their configs can be found
      */
-    public static synchronized void initialize(BLConfigPlugins pluginConfig, File configDir) {
+    public static synchronized void ensureInitialized() {
         if (isInitialized)
-            throw new IllegalStateException("PluginManager already initialized");
+            return; // only do this once
         isInitialized = true;
+
+        BLConfigPlugins pluginConfig = BlackLab.config().getPlugins();
+        File configDir = BlackLab.configDir();
         PluginManager.pluginsDir = new File(configDir, PLUGINS_DIR_NAME);
 
         logger.debug("Initializing plugin system...");
@@ -325,7 +322,7 @@ static synchronized <T extends Plugin> void getUnloaded(String scriptName) {
         }
     }
 
-    private static void register(Plugin plugin, BLConfigPlugins pluginConfig, String scriptFileName, boolean registerClassName) {
+    private static synchronized void register(Plugin plugin, BLConfigPlugins pluginConfig, String scriptFileName, boolean registerClassName) {
         ensureInitialized();
         for (Class<? extends Plugin> pluginClass: pluginTypes) {
             if (pluginClass.isInstance(plugin)) {
@@ -345,7 +342,7 @@ public static <T extends Plugin> PluginsOfType<T> type(Class<T> pluginType) {
     }
 
     /** Get all registered plugin types. */
-    public static List<Class<? extends Plugin>> getPluginTypes() {
+    public static synchronized List<Class<? extends Plugin>> getPluginTypes() {
         ensureInitialized();
         return List.copyOf(pluginTypes);
     }

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

@@ -73,6 +73,10 @@ public String getName() {
         return name;
     }
 
+    public List<PluginParam> getParameters() {
+        return argTypes;
+    }
+
     public List<Object> preprocessArgs(QueryExecutionContext context, List<TextPattern> args) {
         // Make sure argument are interpreted as the correct type
         // (the parser interprets all values as queries, so we sometimes need to convert them back...)

engine/src/main/java/nl/inl/blacklab/search/BlackLab.java

@@ -51,6 +51,9 @@
 public final class BlackLab {
     private static final Logger logger = LogManager.getLogger(BlackLab.class);
 
+    public static final String MSG_DEFAULT_CONFIG_ALREADY_APPLIED = "Cannot set default configuration - " +
+            " configuration has already been applied.";
+
     /**
      * If client doesn't explicitly create a BlackLab instance, one will be instantiated
      * automatically.
@@ -369,14 +372,11 @@ public static synchronized File configDir() {
      * because another default config has been applied already.
      */
     public static synchronized void setConfigFromFile() {
-        if (globalSettingsApplied)
-            throw new UnsupportedOperationException("Cannot set default configuration - another configuration has already been applied.");
-
         List<File> dirsToSearch = Collections.singletonList(configDir());
         File file = FileUtil.findFile(dirsToSearch, "blacklab", Arrays.asList("yaml", "yml", "json"));
         if (file != null) {
             try {
-                blackLabConfig = BlackLabConfig.readConfigFile(file);
+                setConfig(BlackLabConfig.readConfigFile(file), true);
                 configDir = file.getParentFile();
             } catch (IOException e) {
                 logger.warn("Could not load default blacklab configuration file " + file + ": " + e.getMessage());
@@ -396,12 +396,8 @@ public static synchronized void setConfigFromFile() {
     public static synchronized void setConfig(BlackLabConfig config, boolean forceApply) {
         if (globalSettingsApplied && !forceApply)
             return;
-
-        if (globalSettingsApplied) {
-            throw new UnsupportedOperationException(
-                    "Cannot set default configuration - another configuration has already been applied.");
-        }
-        
+        if (globalSettingsApplied)
+            throw new UnsupportedOperationException(MSG_DEFAULT_CONFIG_ALREADY_APPLIED);
         blackLabConfig = config; 
     }
 

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

@@ -15,7 +15,7 @@ public class QueryExtensions {
     private QueryExtensions() {
     }
 
-    static {
+    public static void registerAll() {
         register(XFDebug.class);      // Debug functions such as _ident(), _FI1(), _FI2()
         register(XFRelations.class);  // Functions for working with relations
         register(XFPunctBeforeAfter.class);  // Pseudo-annotations punctBefore/punctAfter

solr/src/main/java/org/ivdnt/blacklab/solr/BlackLabSearchComponent.java

@@ -6,7 +6,6 @@
 import java.io.PrintWriter;
 import java.io.StringWriter;
 import java.nio.charset.StandardCharsets;
-import java.util.List;
 import java.util.Map;
 
 import org.apache.commons.lang3.StringUtils;
@@ -23,17 +22,8 @@
 
 import nl.inl.blacklab.Constants;
 import nl.inl.blacklab.instrumentation.RequestInstrumentationProvider;
-import nl.inl.blacklab.plugins.AuthMethodProvider;
-import nl.inl.blacklab.plugins.PluginManager;
-import nl.inl.blacklab.queryParser.JsonParserProvider;
-import nl.inl.blacklab.queryParser.contextql.ContextQLParserProvider;
-import nl.inl.blacklab.queryParser.corpusql.BcqlParserProvider;
 import nl.inl.blacklab.search.BlackLabIndex;
-import nl.inl.blacklab.server.auth.AuthClarinEppn;
-import nl.inl.blacklab.server.auth.AuthDebugFixed;
-import nl.inl.blacklab.server.auth.AuthDebugUrl;
-import nl.inl.blacklab.server.auth.AuthHttpBasic;
-import nl.inl.blacklab.server.auth.AuthRequestValue;
+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;
@@ -96,16 +86,7 @@ public void inform(SolrCore core) {
         BLSConfig config = getConfig(core);
 
         // Before the plugin system is initialized, add our plugin type to it
-        PluginManager.addPluginType(AuthMethodProvider.class);
-        PluginManager.addWebSafePlugins(List.of(
-                AuthHttpBasic.class,
-                AuthDebugFixed.class,
-                AuthClarinEppn.class,
-                AuthDebugUrl.class,
-                AuthRequestValue.class,
-                BcqlParserProvider.class,
-                JsonParserProvider.class,
-                ContextQLParserProvider.class));
+        BlsMain.setUpBlsPlugins();
 
         // Instantiate our search manager from the config
         config.setIsSolr(true);