crowetic/qortal
1
0
Fork 0
forked from Qortal/qortal
Code Pull Requests Activity

Added support for optional Base64 encoding in FETCH_QDN_RESOURCE.

Browse Source
This commit is contained in:
CalDescent 2023-03-03 15:39:37 +00:00
parent 9ea2d7ab09
commit b254ca7706
3 changed files with 23 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Q-Apps.md
View File

@ -116,7 +116,8 @@ async function myfunction() {
action: "FETCH_QDN_RESOURCE", action: "FETCH_QDN_RESOURCE",
name: "QortalDemo", name: "QortalDemo",
service: "THUMBNAIL", service: "THUMBNAIL",
identifier: "qortal_avatar" identifier: "qortal_avatar",
encoding: "base64"
}, timeout); }, timeout);
// Do something with the avatar here // Do something with the avatar here
@ -225,13 +226,13 @@ let res = await qortalRequest({
``` ```
### Fetch QDN single file resource ### Fetch QDN single file resource
Data is returned in the base64 format
``` ```
let res = await qortalRequest({ let res = await qortalRequest({
action: "FETCH_QDN_RESOURCE", action: "FETCH_QDN_RESOURCE",
name: "QortalDemo", name: "QortalDemo",
service: "THUMBNAIL", service: "THUMBNAIL",
identifier: "qortal_avatar", // Optional. If omitted, the default resource is returned, or you can alternatively use the keyword "default" identifier: "qortal_avatar", // Optional. If omitted, the default resource is returned, or you can alternatively use the keyword "default"
encoding: "base64", // Optional. If omitted, data is returned in raw form
rebuild: false rebuild: false
}); });
``` ```
@ -548,26 +549,26 @@ Here is a sample application to display the logged-in user's avatar:
return; return;
} }
// Download the avatar of the first registered name // Download base64-encoded avatar of the first registered name
let avatar = await qortalRequest({ let avatar = await qortalRequest({
action: "FETCH_QDN_RESOURCE", action: "FETCH_QDN_RESOURCE",
name: names[0].name, name: names[0].name,
service: "THUMBNAIL", service: "THUMBNAIL",
identifier: "qortal_avatar" identifier: "qortal_avatar",
encoding: "base64"
}); });
console.log("avatar: " + JSON.stringify(avatar)); console.log("Avatar size: " + avatar.length + " bytes");
// Display the avatar image on the screen // Display the avatar image on the screen
document.getElementsById("avatar").src = "data:image/png;base64," + avatar; document.getElementById("avatar").src = "data:image/png;base64," + avatar;
} catch(e) { } catch(e) {
console.log("Error: " + JSON.stringify(e)); console.log("Error: " + JSON.stringify(e));
} }
} }
showAvatar();
</script> </script>
</head> </head>
<body> <body onload="showAvatar()">
<img width="500" id="avatar" /> <img width="500" id="avatar" />
</body> </body>
</html> </html>

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

@ -17,6 +17,7 @@ import java.nio.file.Paths;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.List; import java.util.List;
import java.util.Objects;
import javax.servlet.ServletContext; import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequest;
@ -646,6 +647,7 @@ public class ArbitraryResource {
@PathParam("service") Service service, @PathParam("service") Service service,
@PathParam("name") String name, @PathParam("name") String name,
@QueryParam("filepath") String filepath, @QueryParam("filepath") String filepath,
@QueryParam("encoding") String encoding,
@QueryParam("rebuild") boolean rebuild, @QueryParam("rebuild") boolean rebuild,
@QueryParam("async") boolean async, @QueryParam("async") boolean async,
@QueryParam("attempts") Integer attempts) { @QueryParam("attempts") Integer attempts) {
@ -655,7 +657,7 @@ public class ArbitraryResource {
Security.checkApiCallAllowed(request); Security.checkApiCallAllowed(request);
} }
return this.download(service, name, null, filepath, rebuild, async, attempts); return this.download(service, name, null, filepath, encoding, rebuild, async, attempts);
} }
@GET @GET
@ -681,6 +683,7 @@ public class ArbitraryResource {
@PathParam("name") String name, @PathParam("name") String name,
@PathParam("identifier") String identifier, @PathParam("identifier") String identifier,
@QueryParam("filepath") String filepath, @QueryParam("filepath") String filepath,
@QueryParam("encoding") String encoding,
@QueryParam("rebuild") boolean rebuild, @QueryParam("rebuild") boolean rebuild,
@QueryParam("async") boolean async, @QueryParam("async") boolean async,
@QueryParam("attempts") Integer attempts) { @QueryParam("attempts") Integer attempts) {
@ -690,7 +693,7 @@ public class ArbitraryResource {
Security.checkApiCallAllowed(request, apiKey); Security.checkApiCallAllowed(request, apiKey);
} }
return this.download(service, name, identifier, filepath, rebuild, async, attempts); return this.download(service, name, identifier, filepath, encoding, rebuild, async, attempts);
} }
@ -1239,7 +1242,7 @@ public class ArbitraryResource {
} }
} }
private HttpServletResponse download(Service service, String name, String identifier, String filepath, boolean rebuild, boolean async, Integer maxAttempts) { private HttpServletResponse download(Service service, String name, String identifier, String filepath, String encoding, boolean rebuild, boolean async, Integer maxAttempts) {
ArbitraryDataReader arbitraryDataReader = new ArbitraryDataReader(name, ArbitraryDataFile.ResourceIdType.NAME, service, identifier); ArbitraryDataReader arbitraryDataReader = new ArbitraryDataReader(name, ArbitraryDataFile.ResourceIdType.NAME, service, identifier);
try { try {
@ -1298,7 +1301,14 @@ public class ArbitraryResource {
String message = String.format("No file exists at filepath: %s", filepath); String message = String.format("No file exists at filepath: %s", filepath);
throw ApiExceptionFactory.INSTANCE.createCustomException(request, ApiError.INVALID_CRITERIA, message); throw ApiExceptionFactory.INSTANCE.createCustomException(request, ApiError.INVALID_CRITERIA, message);
} }
byte[] data = Files.readAllBytes(path); byte[] data = Files.readAllBytes(path);
// Encode the data if requested
if (encoding != null && Objects.equals(encoding.toLowerCase(), "base64")) {
data = Base64.encode(data);
}
response.setContentType(context.getMimeType(path.toString())); response.setContentType(context.getMimeType(path.toString()));
response.setContentLength(data.length); response.setContentLength(data.length);
response.getOutputStream().write(data); response.getOutputStream().write(data);

1
src/main/resources/q-apps/q-apps.js
View File

@ -173,6 +173,7 @@ window.addEventListener("message", (event) => {
url = url.concat("?"); url = url.concat("?");
if (data.filepath != null) url = url.concat("&filepath=" + data.filepath); if (data.filepath != null) url = url.concat("&filepath=" + data.filepath);
if (data.rebuild != null) url = url.concat("&rebuild=" + new Boolean(data.rebuild).toString()) if (data.rebuild != null) url = url.concat("&rebuild=" + new Boolean(data.rebuild).toString())
if (data.encoding != null) url = url.concat("&encoding=" + data.encoding);
response = httpGet(url); response = httpGet(url);
break; break;