Add an option to save the request or response body (#138)

yoavst · cortinico · vbuberen · commit 55623e38d9cf · 2020-01-04T10:42:18.000+02:00
* Add an option to save the request or response body
* Hide the save button on API &lt; 19
* Hide save icon if body is empty

Co-authored-by: Nicola Corti &lt;corti.nico@gmail.com&gt;
diff --git a/detekt-config.yml b/detekt-config.yml
@@ -8,6 +8,9 @@ build:
 
 complexity:
   active: true
+  ComplexMethod:
+    active: true
+    threshold: 16
   ComplexCondition:
     active: true
     threshold: 5
diff --git a/library/src/main/java/com/chuckerteam/chucker/api/ChuckerInterceptor.kt b/library/src/main/java/com/chuckerteam/chucker/api/ChuckerInterceptor.kt
@@ -45,7 +45,7 @@ class ChuckerInterceptor @JvmOverloads constructor(
     }
 
     @Throws(IOException::class)
-    @Suppress("LongMethod", "ComplexMethod")
+    @Suppress("LongMethod")
     override fun intercept(chain: Interceptor.Chain): Response {
         val request = chain.request()
         val requestBody = request.body()
diff --git a/library/src/main/java/com/chuckerteam/chucker/internal/ui/transaction/TransactionOverviewFragment.kt b/library/src/main/java/com/chuckerteam/chucker/internal/ui/transaction/TransactionOverviewFragment.kt
@@ -17,6 +17,8 @@ package com.chuckerteam.chucker.internal.ui.transaction
 
 import android.os.Bundle
 import android.view.LayoutInflater
+import android.view.Menu
+import android.view.MenuInflater
 import android.view.View
 import android.view.ViewGroup
 import android.widget.TextView
@@ -43,6 +45,7 @@ class TransactionOverviewFragment : Fragment() {
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
+        setHasOptionsMenu(true)
         viewModel = ViewModelProviders.of(requireActivity())[TransactionViewModel::class.java]
     }
 
@@ -67,6 +70,13 @@ class TransactionOverviewFragment : Fragment() {
                 totalSize = it.findViewById(R.id.total_size)
             }
 
+    override fun onCreateOptionsMenu(menu: Menu, inflater: MenuInflater) {
+        val saveMenuItem = menu.findItem(R.id.save_body)
+        saveMenuItem.isVisible = false
+
+        super.onCreateOptionsMenu(menu, inflater)
+    }
+
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
         super.onViewCreated(view, savedInstanceState)
         viewModel.transaction.observe(
diff --git a/library/src/main/java/com/chuckerteam/chucker/internal/ui/transaction/TransactionPayloadFragment.kt b/library/src/main/java/com/chuckerteam/chucker/internal/ui/transaction/TransactionPayloadFragment.kt
@@ -15,10 +15,15 @@
  */
 package com.chuckerteam.chucker.internal.ui.transaction
 
+import android.annotation.SuppressLint
+import android.app.Activity
 import android.content.Context
+import android.content.Intent
 import android.graphics.Bitmap
 import android.graphics.Color
+import android.net.Uri
 import android.os.AsyncTask
+import android.os.Build
 import android.os.Bundle
 import android.view.LayoutInflater
 import android.view.Menu
@@ -27,6 +32,8 @@ import android.view.View
 import android.view.ViewGroup
 import android.widget.ImageView
 import android.widget.TextView
+import android.widget.Toast
+import androidx.annotation.RequiresApi
 import androidx.appcompat.widget.SearchView
 import androidx.core.content.ContextCompat
 import androidx.core.text.HtmlCompat
@@ -36,6 +43,11 @@ import androidx.lifecycle.ViewModelProviders
 import com.chuckerteam.chucker.R
 import com.chuckerteam.chucker.internal.data.entity.HttpTransaction
 import com.chuckerteam.chucker.internal.support.highlightWithDefinedColors
+import java.io.FileNotFoundException
+import java.io.FileOutputStream
+import java.io.IOException
+
+private const val GET_FILE_FOR_SAVING_REQUEST_CODE: Int = 43
 
 internal class TransactionPayloadFragment :
     Fragment(), SearchView.OnQueryTextListener {
@@ -51,6 +63,7 @@ internal class TransactionPayloadFragment :
     private lateinit var viewModel: TransactionViewModel
     private var originalBody: String? = null
     private var uiLoaderTask: UiLoaderTask? = null
+    private var fileSaverTask: FileSaverTask? = null
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
@@ -83,15 +96,38 @@ internal class TransactionPayloadFragment :
     override fun onDestroyView() {
         super.onDestroyView()
         uiLoaderTask?.cancel(true)
+        fileSaverTask?.cancel(true)
     }
 
+    @SuppressLint("NewApi")
     override fun onCreateOptionsMenu(menu: Menu, inflater: MenuInflater) {
-        if ((type == TYPE_RESPONSE || type == TYPE_REQUEST) && body.text.isNotEmpty()) {
-            val searchMenuItem = menu.findItem(R.id.search)
-            searchMenuItem.isVisible = true
-            val searchView = searchMenuItem.actionView as SearchView
-            searchView.setOnQueryTextListener(this)
-            searchView.setIconifiedByDefault(true)
+        if ((type == TYPE_RESPONSE || type == TYPE_REQUEST)) {
+            if (body.text.isNotEmpty()) {
+                val searchMenuItem = menu.findItem(R.id.search)
+                searchMenuItem.isVisible = true
+                val searchView = searchMenuItem.actionView as SearchView
+                searchView.setOnQueryTextListener(this)
+                searchView.setIconifiedByDefault(true)
+            }
+
+            val transaction = viewModel.transaction.value
+            val showSaveMenuItem = when {
+                // SAF is not available on pre-Kit Kat so let's hide the icon.
+                (Build.VERSION.SDK_INT < Build.VERSION_CODES.KITKAT) -> false
+                (type == TYPE_REQUEST && 0L == (transaction?.requestContentLength ?: 0L)) -> false
+                (type == TYPE_RESPONSE && 0L == (transaction?.responseContentLength ?: 0L)) -> false
+                else -> true
+            }
+
+            if (showSaveMenuItem) {
+                menu.findItem(R.id.save_body).apply {
+                    isVisible = true
+                    setOnMenuItemClickListener {
+                        viewBodyExternally()
+                        true
+                    }
+                }
+            }
         }
 
         super.onCreateOptionsMenu(menu, inflater)
@@ -104,6 +140,7 @@ internal class TransactionPayloadFragment :
     }
 
     private fun setBody(headersString: String, bodyString: String?, isPlainText: Boolean, image: Bitmap?) {
+        uiLoaderTask = null
         headers.visibility = if (headersString.isEmpty()) View.GONE else View.VISIBLE
         headers.text = HtmlCompat.fromHtml(headersString, HtmlCompat.FROM_HTML_MODE_LEGACY)
         val isImageData = image != null
@@ -122,6 +159,38 @@ internal class TransactionPayloadFragment :
         activity?.invalidateOptionsMenu()
     }
 
+    @RequiresApi(Build.VERSION_CODES.KITKAT)
+    @SuppressLint("DefaultLocale")
+    private fun viewBodyExternally() {
+        viewModel.transaction.value?.let {
+            val intent = Intent(Intent.ACTION_CREATE_DOCUMENT).apply {
+                addCategory(Intent.CATEGORY_OPENABLE)
+                putExtra(Intent.EXTRA_TITLE, "$DEFAULT_FILE_PREFIX${System.currentTimeMillis()}")
+                type = "*/*"
+            }
+            if (intent.resolveActivity(requireActivity().packageManager) != null) {
+                startActivityForResult(intent, GET_FILE_FOR_SAVING_REQUEST_CODE)
+            } else {
+                Toast.makeText(
+                    requireContext(), R.string.chucker_save_failed_to_open_document,
+                    Toast.LENGTH_SHORT
+                ).show()
+            }
+        }
+    }
+
+    override fun onActivityResult(requestCode: Int, resultCode: Int, resultData: Intent?) {
+        if (requestCode == GET_FILE_FOR_SAVING_REQUEST_CODE && resultCode == Activity.RESULT_OK) {
+            val uri = resultData?.data
+            val transaction = viewModel.transaction.value
+            if (uri != null && transaction != null) {
+                fileSaverTask = FileSaverTask(this).apply {
+                    execute(Triple(type, uri, transaction))
+                }
+            }
+        }
+    }
+
     override fun onQueryTextSubmit(query: String): Boolean = false
 
     override fun onQueryTextChange(newText: String): Boolean {
@@ -158,6 +227,50 @@ internal class TransactionPayloadFragment :
         }
     }
 
+    private class FileSaverTask(val fragment: TransactionPayloadFragment) :
+        AsyncTask<Triple<Int, Uri, HttpTransaction>, Unit, Boolean>() {
+
+        @Suppress("NestedBlockDepth")
+        override fun doInBackground(vararg params: Triple<Int, Uri, HttpTransaction>): Boolean {
+            val (type, uri, transaction) = params[0]
+            try {
+                val context = fragment.context ?: return false
+                context.contentResolver.openFileDescriptor(uri, "w")?.use {
+                    FileOutputStream(it.fileDescriptor).use { fos ->
+                        when {
+                            type == TYPE_REQUEST -> {
+                                transaction.requestBody?.byteInputStream()?.copyTo(fos)
+                            }
+                            transaction.responseBody != null -> {
+                                transaction.responseBody?.byteInputStream()?.copyTo(fos)
+                            }
+                            else -> {
+                                fos.write(transaction.responseImageData)
+                            }
+                        }
+                    }
+                }
+            } catch (e: FileNotFoundException) {
+                e.printStackTrace()
+                return false
+            } catch (e: IOException) {
+                e.printStackTrace()
+                return false
+            }
+            return true
+        }
+
+        override fun onPostExecute(isSuccessful: Boolean) {
+            fragment.fileSaverTask = null
+            val toastMessageId = if (isSuccessful) {
+                R.string.chucker_file_saved
+            } else {
+                R.string.chucker_file_not_saved
+            }
+            Toast.makeText(fragment.context, toastMessageId, Toast.LENGTH_SHORT).show()
+        }
+    }
+
     private data class UiPayload(
         val headersString: String,
         val bodyString: String?,
@@ -171,6 +284,8 @@ internal class TransactionPayloadFragment :
         const val TYPE_REQUEST = 0
         const val TYPE_RESPONSE = 1
 
+        const val DEFAULT_FILE_PREFIX = "chucker-export-"
+
         fun newInstance(type: Int): TransactionPayloadFragment =
             TransactionPayloadFragment().apply {
                 arguments = Bundle().apply {
diff --git a/library/src/main/res/drawable/chucker_ic_save_white_24dp.xml b/library/src/main/res/drawable/chucker_ic_save_white_24dp.xml
@@ -0,0 +1,9 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24">
+    <path
+        android:fillColor="#FFFFFFFF"
+        android:pathData="M15,9H5V5H15M12,19A3,3 0 0,1 9,16A3,3 0 0,1 12,13A3,3 0 0,1 15,16A3,3 0 0,1 12,19M17,3H5C3.89,3 3,3.9 3,5V19A2,2 0 0,0 5,21H19A2,2 0 0,0 21,19V7L17,3Z" />
+</vector>
diff --git a/library/src/main/res/menu/chucker_transaction.xml b/library/src/main/res/menu/chucker_transaction.xml
@@ -38,4 +38,11 @@
             </group>
         </menu>
     </item>
+    <item
+        android:icon="@drawable/chucker_ic_save_white_24dp"
+        android:title="@string/chucker_save"
+        android:id="@+id/save_body"
+        android:visible="false"
+        app:showAsAction="always">
+    </item>
 </menu>
diff --git a/library/src/main/res/values/strings.xml b/library/src/main/res/values/strings.xml
@@ -38,6 +38,10 @@
     <string name="chucker_share">Share</string>
     <string name="chucker_share_as_text">Share as text</string>
     <string name="chucker_share_as_curl">Share as curl command</string>
+    <string name="chucker_save">Save body to file</string>
+    <string name="chucker_save_failed_to_open_document">Failed to open file chooser</string>
+    <string name="chucker_file_saved">File was saved successfully!</string>
+    <string name="chucker_file_not_saved">Failed to save file</string>
     <string name="chucker_body_omitted">(encoded or binary body omitted)</string>
     <string name="chucker_search">Search</string>
     <string name="chucker_body_unexpected_eof">\n\n--- Unexpected end of content ---</string>

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ class ChuckerInterceptor @JvmOverloads constructor(`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`@Throws(IOException::class)`
`48`		`- @Suppress("LongMethod", "ComplexMethod")`
	`48`	`+ @Suppress("LongMethod")`
`49`	`49`	`override fun intercept(chain: Interceptor.Chain): Response {`
`50`	`50`	`val request = chain.request()`
`51`	`51`	`val requestBody = request.body()`