Skip to content

Commit

Permalink
Add better logging when resources are deleted to make it clear what m…
Browse files Browse the repository at this point in the history 
…etadata record the resource was deleted from. (geonetwork#8445)

Also renamed "MetadataResource" in the message to be "Metadata resource"

Co-authored-by: Ian Allen <[email protected]>
  • Loading branch information
@geonetworkbuild @ianwallen
geonetworkbuild and ianwallen authored Oct 16, 2024
1 parent ba82449 commit 283c166
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 33 deletions.
16 changes: 6 additions & 10 deletions core/src/main/java/org/fao/geonet/api/records/attachments/CMISStore.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -424,13 +424,9 @@ public String delResource(final ServiceContext context, final String metadataUui

for (MetadataResourceVisibility visibility : MetadataResourceVisibility.values()) {
if (tryDelResource(context, metadataUuid, metadataId, visibility, resourceId)) {
Log.info(Geonet.RESOURCES,
String.format("MetadataResource '%s' removed.", resourceId));
return String.format("MetadataResource '%s' removed.", resourceId);
return String.format("Metadata resource '%s' removed.", resourceId);
}
}
Log.info(Geonet.RESOURCES,
String.format("Unable to remove resource '%s'.", resourceId));
return String.format("Unable to remove resource '%s'.", resourceId);
}

Expand All @@ -439,12 +435,8 @@ public String delResource(final ServiceContext context, final String metadataUui
final String resourceId, Boolean approved) throws Exception {
int metadataId = canEdit(context, metadataUuid, approved);
if (tryDelResource(context, metadataUuid, metadataId, visibility, resourceId)) {
Log.info(Geonet.RESOURCES,
String.format("MetadataResource '%s' removed.", resourceId));
return String.format("MetadataResource '%s' removed.", resourceId);
return String.format("Metadata resource '%s' removed.", resourceId);
}
Log.info(Geonet.RESOURCES,
String.format("Unable to remove resource '%s'.", resourceId));
return String.format("Unable to remove resource '%s'.", resourceId);
}

Expand All @@ -459,6 +451,8 @@ protected boolean tryDelResource(final ServiceContext context, final String meta
try {
final CmisObject object = cmisConfiguration.getClient().getObjectByPath(key, oc);
object.delete();
Log.info(Geonet.RESOURCES,
String.format("Resource '%s' removed for metadata %d (%s).", resourceId, metadataId, metadataUuid));
if (object instanceof Folder) {
cmisUtils.invalidateFolderCacheItem(key);
}
Expand All @@ -467,6 +461,8 @@ protected boolean tryDelResource(final ServiceContext context, final String meta
//CmisPermissionDeniedException when user does not have permissions.
//CmisConstraintException when there is a lock on the file from a checkout.
} catch (CmisObjectNotFoundException | CmisPermissionDeniedException | CmisConstraintException e) {
Log.info(Geonet.RESOURCES,
String.format("Unable to remove resource '%s' for metadata %d (%s). %s", resourceId, metadataId, metadataUuid, e.getMessage()));
return false;
}
}
Expand Down
22 changes: 16 additions & 6 deletions core/src/main/java/org/fao/geonet/api/records/attachments/FilesystemStore.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -234,33 +234,43 @@ public String delResources(ServiceContext context, int metadataId) throws Except
try {
Log.info(Geonet.RESOURCES, String.format("Deleting all files from metadataId '%d'", metadataId));
IO.deleteFileOrDirectory(metadataDir, true);
return String.format("Metadata '%s' directory removed.", metadataId);
Log.info(Geonet.RESOURCES,
String.format("Metadata '%d' directory removed.", metadataId));
return String.format("Metadata '%d' directory removed.", metadataId);
} catch (Exception e) {
return String.format("Unable to remove metadata '%s' directory.", metadataId);
return String.format("Unable to remove metadata '%d' directory.", metadataId);
}
}

@Override
public String delResource(ServiceContext context, String metadataUuid, String resourceId, Boolean approved) throws Exception {
canEdit(context, metadataUuid, approved);
int metadataId = canEdit(context, metadataUuid, approved);

try (ResourceHolder filePath = getResource(context, metadataUuid, resourceId, approved)) {
Files.deleteIfExists(filePath.getPath());
return String.format("MetadataResource '%s' removed.", resourceId);
Log.info(Geonet.RESOURCES,
String.format("Resource '%s' removed for metadata %d (%s).", resourceId, metadataId, metadataUuid));
return String.format("Metadata resource '%s' removed.", resourceId);
} catch (IOException e) {
Log.warning(Geonet.RESOURCES,
String.format("Unable to remove resource '%s' for metadata %d (%s). %s", resourceId, metadataId, metadataUuid, e.getMessage()));
return String.format("Unable to remove resource '%s'.", resourceId);
}
}

@Override
public String delResource(final ServiceContext context, final String metadataUuid, final MetadataResourceVisibility visibility,
final String resourceId, Boolean approved) throws Exception {
canEdit(context, metadataUuid, approved);
int metadataId = canEdit(context, metadataUuid, approved);

try (ResourceHolder filePath = getResource(context, metadataUuid, visibility, resourceId, approved)) {
Files.deleteIfExists(filePath.getPath());
return String.format("MetadataResource '%s' removed.", resourceId);
Log.info(Geonet.RESOURCES,
String.format("Resource '%s' removed for metadata %d (%s).", resourceId, metadataId, metadataUuid));
return String.format("Metadata resource '%s' removed.", resourceId);
} catch (IOException e) {
Log.warning(Geonet.RESOURCES,
String.format("Unable to remove resource '%s' for metadata %d (%s). %s", resourceId, metadataId, metadataUuid, e.getMessage()));
return String.format("Unable to remove resource '%s'.", resourceId);
}
}
Expand Down
24 changes: 11 additions & 13 deletions core/src/main/java/org/fao/geonet/api/records/attachments/JCloudStore.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -356,11 +356,13 @@ public String delResources(final ServiceContext context, final int metadataId) t
}
marker = page.getNextMarker();
} while (marker != null);
return String.format("Metadata '%s' directory removed.", metadataId);
Log.info(Geonet.RESOURCES,
String.format("Metadata '%d' directory removed.", metadataId));
return String.format("Metadata '%d' directory removed.", metadataId);
} catch (ContainerNotFoundException e) {
Log.warning(Geonet.RESOURCES,
String.format("Unable to located metadata '%s' directory to be removed.", metadataId));
return String.format("Unable to located metadata '%s' directory to be removed.", metadataId);
String.format("Unable to located metadata '%d' directory to be removed.", metadataId));
return String.format("Unable to located metadata '%d' directory to be removed.", metadataId);
}
}

Expand All @@ -371,13 +373,9 @@ public String delResource(final ServiceContext context, final String metadataUui

for (MetadataResourceVisibility visibility : MetadataResourceVisibility.values()) {
if (tryDelResource(context, metadataUuid, metadataId, visibility, resourceId)) {
Log.info(Geonet.RESOURCES,
String.format("MetadataResource '%s' removed.", resourceId));
return String.format("MetadataResource '%s' removed.", resourceId);
return String.format("Metadata resource '%s' removed.", resourceId);
}
}
Log.info(Geonet.RESOURCES,
String.format("Unable to remove resource '%s'.", resourceId));
return String.format("Unable to remove resource '%s'.", resourceId);
}

Expand All @@ -386,12 +384,8 @@ public String delResource(final ServiceContext context, final String metadataUui
final String resourceId, Boolean approved) throws Exception {
int metadataId = canEdit(context, metadataUuid, approved);
if (tryDelResource(context, metadataUuid, metadataId, visibility, resourceId)) {
Log.info(Geonet.RESOURCES,
String.format("MetadataResource '%s' removed.", resourceId));
return String.format("MetadataResource '%s' removed.", resourceId);
return String.format("Metadata resource '%s' removed.", resourceId);
}
Log.info(Geonet.RESOURCES,
String.format("Unable to remove resource '%s'.", resourceId));
return String.format("Unable to remove resource '%s'.", resourceId);
}

Expand All @@ -401,8 +395,12 @@ protected boolean tryDelResource(final ServiceContext context, final String meta

if (jCloudConfiguration.getClient().getBlobStore().blobExists(jCloudConfiguration.getContainerName(), key)) {
jCloudConfiguration.getClient().getBlobStore().removeBlob(jCloudConfiguration.getContainerName(), key);
Log.info(Geonet.RESOURCES,
String.format("Resource '%s' removed for metadata %d (%s).", resourceId, metadataId, metadataUuid));
return true;
}
Log.info(Geonet.RESOURCES,
String.format("Unable to remove resource '%s' for metadata %d (%s).", resourceId, metadataId, metadataUuid));
return false;
}

Expand Down
16 changes: 12 additions & 4 deletions core/src/main/java/org/fao/geonet/api/records/attachments/S3Store.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -193,9 +193,13 @@ public String delResources(final ServiceContext context, final int metadataId) t
for (S3ObjectSummary object: objects.getObjectSummaries()) {
s3.getClient().deleteObject(s3.getBucket(), object.getKey());
}
return String.format("Metadata '%s' directory removed.", metadataId);
Log.info(Geonet.RESOURCES,
String.format("Metadata '%d' directory removed.", metadataId));
return String.format("Metadata '%d' directory removed.", metadataId);
} catch (AmazonServiceException e) {
return String.format("Unable to remove metadata '%s' directory.", metadataId);
Log.warning(Geonet.RESOURCES,
String.format("Unable to remove metadata '%d' directory. %s", metadataId, e.getMessage()));
return String.format("Unable to remove metadata '%d' directory.", metadataId);
}
}

Expand All @@ -206,7 +210,7 @@ public String delResource(final ServiceContext context, final String metadataUui

for (MetadataResourceVisibility visibility: MetadataResourceVisibility.values()) {
if (tryDelResource(metadataUuid, metadataId, visibility, resourceId)) {
return String.format("MetadataResource '%s' removed.", resourceId);
return String.format("Metadata resource '%s' removed.", resourceId);
}
}
return String.format("Unable to remove resource '%s'.", resourceId);
Expand All @@ -217,7 +221,7 @@ public String delResource(final ServiceContext context, final String metadataUui
final String resourceId, Boolean approved) throws Exception {
int metadataId = canEdit(context, metadataUuid, approved);
if (tryDelResource(metadataUuid, metadataId, visibility, resourceId)) {
return String.format("MetadataResource '%s' removed.", resourceId);
return String.format("Metadata resource '%s' removed.", resourceId);
}
return String.format("Unable to remove resource '%s'.", resourceId);
}
Expand All @@ -227,8 +231,12 @@ private boolean tryDelResource(final String metadataUuid, final int metadataId,
final String key = getKey(metadataUuid, metadataId, visibility, resourceId);
if (s3.getClient().doesObjectExist(s3.getBucket(), key)) {
s3.getClient().deleteObject(s3.getBucket(), key);
Log.info(Geonet.RESOURCES,
String.format("Resource '%s' removed for metadata %d (%s).", resourceId, metadataId, metadataUuid));
return true;
}
Log.info(Geonet.RESOURCES,
String.format("Unable to remove resource '%s' for metadata %d (%s).", resourceId, metadataId, metadataUuid));
return false;
}

Expand Down

0 comments on commit 283c166

Please sign in to comment.