#5777 - Allow fetching resource metadata from the backend #5780
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Ability to fetch image metadata via ImageIO - Also embed width/height on img tags we render from the backend
reckart
deleted the
feature/5777-Allow-fetching-resource-metadata-from-the-backend
branch
There was a problem hiding this comment.
Pull request overview
This PR adds the ability to fetch image metadata (width and height) from the backend and automatically embed these dimensions on <img> tags during HTML rendering. This feature is particularly useful for MHTML archives that contain images without declared dimensions.
Key Changes:
- Added a new REST endpoint (
/meta) to fetch image metadata as JSON - Implemented automatic embedding of width/height attributes on img tags during document rendering
- Fixed a typo in
NamespaceDecodingContentHandlerAdapterclass name
Reviewed changes
Copilot reviewed 10 out of 12 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| pom.xml | Added imageio-tiff version property (3.10.0) for enhanced image format support |
| inception-dependencies/pom.xml | Added imageio-tiff dependency declaration for TIFF image support |
| inception-external-editor/pom.xml | Added imageio-tiff dependency and configured maven-dependency-plugin to ignore it (SPI-based) |
| NamespaceDecodingContentHandlerAdapter.java | Fixed class name typo from 'Namspace' to 'Namespace' |
| ImageMetaData.java | New record class to represent image dimensions (width/height) with builder pattern |
| XHtmlXmlDocumentViewController.java | Added getResourceMetadata method signature to interface |
| XHtmlXmlDocumentViewControllerImpl.java | Core implementation: added metadata endpoint, image dimension extraction via ImageIO, and automatic dimension embedding handler |
| XmlDocumentViewControllerImplBase.java | Removed applyHtmlResourceUrlFilter method (moved to subclass) |
| MatrixWorkloadManagementPage.java | Reformatted method call for better readability |
| WicketApplicationBase.java | Reformatted CSP value initialization for consistency |
| InceptionSecurityWebUIApiAutoConfiguration.java | Reformatted CSP value initialization for consistency |
| PdfJsViewerPage.java | Reformatted comments and method calls for better readability |
Comments suppressed due to low confidence (2)
inception/inception-support/src/main/java/de/tudarmstadt/ukp/inception/support/xml/NamespaceDecodingContentHandlerAdapter.java:35
- Fixed typo in class name: 'Namspace' corrected to 'Namespace'.
inception/inception-support/src/main/java/de/tudarmstadt/ukp/inception/support/xml/NamespaceDecodingContentHandlerAdapter.java:45 - Fixed typo in constructor name: 'Namspace' corrected to 'Namespace'.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+481
to
+529
| @PreAuthorize("@documentAccess.canViewAnnotationDocument(#aProjectId, #aDocumentId, #principal.name)") | ||
| @Override | ||
| @GetMapping(path = GET_METADATA_PATH) | ||
| public ResponseEntity<String> getResourceMetadata( // | ||
| @PathVariable("projectId") long aProjectId, // | ||
| @PathVariable("documentId") long aDocumentId, // | ||
| @RequestParam("resId") String aResourceId, // | ||
| Principal principal) | ||
| throws Exception | ||
| { | ||
| var srcDoc = documentService.getSourceDocument(aProjectId, aDocumentId); | ||
|
|
||
| var maybeFormatSupport = formatRegistry.getFormatById(srcDoc.getFormat()); | ||
| if (maybeFormatSupport.isEmpty()) { | ||
| return ResponseEntity.notFound().build(); | ||
| } | ||
|
|
||
| var srcDocFile = documentStorageService.getSourceDocumentFile(srcDoc); | ||
|
|
||
| var formatSupport = maybeFormatSupport.get(); | ||
|
|
||
| if (!formatSupport.hasResources() | ||
| || !formatSupport.isAccessibleResource(srcDocFile, aResourceId)) { | ||
| LOG.debug("Resource [{}] for document {} not found", aResourceId, srcDoc); | ||
| return ResponseEntity.notFound().build(); | ||
| } | ||
|
|
||
| try { | ||
| var inputStream = formatSupport.openResourceStream(srcDocFile, aResourceId); | ||
|
|
||
| var httpHeaders = new HttpHeaders(); | ||
| httpHeaders.setContentType(APPLICATION_JSON); | ||
|
|
||
| var imageMetaData = getImageDimensions(inputStream); | ||
| if (imageMetaData.isPresent()) { | ||
| return new ResponseEntity<>(toJsonString(imageMetaData.get()), httpHeaders, OK); | ||
| } | ||
|
|
||
| return new ResponseEntity<>("{}", httpHeaders, NOT_FOUND); | ||
| } | ||
| catch (FileNotFoundException e) { | ||
| LOG.debug("Resource [{}] for document {} not found", aResourceId, srcDoc); | ||
| return ResponseEntity.notFound().build(); | ||
| } | ||
| catch (Exception e) { | ||
| LOG.debug("Unable to load resource [{}] for document {}", aResourceId, srcDoc, e); | ||
| return ResponseEntity.notFound().build(); | ||
| } | ||
| } |
There was a problem hiding this comment.
The new getResourceMetadata endpoint lacks test coverage. Consider adding tests to verify:
- Successful metadata retrieval for valid image resources
- Proper 404 responses for non-existent resources
- Proper 404 responses for non-image resources
- Access control enforcement
- JSON response format correctness
This is a new public API endpoint that should have comprehensive test coverage.
...va/de/tudarmstadt/ukp/inception/externaleditor/xhtml/XHtmlXmlDocumentViewControllerImpl.java
Show resolved
Hide resolved
...al-editor/src/main/java/de/tudarmstadt/ukp/inception/externaleditor/xhtml/ImageMetaData.java
Show resolved
Hide resolved
...va/de/tudarmstadt/ukp/inception/externaleditor/xhtml/XHtmlXmlDocumentViewControllerImpl.java
Show resolved
Hide resolved
...va/de/tudarmstadt/ukp/inception/externaleditor/xhtml/XHtmlXmlDocumentViewControllerImpl.java
Show resolved
Hide resolved
...va/de/tudarmstadt/ukp/inception/externaleditor/xhtml/XHtmlXmlDocumentViewControllerImpl.java
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's in the PR
How to test manually
Automatic testing
Documentation