Determine if a body is loggable based on its content-type

Author: abelgardep

owncloudComLibrary/src/main/java/com/owncloud/android/lib/common/http/HttpConstants.java

@@ -51,6 +51,14 @@ public class HttpConstants {
     public static final String ACCEPT_ENCODING_IDENTITY = "identity";
     public static final String OC_FILE_REMOTE_ID = "OC-FileId";
 
+    /***********************************************************************************************************
+     ************************************************ CONTENT TYPES ********************************************
+     ***********************************************************************************************************/
+
+    public static final String CONTENT_TYPE_XML = "application/xml";
+    public static final String CONTENT_TYPE_JSON = "application/json";
+    public static final String CONTENT_TYPE_WWW_FORM = "application/x-www-form-urlencoded";
+
     /***********************************************************************************************************
      ************************************************ STATUS CODES *********************************************
      ***********************************************************************************************************/

owncloudComLibrary/src/main/java/com/owncloud/android/lib/common/http/LogBuilder.kt

@@ -22,6 +22,10 @@
  */
 package com.owncloud.android.lib.common.http
 
+import com.owncloud.android.lib.common.http.HttpConstants.CONTENT_TYPE_JSON
+import com.owncloud.android.lib.common.http.HttpConstants.CONTENT_TYPE_WWW_FORM
+import com.owncloud.android.lib.common.http.HttpConstants.CONTENT_TYPE_XML
+import okhttp3.MediaType
 import timber.log.Timber
 import java.util.Locale
 
@@ -45,3 +49,17 @@ enum class NetworkNode {
 
     override fun toString(): String = super.toString().toLowerCase(Locale.ROOT)
 }
+
+/**
+ * Check whether a media type is loggable.
+ *
+ * @return true if its type is text, xml, json, or x-www-form-urlencoded.
+ */
+fun MediaType?.isLoggable(): Boolean =
+    this?.let { mediaType ->
+        val mediaTypeString = mediaType.toString()
+        (mediaType.type == "text" ||
+                mediaTypeString.contains(CONTENT_TYPE_XML) ||
+                mediaTypeString.contains(CONTENT_TYPE_JSON) ||
+                mediaTypeString.contains(CONTENT_TYPE_WWW_FORM))
+    } ?: false

owncloudComLibrary/src/main/java/com/owncloud/android/lib/common/http/LogInterceptor.kt

@@ -99,7 +99,7 @@ class LogInterceptor : Interceptor {
             logHttp(REQUEST, BODY, requestId, "Type: ${requestBody.contentType()}")
             logHttp(REQUEST, BODY, requestId, "--> Body start for request")
 
-            if (buffer.isProbablyUtf8()) {
+            if (contentType.isLoggable()) {
                 if (requestBody.contentLength() < LIMIT_BODY_LOG) {
                     logHttp(REQUEST, BODY, requestId, buffer.readString(charset))
                 } else {
@@ -137,26 +137,32 @@ class LogInterceptor : Interceptor {
             source.request(LIMIT_BODY_LOG)
             val buffer = source.buffer
 
-            if (!buffer.isProbablyUtf8()) {
+            if (contentType.isLoggable()) {
+
+                if (responseBody.contentLength() < LIMIT_BODY_LOG) {
+                    logHttp(RESPONSE, BODY, requestId, buffer.clone().readString(charset))
+                } else {
+                    logHttp(RESPONSE, BODY, requestId, buffer.clone().readString(LIMIT_BODY_LOG, charset))
+                }
                 logHttp(
                     RESPONSE,
                     BODY,
                     requestId,
-                    "<-- Body end for response -- Binary -- Omitted: ${responseBody.contentLength()} bytes"
+                    "<-- Body end for response -- Omitted: ${
+                        max(
+                            0,
+                            responseBody.contentLength() - LIMIT_BODY_LOG
+                        )
+                    } bytes"
                 )
-            }
-
-            if (responseBody.contentLength() < LIMIT_BODY_LOG) {
-                logHttp(RESPONSE, BODY, requestId, buffer.clone().readString(charset))
             } else {
-                logHttp(RESPONSE, BODY, requestId, buffer.clone().readString(LIMIT_BODY_LOG, charset))
+                logHttp(
+                    RESPONSE,
+                    BODY,
+                    requestId,
+                    "<-- Body end for response -- Binary -- Omitted: ${responseBody.contentLength()} bytes"
+                )
             }
-            logHttp(
-                RESPONSE,
-                BODY,
-                requestId,
-                "<-- Body end for response -- Omitted: ${max(0, responseBody.contentLength() - LIMIT_BODY_LOG)} bytes"
-            )
         } ?: logHttp(RESPONSE, BODY, requestId, "Empty body")
     }