OCR integration #13313

Kaan0029 · 2025-06-12T19:01:52Z

Closes #13267.

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.

jablib/src/main/java/org/jabref/logic/ocr/OcrService.java

jablib/src/main/java/org/jabref/logic/ocr/OcrException.java

jablib/src/main/java/org/jabref/logic/ocr/OcrResult.java

jablib/src/main/java/org/jabref/logic/ocr/OcrService.java

jablib/src/main/java/org/jabref/logic/ocr/OcrResult.java

jabgui/src/main/java/org/jabref/gui/linkedfile/OcrAction.java

jablib/src/main/java/org/jabref/logic/ocr/OcrResult.java

jablib/src/main/java/org/jabref/logic/ocr/OcrService.java

subhramit · 2025-07-03T13:49:23Z

Your pull request conflicts with the target branch.

Please merge upstream/main with your code. For a step-by-step guide to resolve merge conflicts, see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.

Tip for future - always take a fresh pull from upstream/main before beginning to work on a branch (if there has been a decent time gap).

jablib/src/main/java/org/jabref/logic/ocr/OcrService.java

jabref-machine · 2025-07-07T21:57:42Z

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.

jabref-machine · 2025-07-12T18:10: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.

…tation' into gsoc-ocr-tess4j-initial-implementation

jabref-machine · 2025-07-13T10:14:11Z

Note that your PR will not be reviewed/accepted until you have gone through the mandatory checks in the description and marked each of them them exactly in the format of [x] (done), [ ] (not done yet) or [/] (not applicable).

jabref-machine · 2025-07-13T10:16:29Z

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.

jablib/build.gradle.kts

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

trag-bot · 2025-07-16T20:18:39Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/contextmenu/ContextMenuFactory.java

+        // Create the OCR action
+        OcrAction ocrAction = new OcrAction(


Comment is trivial and does not add any new information beyond what is clearly visible in the code. It simply restates what the code is doing.

trag-bot · 2025-07-16T20:18:41Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/contextmenu/ContextMenuFactory.java

+        // Set the action to execute when clicked
+        ocrItem.setOnAction(event -> ocrAction.execute());


Comment is redundant and merely describes what the code does without providing additional context or reasoning. The code is self-explanatory.

trag-bot · 2025-07-16T20:18:45Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/contextmenu/ContextMenuFactory.java

+        // Disable if the action is not executable (file doesn't exist)
+        ocrItem.disableProperty().bind(ocrAction.executableProperty().not());


Comment restates what is evident from the code itself without providing additional insight or explanation about the underlying logic or design decision.

trag-bot · 2025-07-16T20:21:35Z

jablib/src/main/java/org/jabref/logic/ocr/TesseractOcrProvider.java

+            configureTessdata();
+            this.isAvailable = true;
+            LOGGER.debug("Initialized TesseractOcrProvider successfully");
+        } catch (Exception e) {


Catching generic Exception is too broad and may mask specific issues. Should catch specific exceptions that can occur during initialization.

trag-bot · 2025-07-16T20:21:38Z

jablib/src/main/java/org/jabref/logic/ocr/TesseractOcrProvider.java

+                    return true;
+                }
+            }
+        } catch (Exception e) {


Generic Exception catch block in setTessdataPath method should be replaced with specific exceptions like IOException or SecurityException.

trag-bot · 2025-07-16T20:21:41Z

jablib/src/main/java/org/jabref/logic/ocr/TesseractOcrProvider.java

+
+    private void configureTessdata() {
+        // Priority 1: Check user preferences (from settings)
+        if (filePreferences != null) {


Null check on constructor-injected filePreferences indicates potential null usage. Should use Optional or enforce non-null in constructor.

trag-bot · 2025-07-16T20:38:43Z

jablib/src/main/java/org/jabref/logic/ocr/OcrResult.java

+     */
+    record Failure(String errorMessage) implements OcrResult {
+        public Failure {
+            // Provide default message instead of throwing exception


Comment is trivial and simply describes what the code does. The code is self-explanatory and doesn't need this comment.

trag-bot · 2025-07-16T20:59:48Z

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

Kaan0029 and others added 2 commits June 12, 2025 20:57

Initial implementation using tess4j

a51e3b0

merge

aca504a

calixtus changed the title ~~Initial implementation using tess4j~~ OCR integration Jun 12, 2025

calixtus added component: external-files project: gsoc component: pdf-viewer labels Jun 12, 2025

calixtus reviewed Jun 12, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/ocr/OcrService.java Outdated Show resolved Hide resolved

add brew to jna path

48ffb06

Siedlerchr reviewed Jun 12, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/ocr/OcrService.java Outdated Show resolved Hide resolved

subhramit reviewed Jun 12, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/ocr/OcrService.java Outdated Show resolved Hide resolved

subhramit reviewed Jun 12, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/ocr/OcrException.java Show resolved Hide resolved

subhramit added the component: ocr label Jun 12, 2025

Adapted Exception handling and configured tessdata variable

5a256ae

trag-bot bot reviewed Jun 19, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/ocr/OcrResult.java Outdated Show resolved Hide resolved

Siedlerchr reviewed Jun 19, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/ocr/OcrService.java Outdated Show resolved Hide resolved

Siedlerchr reviewed Jun 19, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/ocr/OcrResult.java Outdated Show resolved Hide resolved

Siedlerchr reviewed Jun 19, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/linkedfile/OcrAction.java Outdated Show resolved Hide resolved

subhramit reviewed Jun 19, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/ocr/OcrResult.java Outdated Show resolved Hide resolved

subhramit reviewed Jun 19, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/ocr/OcrService.java Outdated Show resolved Hide resolved

addressed mentor code feedback after 19.06.25

f80cec8

calixtus reviewed Jul 3, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/ocr/OcrService.java Outdated Show resolved Hide resolved

koppor added this to the 6.0 milestone Jul 4, 2025

Merge branch 'upstream-main' into gsoc-ocr-tess4j-initial-implementation

db1f577

Kaan0029 force-pushed the gsoc-ocr-tess4j-initial-implementation branch from 9f91505 to db1f577 Compare July 10, 2025 10:49

Siedlerchr added 4 commits July 10, 2025 17:10

fix java modules

4020d3a

fix tessdata path

4987978

fix tessdata path amd module infor for lept4j

9842dd4

fix tessdata path amd module infor for lept4j

8b133e6

Kaan0029 added 3 commits July 13, 2025 12:55

Added Debugging Testing file for jna

e7a043d

Attempt to enforce specific jna version

caa48f1

Merge remote-tracking branch 'origin/gsoc-ocr-tess4j-initial-implemen…

9b51b23

…tation' into gsoc-ocr-tess4j-initial-implementation

calixtus added the dev: no-bot-comments If set, there should be no comments from our bots label Jul 13, 2025

koppor reviewed Jul 13, 2025

View reviewed changes

jablib/build.gradle.kts Outdated Show resolved Hide resolved

calixtus and others added 6 commits July 13, 2025 13:08

Fix jna include

c115803

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

Add jna-jpms

f16c1f4

fix arm64 crash

8c51016

fix tessdata path issue

5843c69

revert previous tessdata change

1bd2e5b

fixed lifecycle

c7fcc6b

trag-bot bot reviewed Jul 16, 2025

View reviewed changes

Kaan0029 added 4 commits July 16, 2025 22:23

fixed bug related to life cylce issue

a8bab25

Deleted unnecessary comments

9b9c7b7

use StringUtil.isBlank

edc0343

Use @nonnull

695e2b4

trag-bot bot reviewed Jul 16, 2025

View reviewed changes

Kaan0029 added 4 commits July 16, 2025 22:48

Added TODO comment

e5e651e

delete /tessdata from .gitignore

9ffdbff

delete TO-DO comments in FilePreferences

facb463

Delete unnecessary comment in OcrProvider

265a312

		// Create the OCR action
		OcrAction ocrAction = new OcrAction(

		// Set the action to execute when clicked
		ocrItem.setOnAction(event -> ocrAction.execute());

		// Disable if the action is not executable (file doesn't exist)
		ocrItem.disableProperty().bind(ocrAction.executableProperty().not());

Uh oh!

OCR integration #13313

Are you sure you want to change the base?

OCR integration #13313

Conversation

Kaan0029 commented Jun 12, 2025 • edited by InAnYan Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Mandatory checks

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

subhramit commented Jul 3, 2025

Uh oh!

Uh oh!

jabref-machine commented Jul 7, 2025

Uh oh!

jabref-machine commented Jul 12, 2025

Uh oh!

jabref-machine commented Jul 13, 2025

Uh oh!

jabref-machine commented Jul 13, 2025

Uh oh!

Uh oh!

trag-bot bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot commented Jul 16, 2025

Uh oh!

Uh oh!

Kaan0029 commented Jun 12, 2025 •

edited by InAnYan

Loading