Skip to content
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

Jump to bottom

MCR-2688 RestAPIv2 - new PATCH methods to update derivate metadata #1608

Draft
wants to merge 1 commit into
base: 2021.06.x
Choose a base branch
from
Draft

MCR-2688 RestAPIv2 - new PATCH methods to update derivate metadata #1608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions mycore-restapi/src/main/java/org/mycore/restapi/v2/MCRErrorCodeConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ final class MCRErrorCodeConstants {

//MCRDerivate
public static final String MCRDERIVATE_NO_PERMISSION = "MCRDERIVATE_NO_PERMISSION";

public static final String MCRDERIVATE_INVALID_JSON_PATCH_SYNTAX = "MCRDERIVATE_INVALID_JSON_PATCH_SYNTAX";

public static final String MCRDERIVATE_NOT_FOUND = "MCRDERIVATE_NOT_FOUND";

Expand Down
287 changes: 287 additions & 0 deletions mycore-restapi/src/main/java/org/mycore/restapi/v2/MCRRestDerivates.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import java.lang.annotation.Annotation;
import java.nio.file.FileSystemException;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Optional;
Expand All @@ -38,6 +39,7 @@
import javax.ws.rs.DefaultValue;
import javax.ws.rs.FormParam;
import javax.ws.rs.GET;
import javax.ws.rs.PATCH;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
Expand Down Expand Up @@ -74,6 +76,7 @@
import org.mycore.datamodel.niofs.MCRPath;
import org.mycore.frontend.jersey.MCRCacheControl;
import org.mycore.restapi.annotations.MCRAccessControlExposeHeaders;
import org.mycore.restapi.annotations.MCRApiDraft;
import org.mycore.restapi.annotations.MCRParam;
import org.mycore.restapi.annotations.MCRParams;
import org.mycore.restapi.annotations.MCRRequireTransaction;
Expand All @@ -82,6 +85,10 @@
import org.xml.sax.SAXException;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
Expand Down Expand Up @@ -389,6 +396,286 @@ private Response doCreateDerivate(@BeanParam DerivateMetadata der) {
return Response.created(uriInfo.getAbsolutePathBuilder().path(derId.toString()).build()).build();
}

/**
* This method updates a derivate.
* It uses a list of update statements in JSON Patch format.
* JSON Patch is described in RFC 6902 (https://doi.org/10.17487/RFC6902)
*
* Currently onyl the "add" method is implemented for the pathes
* "/maindoc", "/order", "/titles", "/classifications".
*
* If a title or classification should be updated, the complete JSONArray
* has to be submitted again.
*
* We may provide more operations to modify single elements in the list of
* titles or classifications.
*
* @param operations - the body of the request in JSON Patch syntax
* @param derid - the ID of the MCRDerivate
* @return the HTTP response
*
* @author Robert Stephan
*/
@PATCH
@Operation(
summary = "Updates the metadata (or partial metadata) of the given derivate via JSON Patch (RFC 6902)",
responses = @ApiResponse(responseCode = "204",
headers = @Header(name = HttpHeaders.LOCATION, description = "URL of the patched derivate")),
tags = MCRRestUtils.TAG_MYCORE_DERIVATE)
@Consumes(MediaType.APPLICATION_JSON_PATCH_JSON)
@RequestBody(required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON_PATCH_JSON))
@MCRRequireTransaction
@MCRAccessControlExposeHeaders(HttpHeaders.LOCATION)
@Path("/{" + PARAM_DERID + "}")
@MCRApiDraft("PartialMetadataUpdates")
public Response patchDerivate(String operations,
@Parameter(example = "mir_derivate_00004711") @PathParam(PARAM_DERID) MCRObjectID derid) {
MCRDerivate derivate = MCRMetadataManager.retrieveMCRDerivate(derid);
boolean modified = false;
try {
JsonArray patch = JsonParser.parseString(operations).getAsJsonArray();
for (JsonElement elOp : patch) {
JsonObject o = elOp.getAsJsonObject();
String opp = o.has("op") ? o.getAsJsonPrimitive("op").getAsString() : null;
String path = o.has("path") ? o.getAsJsonPrimitive("path").getAsString() : null;

if ("add".equals(opp)) {
if ("/order".equals(path) && o.has("value")) {
int order = o.getAsJsonPrimitive("value").getAsInt();
if (order != derivate.getOrder()) {
modified = true;
derivate.setOrder(order);
}
continue;
}
}
if ("/maindoc".equals(path) && o.has("value")) {
String maindoc = o.getAsJsonPrimitive("value").getAsString();
if (!maindoc.equals(derivate.getDerivate().getInternals().getMainDoc())) {
modified = true;
derivate.getDerivate().getInternals().setMainDoc(maindoc);
}
continue;
}
if ("/classifications".equals(path) && o.has("value")) {
JsonArray jsonClassifications = o.getAsJsonArray("value");
List<MCRCategoryID> newClassifications = new ArrayList<>();
for (JsonElement elCl : jsonClassifications) {
newClassifications
.add(MCRCategoryID
.fromString(elCl.getAsJsonObject().getAsJsonPrimitive("classid").getAsString()
+ ":" + elCl.getAsJsonObject().getAsJsonPrimitive("categid").getAsString()));
}
if (!newClassifications.isEmpty()) {
List<MCRCategoryID> oldClassifications = derivate.getDerivate().getClassifications().stream()
.map(x -> MCRCategoryID.fromString(x.getClassId() + ":" + x.getCategId()))
.collect(Collectors.toList());
if (oldClassifications.size() != newClassifications.size()
|| !oldClassifications.containsAll(newClassifications)) {
modified = true;
derivate.getDerivate().getClassifications().clear();
derivate.getDerivate().getClassifications()
.addAll(newClassifications.stream()
.map(categId -> new MCRMetaClassification("classification", 0, null, categId))
.collect(Collectors.toList()));
}
}
continue;
}

if ("/titles".equals(path) && o.has("value")) {
JsonArray jsonTitles = o.getAsJsonArray("value");
List<MCRMetaLangText> newTitles = new ArrayList<>();
for (JsonElement elTitle : jsonTitles) {
newTitles
.add(new MCRMetaLangText("title",
elTitle.getAsJsonObject().getAsJsonPrimitive("lang").getAsString(),
null, 0, null, elTitle.getAsJsonObject().getAsJsonPrimitive("text").getAsString()));
}
if (!newTitles.isEmpty()) {
if (derivate.getDerivate().getTitleSize() != newTitles.size()
|| !derivate.getDerivate().getTitles().containsAll(newTitles)) {
modified = true;
derivate.getDerivate().getTitles().clear();
derivate.getDerivate().getTitles().addAll(newTitles);
}
}
continue;
}

//finally: if no operation has matched -> return an error
throw MCRErrorResponse.fromStatus(Response.Status.BAD_REQUEST.getStatusCode())
.withErrorCode(MCRErrorCodeConstants.MCRDERIVATE_INVALID_JSON_PATCH_SYNTAX)
.withMessage("The patch for MCRDerivate " + derivate.getId() + " failed.")
.withDetail("The following operation could not be processed: " + elOp.toString())
.toException();
}
} catch (Exception e) {
throw MCRErrorResponse.fromStatus(Response.Status.BAD_REQUEST.getStatusCode())
.withErrorCode(MCRErrorCodeConstants.MCRDERIVATE_INVALID_JSON_PATCH_SYNTAX)
.withMessage("The patch for MCRDerivate " + derivate.getId() + " failed.")
.withDetail(e.getMessage())
.withCause(e)
.toException();
}
if (modified) {
try {
MCRMetadataManager.update(derivate);
} catch (MCRAccessException e) {
throw MCRErrorResponse.fromStatus(Response.Status.FORBIDDEN.getStatusCode())
.withErrorCode(MCRErrorCodeConstants.MCRDERIVATE_NO_PERMISSION)
.withMessage("You may not update MCRDerivate " + derivate.getId() + ".")
.withDetail(e.getMessage())
.withCause(e)
.toException();
}
}
return Response.noContent().build();
}

/**
* This method updates a derivate.
* It uses an update object following the conventions of JSON Merge Patch format.
* JSON Merge Patch is described in RFC 7386 (https://doi.org/10.17487/RFC7386)
*
* Currently onyl the update of the following properties are implemented
* "maindoc", "order", "titles", "classifications".
*
* If a title or classification should be updated, the complete JSONArray
* has to be submitted again.
*
* @param updateObject - the body of the request in JSON Merge Patch syntax
* @param derid - the ID of the MCRDerivate
* @return the HTTP response
*
* @author Robert Stephan
*/
@PATCH
@Operation(
summary = "Updates the metadata (or partial metadata) of the given derivate via JSON Merge Patch (RFC 7386)",
responses = @ApiResponse(responseCode = "204",
headers = @Header(name = HttpHeaders.LOCATION, description = "URL of the patched derivate")),
tags = MCRRestUtils.TAG_MYCORE_DERIVATE)
@Consumes("application/merge-patch+json")
@RequestBody(required = true,
content = @Content(mediaType = "application/merge-patch+json"))
@MCRRequireTransaction
@MCRAccessControlExposeHeaders(HttpHeaders.LOCATION)
@Path("/{" + PARAM_DERID + "}")
@MCRApiDraft("PartialMetadataUpdates")
public Response mergePatchDerivate(String updateObject,
@Parameter(example = "mir_derivate_00004711") @PathParam(PARAM_DERID) MCRObjectID derid) {
MCRDerivate derivate = MCRMetadataManager.retrieveMCRDerivate(derid);
boolean modified = false;
try {
JsonObject patch = JsonParser.parseString(updateObject).getAsJsonObject();
if (patch.has("order")) {
if (patch.get("order").isJsonNull()) {
//set default value
modified = true;
derivate.setOrder(1);

} else {
int order = patch.getAsJsonPrimitive("order").getAsInt();
if (order != derivate.getOrder()) {
modified = true;
derivate.setOrder(order);
}
}
}
if (patch.has("maindoc")) {
if (patch.get("maindoc").isJsonNull()) {
//delete
modified = true;
derivate.getDerivate().getInternals().setMainDoc(null);

} else {
String maindoc = patch.getAsJsonPrimitive("maindoc").getAsString();
if (!maindoc.equals(derivate.getDerivate().getInternals().getMainDoc())) {
modified = true;
derivate.getDerivate().getInternals().setMainDoc(maindoc);
}
}
}
if (patch.has("classifications")) {
if (patch.get("classifications").isJsonNull()) {
//delete
modified = true;
derivate.getDerivate().getClassifications().clear();
} else {
JsonArray jsonClassifications = patch.getAsJsonArray("classifications");
List<MCRCategoryID> newClassifications = new ArrayList<>();
for (JsonElement elCl : jsonClassifications) {
newClassifications
.add(MCRCategoryID
.fromString(elCl.getAsJsonObject().getAsJsonPrimitive("classid").getAsString()
+ ":" + elCl.getAsJsonObject().getAsJsonPrimitive("categid").getAsString()));
}
if (!newClassifications.isEmpty()) {
List<MCRCategoryID> oldClassifications = derivate.getDerivate().getClassifications().stream()
.map(x -> MCRCategoryID.fromString(x.getClassId() + ":" + x.getCategId()))
.collect(Collectors.toList());
if (oldClassifications.size() != newClassifications.size()
|| !oldClassifications.containsAll(newClassifications)) {
modified = true;
derivate.getDerivate().getClassifications().clear();
derivate.getDerivate().getClassifications()
.addAll(newClassifications.stream()
.map(categId -> new MCRMetaClassification("classification", 0, null, categId))
.collect(Collectors.toList()));
}
}
}
}

if (patch.has("titles")) {
if (patch.get("titles").isJsonNull()) {
//delete
modified = true;
derivate.getDerivate().getTitles().clear();
} else {
JsonArray jsonTitles = patch.getAsJsonArray("titles");
List<MCRMetaLangText> newTitles = new ArrayList<>();
for (JsonElement elTitle : jsonTitles) {
newTitles
.add(new MCRMetaLangText("title",
elTitle.getAsJsonObject().getAsJsonPrimitive("lang").getAsString(),
null, 0, null, elTitle.getAsJsonObject().getAsJsonPrimitive("text").getAsString()));
}
if (!newTitles.isEmpty()) {
if (derivate.getDerivate().getTitleSize() != newTitles.size()
|| !derivate.getDerivate().getTitles().containsAll(newTitles)) {
modified = true;
derivate.getDerivate().getTitles().clear();
derivate.getDerivate().getTitles().addAll(newTitles);
}
}
}
}
} catch (Exception e) {
throw MCRErrorResponse.fromStatus(Response.Status.BAD_REQUEST.getStatusCode())
.withErrorCode(MCRErrorCodeConstants.MCRDERIVATE_INVALID_JSON_PATCH_SYNTAX)
.withMessage("The merge patch for MCRDerivate " + derivate.getId() + " failed.")
.withDetail(e.getMessage())
.withCause(e)
.toException();
}
if (modified) {
try {
MCRMetadataManager.update(derivate);
} catch (MCRAccessException e) {
throw MCRErrorResponse.fromStatus(Response.Status.FORBIDDEN.getStatusCode())
.withErrorCode(MCRErrorCodeConstants.MCRDERIVATE_NO_PERMISSION)
.withMessage("You may not update MCRDerivate " + derivate.getId() + ".")
.withDetail(e.getMessage())
.withCause(e)
.toException();
}
}
return Response.noContent().build();
}

@PUT
@Path("/{" + PARAM_DERID + "}/try")
@Operation(summary = "pre-flight target to test write operation on {" + PARAM_DERID + "}",
Expand Down
1 change: 1 addition & 0 deletions mycore-restapi/src/main/java/org/mycore/restapi/v2/access/MCRRestAPIACLPermission.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ public static MCRRestAPIACLPermission fromMethod(final String method) {
return DELETE;
case HttpMethod.POST:
case HttpMethod.PUT:
case HttpMethod.PATCH:
return WRITE;
default:
return null;
Expand Down