Decode values in object listing if encoding is set (#1183)

Author: balamurugana

api/src/main/java/io/minio/messages/ListBucketResultV1.java

@@ -39,11 +39,11 @@ public class ListBucketResultV1 extends ListObjectsResult {
   private List<Contents> contents;
 
   public String marker() {
-    return marker;
+    return decodeIfNeeded(marker);
   }
 
   public String nextMarker() {
-    return nextMarker;
+    return decodeIfNeeded(nextMarker);
   }
 
   @Override

api/src/main/java/io/minio/messages/ListBucketResultV2.java

@@ -52,7 +52,7 @@ public int keyCount() {
 
   /** Returns start after. */
   public String startAfter() {
-    return startAfter;
+    return decodeIfNeeded(startAfter);
   }
 
   /** Returns continuation token. */

api/src/main/java/io/minio/messages/ListMultipartUploadsResult.java

@@ -16,6 +16,9 @@
 
 package io.minio.messages;
 
+import java.io.UnsupportedEncodingException;
+import java.net.URLDecoder;
+import java.nio.charset.StandardCharsets;
 import java.util.Collections;
 import java.util.LinkedList;
 import java.util.List;
@@ -35,6 +38,9 @@ public class ListMultipartUploadsResult {
   @Element(name = "Bucket")
   private String bucketName;
 
+  @Element(name = "EncodingType", required = false)
+  private String encodingType;
+
   @Element(name = "KeyMarker", required = false)
   private String keyMarker;
 
@@ -58,6 +64,17 @@ public class ListMultipartUploadsResult {
 
   public ListMultipartUploadsResult() {}
 
+  private String decodeIfNeeded(String value) {
+    try {
+      return (value != null && "url".equals(encodingType))
+          ? URLDecoder.decode(value, StandardCharsets.UTF_8.name())
+          : value;
+    } catch (UnsupportedEncodingException e) {
+      // This never happens as 'enc' name comes from JDK's own StandardCharsets.
+      throw new RuntimeException(e);
+    }
+  }
+
   /** Returns whether the result is truncated or not. */
   public boolean isTruncated() {
     return isTruncated;
@@ -70,7 +87,7 @@ public String bucketName() {
 
   /** Returns key marker. */
   public String keyMarker() {
-    return keyMarker;
+    return decodeIfNeeded(keyMarker);
   }
 
   /** Returns upload ID marker. */
@@ -80,7 +97,7 @@ public String uploadIdMarker() {
 
   /** Returns next key marker. */
   public String nextKeyMarker() {
-    return nextKeyMarker;
+    return decodeIfNeeded(nextKeyMarker);
   }
 
   /** Returns next upload ID marker. */
@@ -93,6 +110,10 @@ public int maxUploads() {
     return maxUploads;
   }
 
+  public String encodingType() {
+    return encodingType;
+  }
+
   /** Returns List of Upload. */
   public List<Upload> uploads() {
     if (uploads == null) {

api/src/main/java/io/minio/messages/ListObjectsResult.java

@@ -17,6 +17,9 @@
 package io.minio.messages;
 
 import com.google.common.base.MoreObjects;
+import java.io.UnsupportedEncodingException;
+import java.net.URLDecoder;
+import java.nio.charset.StandardCharsets;
 import java.util.Collections;
 import java.util.LinkedList;
 import java.util.List;
@@ -54,6 +57,17 @@ public abstract class ListObjectsResult {
 
   public ListObjectsResult() {}
 
+  protected String decodeIfNeeded(String value) {
+    try {
+      return (value != null && "url".equals(encodingType))
+          ? URLDecoder.decode(value, StandardCharsets.UTF_8.name())
+          : value;
+    } catch (UnsupportedEncodingException e) {
+      // This never happens as 'enc' name comes from JDK's own StandardCharsets.
+      throw new RuntimeException(e);
+    }
+  }
+
   /** Returns bucket name. */
   public String name() {
     return name;
@@ -65,7 +79,7 @@ public String encodingType() {
 
   /** Returns prefix. */
   public String prefix() {
-    return prefix;
+    return decodeIfNeeded(prefix);
   }
 
   /** Returns delimiter. */

api/src/main/java/io/minio/messages/ListVersionsResult.java

@@ -49,11 +49,11 @@ public class ListVersionsResult extends ListObjectsResult {
   private List<DeleteMarker> deleteMarkers;
 
   public String keyMarker() {
-    return keyMarker;
+    return decodeIfNeeded(keyMarker);
   }
 
   public String nextKeyMarker() {
-    return nextKeyMarker;
+    return decodeIfNeeded(nextKeyMarker);
   }
 
   public String versionIdMarker() {

api/src/main/java/io/minio/messages/Upload.java

@@ -16,6 +16,9 @@
 
 package io.minio.messages;
 
+import java.io.UnsupportedEncodingException;
+import java.net.URLDecoder;
+import java.nio.charset.StandardCharsets;
 import java.time.ZonedDateTime;
 import org.simpleframework.xml.Element;
 import org.simpleframework.xml.Namespace;
@@ -47,12 +50,20 @@ public class Upload {
   private ResponseDate initiated;
 
   private long aggregatedPartSize;
+  private String encodingType = null;
 
   public Upload() {}
 
   /** Returns object name. */
   public String objectName() {
-    return objectName;
+    try {
+      return "url".equals(encodingType)
+          ? URLDecoder.decode(objectName, StandardCharsets.UTF_8.name())
+          : objectName;
+    } catch (UnsupportedEncodingException e) {
+      // This never happens as 'enc' name comes from JDK's own StandardCharsets.
+      throw new RuntimeException(e);
+    }
   }
 
   /** Returns upload ID. */
@@ -89,4 +100,8 @@ public long aggregatedPartSize() {
   public void setAggregatedPartSize(long size) {
     this.aggregatedPartSize = size;
   }
+
+  public void setEncodingType(String encodingType) {
+    this.encodingType = encodingType;
+  }
 }