refine-jabsrv

build.gradle.kts

@@ -56,8 +56,12 @@ requirementTracing {
 
 subprojects {
     plugins.apply("checkstyle")
+
     plugins.apply("com.github.andygoossens.modernizer")
+
+    // Hint from https://stackoverflow.com/a/46533151/873282
     plugins.apply("com.adarshr.test-logger")
+
     plugins.apply("com.github.koppor.gradle-modules-plugin")
 
     checkstyle {

jabsrv/build.gradle.kts

@@ -1,3 +1,5 @@
+import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+
 plugins {
     id("buildlogic.java-common-conventions")
 
@@ -8,13 +10,17 @@ plugins {
 
 application{
     mainClass.set("org.jabref.http.server.Server")
+    mainModule.set("org.jabref.jabsrv")
+
+    applicationDefaultJvmArgs = listOf(
+        "--enable-native-access=com.sun.jna"
+    )
 }
 
 dependencies {
     implementation(project(":jablib"))
 
     implementation("org.slf4j:slf4j-api:2.0.17")
-    implementation("org.tinylog:tinylog-api:2.7.0")
     implementation("org.tinylog:slf4j-tinylog:2.7.0")
     implementation("org.tinylog:tinylog-impl:2.7.0")
     // route all requests to java.util.logging to SLF4J (which in turn routes to tinylog)
@@ -31,6 +37,7 @@ dependencies {
     // Injection framework
     implementation("org.glassfish.jersey.inject:jersey-hk2:3.1.10")
     implementation("org.glassfish.hk2:hk2-api:3.1.1")
+    implementation("org.glassfish.hk2:hk2-utils:3.1.1")
 
     // testImplementation("org.glassfish.hk2:hk2-testing:3.0.4")
     // implementation("org.glassfish.hk2:hk2-testing-jersey:3.0.4")
@@ -39,7 +46,11 @@ dependencies {
     // HTTP server
     // implementation("org.glassfish.jersey.containers:jersey-container-netty-http:3.1.1")
     implementation("org.glassfish.jersey.containers:jersey-container-grizzly2-http:3.1.10")
+    implementation("org.glassfish.grizzly:grizzly-http-server:4.0.2")
+    implementation("org.glassfish.grizzly:grizzly-framework:4.0.2")
     testImplementation("org.glassfish.jersey.test-framework.providers:jersey-test-framework-provider-grizzly2:3.1.10")
+    implementation("jakarta.validation:jakarta.validation-api:3.1.1")
+    implementation("org.hibernate.validator:hibernate-validator:8.0.2.Final")
 
     implementation("com.konghq:unirest-modules-gson:4.4.6")
 
@@ -69,3 +80,21 @@ javafx {
     // because of afterburner.fx
     modules = listOf("javafx.base", "javafx.controls", "javafx.fxml")
 }
+
+tasks.test {
+    testLogging {
+        // set options for log level LIFECYCLE
+        events("FAILED")
+        exceptionFormat = TestExceptionFormat.FULL
+    }
+    maxParallelForks = 1
+}
+
+tasks.named<JavaExec>("run") {
+    doFirst {
+        application.applicationDefaultJvmArgs =
+            listOf(
+                "--enable-native-access=com.sun.jna"
+            )
+    }
+}

jabsrv/src/main/java/module-info.java

@@ -1,15 +1,15 @@
 module org.jabref.jabsrv {
     exports org.jabref.http.server;
-    opens org.jabref.http.server
-            to org.glassfish.hk2.utilities,
-            org.glassfish.hk2.locator;
+
+    exports org.jabref.http.dto to com.google.gson, org.glassfish.hk2.locator;
+
+    opens org.jabref.http.server to org.glassfish.hk2.utilities, org.glassfish.hk2.locator;
 
     requires org.jabref.jablib;
 
     requires org.slf4j;
     requires jul.to.slf4j;
     requires org.apache.logging.log4j.to.slf4j;
-    requires org.tinylog.api;
     requires org.tinylog.api.slf4j;
     requires org.tinylog.impl;
 
@@ -29,8 +29,14 @@
     // requires org.glassfish.jaxb.runtime;
 
     requires org.glassfish.grizzly;
+    requires org.glassfish.grizzly.http;
+    requires org.glassfish.grizzly.http.server;
+    requires jakarta.validation;
     requires jakarta.ws.rs;
 
+    requires jersey.common;
+
+
     requires net.harawata.appdirs;
     requires com.sun.jna;
     requires com.sun.jna.platform;
@@ -39,4 +45,7 @@
     requires citeproc.java;
 
     requires transitive org.jspecify;
+    requires java.logging;
+    requires jersey.container.grizzly2.http;
+    requires jersey.server;
 }

jabsrv/src/main/java/org/jabref/http/dto/GlobalExceptionMapper.java

@@ -0,0 +1,19 @@
+package org.jabref.http.dto;
+
+import jakarta.ws.rs.core.Response;
+import jakarta.ws.rs.ext.ExceptionMapper;
+import jakarta.ws.rs.ext.Provider;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Provider
+public class GlobalExceptionMapper implements ExceptionMapper<Throwable> {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionMapper.class.getName());
+
+    @Override
+    public Response toResponse(Throwable exception) {
+        LOGGER.error("Unhandled exception on server", exception);
+        return Response.serverError().entity("Internal Server Error").build();
+    }
+}

jabsrv/src/main/java/org/jabref/http/server/LibrariesResource.java

@@ -2,7 +2,7 @@
 
 import java.util.List;
 
-import org.jabref.logic.preferences.CliPreferences;
+import org.jabref.http.server.services.FilesToServe;
 import org.jabref.logic.util.io.BackupFileUtil;
 
 import com.google.gson.Gson;
@@ -15,14 +15,17 @@
 @Path("libraries")
 public class LibrariesResource {
     @Inject
-    CliPreferences preferences;
+    private FilesToServe filesToServe;
+
+    @Inject
+    private Gson gson;
 
     @GET
     @Produces(MediaType.APPLICATION_JSON)
     public String get() {
-        List<String> fileNamesWithUniqueSuffix = preferences.getLastFilesOpenedPreferences().getLastFilesOpened().stream()
+        List<String> fileNamesWithUniqueSuffix = filesToServe.getFilesToServe().stream()
                                                             .map(p -> p.getFileName() + "-" + BackupFileUtil.getUniqueFilePrefix(p))
                                                             .toList();
-        return new Gson().toJson(fileNamesWithUniqueSuffix);
+        return gson.toJson(fileNamesWithUniqueSuffix);
     }
 }

jabsrv/src/main/java/org/jabref/http/server/LibraryResource.java

@@ -7,6 +7,7 @@
 
 import org.jabref.http.JabrefMediaType;
 import org.jabref.http.dto.BibEntryDTO;
+import org.jabref.http.server.services.FilesToServe;
 import org.jabref.logic.citationstyle.JabRefItemDataProvider;
 import org.jabref.logic.importer.ParserResult;
 import org.jabref.logic.importer.fileformat.BibtexImporter;
@@ -36,6 +37,9 @@ public class LibraryResource {
     @Inject
     CliPreferences preferences;
 
+    @Inject
+    FilesToServe filesToServe;
+
     @Inject
     Gson gson;
 
@@ -89,7 +93,7 @@ public Response getBibtex(@PathParam("id") String id) {
     }
 
     private java.nio.file.Path getLibraryPath(String id) {
-        return preferences.getLastFilesOpenedPreferences().getLastFilesOpened()
+        return filesToServe.getFilesToServe()
                           .stream()
                           .filter(p -> (p.getFileName() + "-" + BackupFileUtil.getUniqueFilePrefix(p)).equals(id))
                           .findAny()

jabsrv/src/main/java/org/jabref/http/server/Server.java

@@ -6,15 +6,24 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.stream.Collectors;
 
 import javax.net.ssl.SSLContext;
 
 import org.jabref.architecture.AllowedToUseStandardStreams;
+import org.jabref.http.dto.GlobalExceptionMapper;
+import org.jabref.http.dto.GsonFactory;
+import org.jabref.http.server.services.FilesToServe;
 import org.jabref.logic.os.OS;
+import org.jabref.logic.preferences.JabRefCliPreferences;
 
-import jakarta.ws.rs.SeBootstrap;
 import net.harawata.appdirs.AppDirsFactory;
+import org.glassfish.grizzly.http.server.HttpServer;
 import org.glassfish.grizzly.ssl.SSLContextConfigurator;
+import org.glassfish.hk2.api.ServiceLocator;
+import org.glassfish.hk2.utilities.ServiceLocatorUtilities;
+import org.glassfish.jersey.grizzly2.httpserver.GrizzlyHttpServerFactory;
+import org.glassfish.jersey.server.ResourceConfig;
 import org.jspecify.annotations.NonNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -24,7 +33,7 @@
 public class Server {
     private static final Logger LOGGER = LoggerFactory.getLogger(Server.class);
 
-    private static SeBootstrap.Instance serverInstance;
+    private static final String BASE_URI = "http://localhost:6050/";
 
     /**
      * Starts an http server serving the last files opened in JabRef<br>
@@ -34,7 +43,7 @@ public static void main(final String[] args) throws InterruptedException {
         SLF4JBridgeHandler.removeHandlersForRootLogger();
         SLF4JBridgeHandler.install();
 
-        final List<Path> lastFilesOpened = new ArrayList<>(); // JabRefCliPreferences.getInstance().getGuiPreferences().getLastFilesOpened();
+        final List<Path> filesToServe = JabRefCliPreferences.getInstance().getLastFilesOpenedPreferences().getLastFilesOpened().stream().collect(Collectors.toCollection(ArrayList::new));
 
         // The server serves the last opened files (see org.jabref.http.server.LibraryResource.getLibraryPath)
         // In a testing environment, this might be difficult to handle
@@ -44,63 +53,80 @@ public static void main(final String[] args) throws InterruptedException {
             List<Path> filesToAdd = Arrays.stream(args)
                                           .map(Path::of)
                                           .filter(Files::exists)
-                                          .filter(path -> !lastFilesOpened.contains(path))
+                                          .filter(path -> !filesToServe.contains(path))
                                           .toList();
 
             LOGGER.debug("Adding following files to the list of opened libraries: {}", filesToAdd);
 
             // add the files in the front of the last opened libraries
             for (Path path : filesToAdd.reversed()) {
-                lastFilesOpened.addFirst(path);
+                filesToServe.addFirst(path);
             }
         }
 
-        if (lastFilesOpened.isEmpty()) {
-            LOGGER.debug("still no library available to serve, serve the demo library");
+        if (filesToServe.isEmpty()) {
+            LOGGER.debug("Still no library available to serve, serving the demo library...");
             // Server.class.getResource("...") is always null here, thus trying relative path
             // Path bibPath = Path.of(Server.class.getResource("http-server-demo.bib").toURI());
             Path bibPath = Path.of("src/main/resources/org/jabref/http/server/http-server-demo.bib").toAbsolutePath();
             LOGGER.debug("Location of demo library: {}", bibPath);
-            lastFilesOpened.add(bibPath);
+            filesToServe.add(bibPath);
         }
 
-        LOGGER.debug("Libraries served: {}", lastFilesOpened);
+        LOGGER.debug("Libraries to serve: {}", filesToServe);
 
-        Server.startServer();
+        FilesToServe filesToServeService = new FilesToServe();
+        filesToServeService.setFilesToServe(filesToServe);
+
+        Server.startServer(filesToServeService);
 
         // Keep the http server running until user kills the process (e.g., presses Ctrl+C)
         Thread.currentThread().join();
     }
 
-    private static void startServer() {
-        SeBootstrap.Configuration configuration;
-        if (!sslCertExists()) {
-            LOGGER.info("SSL certificate not found. Server starts in non-SSL mode.");
-            configuration = SeBootstrap.Configuration.builder()
-                                                     .protocol("HTTP")
-                                                     .port(6050)
-                                                     .build();
-        } else {
-            LOGGER.info("SSL certificate found. Server starts in SSL mode.");
-            SSLContext sslContext = getSslContext();
-            configuration = SeBootstrap.Configuration.builder()
-                                                     .sslContext(sslContext)
-                                                     .protocol("HTTPS")
-                                                     .port(6051)
-                                                     .build();
-        }
+    public static HttpServer startServer(ServiceLocator serviceLocator) {
+        // see https://stackoverflow.com/a/33794265/873282
+        final ResourceConfig resourceConfig = new ResourceConfig();
+        // TODO: Add SSL
+        resourceConfig.register(LibrariesResource.class);
+        resourceConfig.register(LibraryResource.class);
+        resourceConfig.register(CORSFilter.class);
+        resourceConfig.register(GlobalExceptionMapper.class);
+
         LOGGER.debug("Starting server...");
-        SeBootstrap.start(Application.class, configuration).thenAccept(instance -> {
-            LOGGER.debug("Server started.");
-            instance.stopOnShutdown(stopResult ->
-                    LOGGER.debug("Stop result: {} [Native stop result: {}].", stopResult,
-                            stopResult.unwrap(Object.class)));
-            final URI uri = instance.configuration().baseUri();
-            LOGGER.debug("Instance {} running at {} [Native handle: {}].%n", instance, uri,
-                    instance.unwrap(Object.class));
-            LOGGER.debug("Send SIGKILL to shutdown.");
-            serverInstance = instance;
-        });
+        final HttpServer httpServer =
+                GrizzlyHttpServerFactory
+                        .createHttpServer(URI.create(BASE_URI), resourceConfig, serviceLocator);
+        return httpServer;
+    }
+
+    private static void startServer(FilesToServe filesToServe) {
+        ServiceLocator serviceLocator = ServiceLocatorUtilities.createAndPopulateServiceLocator();
+        ServiceLocatorUtilities.addFactoryConstants(serviceLocator, new GsonFactory());
+        ServiceLocatorUtilities.addFactoryConstants(serviceLocator, new PreferencesFactory());
+        ServiceLocatorUtilities.addOneConstant(serviceLocator, filesToServe);
+
+        try {
+            final HttpServer httpServer = startServer(serviceLocator);
+
+            // add jvm shutdown hook
+            Runtime.getRuntime().addShutdownHook(new Thread(() -> {
+                try {
+                    System.out.println("Shutting down jabsrv...");
+                    httpServer.shutdownNow();
+                    System.out.println("Done, exit.");
+                } catch (Exception e) {
+                    LOGGER.error("Could not shut down server", e);
+                }
+            }));
+
+            System.out.println("JabSrv started.");
+            System.out.println("Stop JabSrv using Ctrl+C");
+
+            Thread.currentThread().join();
+        } catch (InterruptedException ex) {
+            LOGGER.error("Could not start down server", ex);
+        }
     }
 
     private static boolean sslCertExists() {
@@ -132,6 +158,6 @@ private static Path getSslCert() {
     }
 
     static void stopServer() {
-        serverInstance.stop();
+        // serverInstance.stop();
     }
 }