Add http endpoints for JabMap #13519

iloveskittles82 · 2025-07-09T17:39:00Z

Aims to tackle #12280

With this PR, the HTTP-Server is expanded to supply JabMap with necessary data. Several Endpoints have been added (see LibraryRessource.java and rest-api.http) as well as some DTOs.
The repo for JabMap with a detailed setup description can be found here

I'm marking this as a draft for now to document changes, check mergability and present it to the dev team. It'll stay like this until its integrated properly (tbd).

Steps to test

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
[/] Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (if change is visible to the user)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

Add cayw

# Conflicts: # jabsrv/src/test/rest-api.http

if the server doest find a .jmp, it now returns a mindmap with on a root node saying "JabMap"

.jbang/JabSrvLauncher.java

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

koppor · 2025-07-09T18:05:19Z

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

+
+    private java.nio.file.Path getJabMapDemoPath() {
+        java.nio.file.Path result = java.nio.file.Path.of(System.getProperty("java.io.tmpdir")).resolve("demo.jmp");
+        // TODO: make this debug - and adapt "tinylog.properties" locally to use debug level


Address this TODO (and remove this line)

unfortunately I don't know why this TODO is here. I don't know what it is adressing tbh. I believe you added it? What did you mean by make this debug - and adapt "tinylog.properties" locally to use debug level?

See my sugestions, it is just about changing the letters error to debug. Easy.

I think, you don't want to inspect the .jmp file. Otherwise, you would need to learn about tinylog.properties outlined at https://devdocs.jabref.org/code-howtos/logging.html

koppor · 2025-07-09T18:06:54Z

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

            responseContext.getHeaders().add("Access-Control-Allow-Origin", "*");
        } else if (requestOrigin.contains("://localhost")) {
            responseContext.getHeaders().add("Access-Control-Allow-Origin", requestOrigin);
+        } else if (requestOrigin.endsWith("://jabref.github.io")) {


All of this can be simplified to always return the *

done, please check the code again to confirm I understood you (or rather the code x) correctly

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

… naming convention

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

.jbang/JabSrvLauncher.java

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

koppor · 2025-07-10T04:44:26Z

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

+ */
+public class PdfAnnotationDTO {
+    // save a LinkedPDFFileDTO which contains all necessary info to make a request back to the http server (e. g. to update the annotation content)
+    // see https://github.com/JabRef/jabmap/issues/21 first before working with the "path" attribute


I commented there how to make a path absolute.

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

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

koppor · 2025-07-10T04:47:26Z

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

+
+    private java.nio.file.Path getJabMapDemoPath() {
+        java.nio.file.Path result = java.nio.file.Path.of(System.getProperty("java.io.tmpdir")).resolve("demo.jmp");
+        // TODO: make this debug - and adapt "tinylog.properties" locally to use debug level


See my sugestions, it is just about changing the letters error to debug. Easy.

I think, you don't want to inspect the .jmp file. Otherwise, you would need to learn about tinylog.properties outlined at https://devdocs.jabref.org/code-howtos/logging.html

koppor · 2025-07-10T04:48:02Z

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

+    @Path("entries/{entryId}")
+    @Produces(MediaType.TEXT_HTML + ";charset=UTF-8")
+    public String getHTMLRepresentation(@PathParam("id") String id, @PathParam("entryId") String entryId) throws IOException {
+        // get entry with given citationkey (entryId)


Suggested change

// get entry with given citationkey (entryId)

koppor · 2025-07-10T04:48:46Z

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

+        // loop through all entries to extract pdfs and paths
+        for (BibEntry entry : entries) {
+            List<LinkedFile> pathsToFiles = entry.getFiles();
+            if (!pathsToFiles.isEmpty()) {
+                for (LinkedFile file : pathsToFiles) {
+                    // ignore all non pdf files and online references
+                    if (!file.getFileType().equals("PDF") || LinkedFile.isOnlineLink(file.getLink())) {
+                        continue;
+                    }
+                    // add file to response body
+                    LinkedPdfFileDTO localPdfFile = new LinkedPdfFileDTO(entry, file);
+                    response.add(localPdfFile);
+                }
+            }
+        }


A good excercise would be to convert this to a Java Stream - but this might be too much for now.

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

ran "rewriteDiscover", "rewriteDryRun" and "rewriteRun" tasks, changed 1 line and removed unnecessary comment

trag-bot · 2025-07-15T17:26:18Z

@trag-bot didn't find any issues in the code! ✅✨

koppor · 2025-07-15T17:58:38Z

org.jabref.logic.importer.FetcherException: Error getting response code

Not relevant for this - all checks passed

Therefore manually merging.

* upstream/main: Add http endpoints for JabMap (#13519)

koppor and others added 30 commits May 19, 2025 15:16

Try to have first endpoint

6d4abb3

Refine ServerCLI

82c01d0

Add initial support for "demo"

4cbe324

Add JAbSrvLauncher

4b344e5

Add hint to start.

142d29f

Merge branch 'main' into jabmap

528c588

Merge remote-tracking branch 'origin/main' into jabmap

d49c116

initial cayw

ea620a5

Merge branch 'main' into cayw

7d57d0e

fix issues mentioned by subhramit

0877a93

Merge branch 'JabRef:main' into cayw

546b32a

Merge branch 'cayw' into jabmap

3cdbc6d

Merge branch 'main' into cayw

9b52f2f

Merge branch 'JabRef:main' into cayw

7c2826f

Merge remote-tracking branch 'origin/main' into jabmap

a673d68

WIP: for get preview

bf276cb

Finalize endpoint

3005b75

Merge remote-tracking branch 'origin/main' into cayw

4911107

Merge branch 'cayw' into add-cyaw

4ae1a03

Merge branch 'jabmap' into add-cyaw

93beea3

Merge pull request #1 from iloveskittles82/add-cyaw

3404185

Add cayw

change get mindmap json method

57b7ad1

add test to rest-api

ee66720

Merge remote-tracking branch 'origin/jabmap' into jabmap

9faad94

# Conflicts: # jabsrv/src/test/rest-api.http

Merge branch 'JabRef:main' into cayw

795d229

added new formatting for the entry preview get request and another test

50d4e68

added html preview get function

1e176fd

WIP added method which returns list of all pdf files in library

bca73f6

Merge branch 'JabRef:main' into cayw

fa06686

Merge branch 'JabRef:main' into cayw

d96ed1e

updated default mindmap for server

d05d417

if the server doest find a .jmp, it now returns a mindmap with on a root node saying "JabMap"

trag-bot bot reviewed Jul 9, 2025

View reviewed changes

.jbang/JabSrvLauncher.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Jul 9, 2025

View reviewed changes

jabsrv/src/main/java/org/jabref/http/dto/PDFAnnotationDTO.java Outdated Show resolved Hide resolved

koppor requested changes Jul 9, 2025

View reviewed changes

iloveskittles82 added 2 commits July 9, 2025 20:52

rename PDFAnnotationDTO to PdfAnnotationDTO to match LinkedPdfFileDTO…

72d6dc4

… naming convention

Unified JavaDoc style

37dc4eb

trag-bot bot reviewed Jul 9, 2025

View reviewed changes

jabsrv/src/main/java/org/jabref/http/server/LibraryResource.java Show resolved Hide resolved

simplify CORS filter

d474bb4

koppor mentioned this pull request Jul 10, 2025

Use Java 11 isBlank #13523

Merged

1 task

koppor requested changes Jul 10, 2025

View reviewed changes

koppor and others added 2 commits July 10, 2025 12:47

Merge branch 'main' into jabmap

a978973

more cleanup

9cb47c7

koppor mentioned this pull request Jul 11, 2025

Add JabMap iloveskittles82/jabref#2

Closed

koppor changed the title ~~Adding HTTP-Server Jabmap~~ Add http endpoints for JabMap Jul 11, 2025

iloveskittles82 and others added 6 commits July 14, 2025 12:13

did a rewrite run

c10f612

ran "rewriteDiscover", "rewriteDryRun" and "rewriteRun" tasks, changed 1 line and removed unnecessary comment

added more javadoc and paths for requests

4eaa897

fixed "put" request error

51fde13

remove annotation endpoint

91e34b8

Merge branch 'main' into jabmap

a84dd38

Remove unused DTOs

0d306f9

koppor marked this pull request as ready for review July 15, 2025 17:24

koppor approved these changes Jul 15, 2025

View reviewed changes

koppor enabled auto-merge July 15, 2025 17:24

koppor added this pull request to the merge queue Jul 15, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 15, 2025

koppor merged commit 25ae95d into JabRef:main Jul 15, 2025
1 check was pending

koppor deleted the jabmap branch July 15, 2025 17:59

Siedlerchr added a commit that referenced this pull request Aug 2, 2025

Merge remote-tracking branch 'upstream/main'

6772596

* upstream/main: Add http endpoints for JabMap (#13519)

Uh oh!

Add http endpoints for JabMap #13519

Add http endpoints for JabMap #13519

Uh oh!

Conversation

iloveskittles82 commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Steps to test

Mandatory checks

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

koppor Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

trag-bot bot commented Jul 15, 2025

Uh oh!

Uh oh!

koppor commented Jul 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

iloveskittles82 commented Jul 9, 2025 •

edited

Loading

koppor Jul 10, 2025 •

edited

Loading