OCR integration #13313
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| package org.jabref.gui.linkedfile; | ||
|
|
||
| import org.jabref.gui.DialogService; | ||
| import org.jabref.gui.StateManager; | ||
| import org.jabref.gui.actions.Action; | ||
| import org.jabref.gui.actions.ActionHelper; | ||
| import org.jabref.gui.actions.SimpleCommand; | ||
| import org.jabref.logic.util.BackgroundTask; | ||
| import org.jabref.logic.util.TaskExecutor; | ||
| import org.jabref.logic.l10n.Localization; | ||
| import org.jabref.logic.ocr.OcrService; | ||
| import org.jabref.logic.ocr.OcrException; | ||
| import org.jabref.model.database.BibDatabaseContext; | ||
| import org.jabref.model.entry.LinkedFile; | ||
| import org.jabref.logic.FilePreferences; | ||
|
|
||
| import java.nio.file.Path; | ||
| import java.util.Optional; | ||
|
|
||
| /** | ||
| * Action for performing OCR (Optical Character Recognition) on linked PDF files. | ||
| * <p> | ||
| * This action extracts text content from PDF files that are attached to BibTeX entries. | ||
| * It runs the OCR process in a background thread to keep the UI responsive and provides | ||
| * user feedback through dialogs and notifications. | ||
| * <p> | ||
| * The action follows JabRef's command pattern and can be triggered from context menus. | ||
| * It includes built-in validation to ensure it's only enabled for PDF files that exist on disk. | ||
| * | ||
| * @see OcrService | ||
| * @see org.jabref.gui.actions.SimpleCommand | ||
| */ | ||
|
|
||
| // Personal Note: Add more doc in between later | ||
|
|
||
| public class OcrAction extends SimpleCommand { | ||
|
|
||
| private final LinkedFile linkedFile; | ||
| private final BibDatabaseContext databaseContext; | ||
| private final DialogService dialogService; | ||
| private final FilePreferences filePreferences; | ||
| private final TaskExecutor taskExecutor; | ||
|
|
||
| public OcrAction(LinkedFile linkedFile, | ||
| BibDatabaseContext databaseContext, | ||
| DialogService dialogService, | ||
| FilePreferences filePreferences, | ||
| TaskExecutor taskExecutor) { | ||
| this.linkedFile = linkedFile; | ||
| this.databaseContext = databaseContext; | ||
| this.dialogService = dialogService; | ||
| this.filePreferences = filePreferences; | ||
| this.taskExecutor = taskExecutor; | ||
|
|
||
| // Only executable for existing PDF files | ||
| this.executable.set( | ||
| linkedFile.getFileType().equalsIgnoreCase("pdf") && | ||
| linkedFile.findIn(databaseContext, filePreferences).isPresent() | ||
| ); | ||
| } | ||
|
|
||
| @Override | ||
| public void execute() { | ||
| Optional<Path> filePath = linkedFile.findIn(databaseContext, filePreferences); | ||
|
|
||
| if (filePath.isEmpty()) { | ||
| dialogService.showErrorDialogAndWait( | ||
| Localization.lang("File not found"), | ||
| Localization.lang("Could not locate the PDF file on disk.") | ||
| ); | ||
| return; | ||
| } | ||
|
|
||
| dialogService.notify(Localization.lang("Performing OCR...")); | ||
|
|
||
| BackgroundTask.wrap(() -> { | ||
| OcrService ocrService = new OcrService(); | ||
| return ocrService.performOcr(filePath.get()); | ||
| }) | ||
| .onSuccess(extractedText -> { | ||
| if (extractedText.isEmpty()) { | ||
| dialogService.showInformationDialogAndWait( | ||
| Localization.lang("OCR Complete"), | ||
| Localization.lang("No text was found in the PDF.") | ||
| ); | ||
| } else { | ||
| // For now, just show preview | ||
| String preview = extractedText.length() > 1000 | ||
| ? extractedText.substring(0, 1000) + "..." | ||
| : extractedText; | ||
|
|
||
| dialogService.showInformationDialogAndWait( | ||
| Localization.lang("OCR Result"), | ||
| preview | ||
| ); | ||
| } | ||
| }) | ||
| .onFailure(exception -> { | ||
| dialogService.showErrorDialogAndWait( | ||
| Localization.lang("OCR failed"), | ||
| exception.getMessage() | ||
| ); | ||
| }) | ||
| .executeWith(taskExecutor); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| package org.jabref.logic.ocr; | ||
|
|
||
| /** | ||
| * Exception thrown when OCR operations fail. | ||
| * This exception wraps lower-level OCR engine exceptions to provide | ||
| * a consistent interface for error handling throughout JabRef. | ||
| */ | ||
| public class OcrException extends Exception { | ||
|
There was a problem hiding this comment. I like the idea, only drawback I see is this may be hard to maintain/stay consistent with as the project grows or if external contributors wish to add something... There was a problem hiding this comment. Best is to avoid exceptions being thrown at all, especially for expected possible stupid user behaviour. And if they are being thrown, keep them as informative as possible. The consistent interface is Exception at the end either way. There was a problem hiding this comment. Backstory: This was based on my experience in OO - all the JStyle classes and the OO GUI class had a custom error wrapper, OOError. There was also OOResult and OOVoidResult. I still don't know much about them, but for |
||
|
|
||
| /** | ||
| * Constructs an OcrException with a message and underlying cause. | ||
| * | ||
| * @param message Descriptive error message | ||
| * @param cause The underlying exception that caused this error | ||
| */ | ||
| public OcrException(String message, Throwable cause) { | ||
| super(message, cause); | ||
| } | ||
|
|
||
| /** | ||
| * Constructs an OcrException with only a message. | ||
| * | ||
| * @param message Descriptive error message | ||
| */ | ||
| public OcrException(String message) { | ||
| super(message); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| package org.jabref.logic.ocr; | ||
|
|
||
| import java.util.Optional; | ||
|
|
||
| public class OcrResult { | ||
| private final boolean success; | ||
| private final String text; | ||
| private final String errorMessage; | ||
|
|
||
| private OcrResult(boolean success, String text, String errorMessage) { | ||
|
There was a problem hiding this comment. Maybe can be converted to a record ? https://docs.oracle.com/en/java/javase/24/language/records.html |
||
| this.success = success; | ||
| this.text = text; | ||
| this.errorMessage = errorMessage; | ||
| } | ||
|
|
||
| public static OcrResult success(String text) { | ||
| return new OcrResult(true, text, null); | ||
|
Comment on lines
+10
to
+17
There was a problem hiding this comment. There should be a better way to think about the constructor parameters. Maybe have different constructors to avoid passing null (as both success and failure are very expected cases)? There was a problem hiding this comment. The other idea is to model a sealed class hierarchy with sucess/failure as simple record and then you can do pattern matching with switch ... There was a problem hiding this comment. example at the bottom https://gamlor.info/posts-output/2022-06-01-java-advanced-enums/en/ |
||
| } | ||
|
Comment on lines
+16
to
+18
There was a problem hiding this comment. Factory method passes null explicitly as a parameter. This violates the principle of not passing null to methods. Consider using Optional or restructuring to avoid null parameter. |
||
|
|
||
| public static OcrResult failure(String errorMessage) { | ||
| return new OcrResult(false, null, errorMessage); | ||
| } | ||
|
Comment on lines
+20
to
+22
There was a problem hiding this comment. Factory method passes null explicitly as a parameter. This violates the principle of not passing null to methods. Consider using Optional or restructuring to avoid null parameter. There was a problem hiding this comment. Optional should only be a return type |
||
|
|
||
| public boolean isSuccess() { | ||
| return success; | ||
| } | ||
|
|
||
| public Optional<String> getText() { | ||
| return Optional.ofNullable(text); | ||
| } | ||
|
|
||
| public Optional<String> getErrorMessage() { | ||
| return Optional.ofNullable(errorMessage); | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
before add
.showToUser(true) then it will be shown in the UI task list