Skip to content

Add endpoint to get xml file from content #793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
axlewin wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add endpoint to get xml file from content #793

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db2509c
Add endpoint to get xml file from content
axlewin May 21, 2026
86065cb
Generify error messages
axlewin May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions src/main/java/uk/ac/cam/cl/dtg/isaac/api/IsaacController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
import java.util.List;
import java.util.Map;

import static jakarta.ws.rs.core.MediaType.APPLICATION_XML;
import static uk.ac.cam.cl.dtg.isaac.api.Constants.*;
import static uk.ac.cam.cl.dtg.segue.api.Constants.*;

Expand Down Expand Up @@ -417,6 +418,48 @@
}
}

/**
* Endpoint to allow xml files to be requested from the content database.
*
* @param httpServletRequest
* - used for the Referer header for helpful error messages.
* @return a Response containing the file contents as Content-Disposition: attachment, or a SegueErrorResponse.
*/
@GET
@Produces(APPLICATION_XML)
@Path("/xml/{path:.*}")
@Operation(summary = "Get an xml file from the content database.")
public final Response getXMLByPath(@Context final HttpServletRequest httpServletRequest, @PathParam("path") final String path) {
if (!Files.getFileExtension(path).equalsIgnoreCase("xml")) {
SegueErrorResponse error = new SegueErrorResponse(Status.BAD_REQUEST, "Invalid file type requested");
return error.toResponse();
}

try {
ByteArrayOutputStream fileContent = this.contentManager.getFileBytes(path);

if (null == fileContent) {
String refererHeader = httpServletRequest.getHeader("Referer");
log.warn("Unable to locate file. Referer: ({})", refererHeader);

Check warning

Code scanning / CodeQL

Log Injection Medium

This log entry depends on a
user-provided value
Loading
.
return new SegueErrorResponse(Status.NOT_FOUND, "Unable to locate file.").toResponse();
}

return Response.ok(fileContent.toByteArray()).type(APPLICATION_XML)
.cacheControl(getCacheControl(NUMBER_SECONDS_IN_ONE_DAY, true))
.header("Content-Disposition", "attachment") // Do not show this file in the browser.
.build();

} catch (final IOException e) {
SegueErrorResponse error = new SegueErrorResponse(Status.INTERNAL_SERVER_ERROR, "Error reading file!");
log.error(error.getErrorMessage(), e);
return error.toResponse();
} catch (final UnsupportedOperationException e) {
SegueErrorResponse error = new SegueErrorResponse(Status.INTERNAL_SERVER_ERROR, "Multiple files match the path provided.");
log.error(error.getErrorMessage(), e);
return error.toResponse();
}
}

/**
* Get some statistics out of how many questions the user has completed.
*
Expand Down
Loading