Qortal/qortal
1
0
Fork 0
mirror of https://github.com/Qortal/qortal.git synced 2025-03-13 19:12:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added GET /resource/filename/{service}/{name}/{identifier} endpoint.

Browse Source 
This allows the filename of single file resources to be returned via the API. Useful to help determine to file format of the data.
This commit is contained in:
CalDescent 2023-03-18 15:16:41 +00:00
parent 87ed49a2ee
commit 4ce3b2a786
1 changed files with 53 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
src/main/java/org/qortal/api/resource/ArbitraryResource.java
View File

@ -278,6 +278,33 @@ public class ArbitraryResource {
return ArbitraryTransactionUtils.getStatus(service, name, null, build); return ArbitraryTransactionUtils.getStatus(service, name, null, build);
} }
@GET
@Path("/resource/filename/{service}/{name}/{identifier}")
@Operation(
summary = "Get filename in published data",
description = "This causes a download of the data if it's not local. A filename will only be returned for single file resources.",
responses = {
@ApiResponse(
content = @Content(mediaType = MediaType.TEXT_PLAIN,
schema = @Schema(
type = "string"
)
)
)
}
)
@SecurityRequirement(name = "apiKey")
public String getResourceFilename(@HeaderParam(Security.API_KEY_HEADER) String apiKey,
@PathParam("service") Service service,
@PathParam("name") String name,
@PathParam("identifier") String identifier) {
if (!Settings.getInstance().isQDNAuthBypassEnabled())
Security.requirePriorAuthorizationOrApiKey(request, name, service, identifier, apiKey);
return this.getFilename(service, name, identifier);
}
@GET @GET
@Path("/resource/status/{service}/{name}/{identifier}") @Path("/resource/status/{service}/{name}/{identifier}")
@Operation( @Operation(
@ -1350,4 +1377,30 @@ public class ArbitraryResource {
throw ApiExceptionFactory.INSTANCE.createCustomException(request, ApiError.FILE_NOT_FOUND, e.getMessage()); throw ApiExceptionFactory.INSTANCE.createCustomException(request, ApiError.FILE_NOT_FOUND, e.getMessage());
} }
} }
private String getFilename(Service service, String name, String identifier) {
ArbitraryDataReader arbitraryDataReader = new ArbitraryDataReader(name, ArbitraryDataFile.ResourceIdType.NAME, service, identifier);
try {
arbitraryDataReader.loadSynchronously(false);
java.nio.file.Path outputPath = arbitraryDataReader.getFilePath();
if (outputPath == null) {
// Assume the resource doesn't exist
throw ApiExceptionFactory.INSTANCE.createCustomException(request, ApiError.FILE_NOT_FOUND, "File not found");
}
String[] files = ArrayUtils.removeElement(outputPath.toFile().list(), ".qortal");
if (files.length == 1) {
LOGGER.info("File: {}", files[0]);
return files[0];
}
else {
throw ApiExceptionFactory.INSTANCE.createCustomException(request, ApiError.INVALID_CRITERIA, "Filename not available for multi file resources");
}
} catch (Exception e) {
LOGGER.debug(String.format("Unable to load %s %s: %s", service, name, e.getMessage()));
throw ApiExceptionFactory.INSTANCE.createCustomException(request, ApiError.FILE_NOT_FOUND, e.getMessage());
}
}
} }