Add more file importers to JabRef #13310

InAnYan · 2025-06-12T14:24:08Z

Changes made:

Add Apache Tika dependencies.
Add imports for ODF documents (ODT, ODS, ODP).
Add tests for importers

Steps to test

Run Java tests.
Import ODF files.

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.

InAnYan · 2025-06-12T14:26:20Z

Currently having errors while compiling:

Could not determine the dependencies of task ':jablib:test'.
> Could not resolve all dependencies for configuration ':jablib:testRuntimeClasspath'.
   > Could not resolve commons-logging:commons-logging:1.3.5.
     Required by:
         project :jablib
         project :jablib > org.apache.pdfbox:pdfbox:3.0.5
      > Module 'commons-logging:commons-logging' has been rejected:
           Cannot select module with conflict on capability 'org.gradlex:commons-logging-impl:1.0' also provided by [org.slf4j:jcl-over-slf4j:2.0.17(runtime)]
   > Could not resolve org.slf4j:jcl-over-slf4j:2.0.17.
     Required by:
         project :jablib > org.apache.tika:tika-parsers-standard-package:3.2.0
         project :jablib > org.slf4j:slf4j-api:2.0.17 > org.slf4j:slf4j-bom:2.0.17
      > Module 'org.slf4j:jcl-over-slf4j' has been rejected:
           Cannot select module with conflict on capability 'org.gradlex:commons-logging-impl:1.0' also provided by [commons-logging:commons-logging:1.3.5(runtime)]
> There are 3 more failures with identical causes.

jablib/src/main/java/org/jabref/logic/importer/ParserResult.java

jablib/src/main/java/org/jabref/logic/importer/fileformat/docs/OdpImporter.java

jablib/src/main/java/org/jabref/logic/importer/fileformat/docs/OdsImporter.java

jabref-machine · 2025-06-12T14:28:33Z

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. To see the test output, locate "Tests / Checkstyle (pull_request)" and click on it.

In case of issues with the import order, double check that you activated Auto Import. You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues, commit, and push.

jablib/src/main/java/org/jabref/logic/importer/fileformat/docs/OdtImporter.java

jablib/src/main/java/org/jabref/logic/importer/util/Constants.java

jablib/src/main/java/org/jabref/logic/util/StandardFileType.java

jablib/src/test/java/org/jabref/logic/importer/fileformat/docs/OdpImporterTest.java

jablib/src/test/java/org/jabref/logic/importer/fileformat/docs/OdsImporterFilesTest.java

jablib/src/test/java/org/jabref/logic/importer/fileformat/docs/OdsImporterTest.java

jablib/src/test/java/org/jabref/logic/importer/fileformat/docs/OdtImporterTest.java

Siedlerchr · 2025-06-12T14:37:13Z

exclude commons logging from the dependency

InAnYan · 2025-06-12T15:14:11Z

https://github.com/JabRef/jabref/pull/13310/files#diff-97b29e486a6f1ead0c3bb51ba59dca43b67d1bbcf8ff6009bfc90ebc80130e4dR211

That's what I did

jablib/build.gradle.kts

This reverts commit a3eb9f3.

This reverts commit ed19d6b.

jabref-machine · 2025-06-12T21:01:46Z

Your pull request needs to link an issue correctly.

To ease organizational workflows, please link this pull-request to the issue with syntax as described in https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue:

Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message.

Examples

✅ Fixes #xyz links pull-request to issue. Merging the PR will close the issue.
✅ Fixes https://github.com/JabRef/jabref/issues/xyz links pull-request to issue. Merging the PR will close the issue.
✅ Fixes https://github.com/Koppor/jabref/issues/xyz links pull-request to issue. Merging the PR will close the issue.
❌ Fixes [#xyz](https://github.com/JabRef/jabref/issues/xyz) links pull-request to issue. Merging the PR will NOT close the issue.

jabref-machine · 2025-06-12T21:09:10Z

JUnit tests of jablib are failing. You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. To see the test output, locate "Tests / Unit tests (pull_request)" and click on it.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

…nd tests

…away common methods

trag-bot · 2025-06-16T19:33:06Z

jablib/src/main/java/org/jabref/logic/importer/fileformat/img/PngImporter.java

+
+    @Override
+    protected void extractAdditionalMetadata(BibEntry entry, TikaMetadataParser metadataParser) {
+        entry.setType(BiblatexNonStandardTypes.Image);


Using setter method instead of the recommended wither pattern for BibEntry modifications. Should use withType() method to maintain immutability principles.

trag-bot · 2025-06-16T19:34:30Z

jablib/src/main/java/org/jabref/logic/importer/fileformat/odf/OdfImporter.java

+    protected void extractAdditionalMetadata(BibEntry entry, TikaMetadataParser metadataParser) {
+        List<String> authors = ListUtil.concat(metadataParser.getDcCreators(), metadataParser.getDcContributors());
+
+        entry.setField(StandardField.AUTHOR, TikaMetadataParser.formatBibtexAuthors(authors));


Using setField instead of withField violates the immutability principle. Should use entry.withField(StandardField.AUTHOR, ...) for better consistency.

trag-bot · 2025-06-16T19:35:01Z

jablib/src/main/java/org/jabref/logic/importer/util/TikaMetadataParser.java

+import org.apache.tika.metadata.Property;
+
+public class TikaMetadataParser {
+    private final static Pattern imageDatePattern = Pattern.compile("(year|month|day|hour|minute|second)=(\\d+)");


Incorrect modifier order. According to Java conventions, 'static' should come before 'final'. Should be 'private static final Pattern'.

trag-bot · 2025-06-16T19:38:05Z

jablib/src/main/java/org/jabref/model/util/ListUtil.java

+    /**
+     * Concatenate two {@link List}s. Does not modify the original lists.
+     */


The JavaDoc comment is trivial and simply restates what is obvious from the method signature and name. It doesn't provide any additional information or reasoning about the implementation.

trag-bot · 2025-06-17T00:15:14Z

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

koppor · 2025-06-17T00:14:22Z

jablib/build.gradle.kts

@@ -181,6 +181,33 @@ dependencies {

    implementation("de.rototor.snuggletex:snuggletex-jeuclid")

+    // region for document importing


Please rework with the new scheme.

But the concrete versions at https://github.com/JabRef/jabref/blob/main/versions/build.gradle.kts

koppor · 2025-06-17T00:18:43Z

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


    requires javafx.base;
    requires javafx.graphics; // because of javafx.scene.paint.Color
    requires afterburner.fx;
    requires com.tobiasdiez.easybind;

    // for java.awt.geom.Rectangle2D required by org.jabref.logic.pdf.TextExtractor
-    requires java.desktop;


Is org.jabref.logic.pdf.TextExtractor gone? Then also delete the line before.

koppor · 2025-06-17T00:18:52Z

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

@@ -106,16 +106,14 @@
    exports org.jabref.logic.git;
    exports org.jabref.logic.pseudonymization;
    exports org.jabref.logic.citation.repository;
-
-    requires java.base;


Oh, really, no java.base any more?

koppor · 2025-06-17T00:21:01Z

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

@@ -252,5 +250,7 @@
    requires mslinks;
    requires org.antlr.antlr4.runtime;
    requires org.libreoffice.uno;
+    requires org.apache.tika.core;
+    requires org.jetbrains.annotations;


Please no jetbrains annotations

Use JSpecify - "howto" at https://www.jetbrains.com/help/idea/annotating-source-code.html#configure-nullability-annotations

koppor · 2025-06-17T00:21:31Z

jablib/src/main/java/org/jabref/logic/importer/Importer.java

@@ -49,6 +49,10 @@ public abstract class Importer implements Comparable<Importer> {
     * @throws IOException Signals that an I/O exception has occurred.
     */
    public boolean isRecognizedFormat(Path filePath) throws IOException {
+        if (!Files.exists(filePath) || !Files.isRegularFile(filePath)) {


The latter includes the former, doesn't it?

Suggested change

if (!Files.exists(filePath) || !Files.isRegularFile(filePath)) {

if (!Files.isRegularFile(filePath)) {

koppor · 2025-06-17T00:22:32Z

jablib/src/main/java/org/jabref/logic/importer/fileformat/books/DjvuImporter.java

+import org.jabref.logic.util.FileType;
+import org.jabref.logic.util.StandardFileType;
+
+public class DjvuImporter extends TikaImporter {


Some refernce to the format would be nice.

koppor · 2025-06-17T00:22:56Z

jablib/src/main/java/org/jabref/logic/importer/fileformat/books/EpubImporter.java

+import org.jabref.logic.util.FileType;
+import org.jabref.logic.util.StandardFileType;
+
+public class EpubImporter extends TikaImporter {


Some refernce to the format would be nice.

(Even if it self-explanatory here; but mayb e some more non-obvious onformatoin can be found there)

feat(importers): add importers for ODF files

7e9f579

InAnYan changed the title ~~feat(importers): add importers for ODF files~~ Add importers for ODF files Jun 12, 2025