Merge pull request #430 from owncloud/feature/parse_shares

[FEATURE REQUEST] Use Moshi to parse shares

Author: abelgardep

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

@@ -66,6 +66,18 @@ public class HttpConstants {
     public static final String CONTENT_TYPE_JSON = "application/json";
     public static final String CONTENT_TYPE_WWW_FORM = "application/x-www-form-urlencoded";
 
+    /***********************************************************************************************************
+     ************************************************ ARGUMENTS NAMES ********************************************
+     ***********************************************************************************************************/
+
+    public static final String PARAM_FORMAT = "format";
+
+    /***********************************************************************************************************
+     ************************************************ ARGUMENTS VALUES ********************************************
+     ***********************************************************************************************************/
+
+    public static final String VALUE_FORMAT = "json";
+
     /***********************************************************************************************************
      ************************************************ STATUS CODES *********************************************
      ***********************************************************************************************************/
@@ -205,4 +217,4 @@ public class HttpConstants {
      * Default timeout for establishing a connection
      */
     public static final int DEFAULT_CONNECTION_TIMEOUT = 60000;
-}
+}

owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/shares/CreateRemoteShareOperation.kt

@@ -2,7 +2,8 @@
  *   @author masensio
  *   @author David A. Velasco
  *   @author David González Verdugo
- *   Copyright (C) 2020 ownCloud GmbH
+ *   @author Fernando Sanz Velasco
+ *   Copyright (C) 2021 ownCloud GmbH
  *
  *   Permission is hereby granted, free of charge, to any person obtaining a copy
  *   of this software and associated documentation files (the "Software"), to deal
@@ -27,14 +28,23 @@
 
 package com.owncloud.android.lib.resources.shares
 
+import android.net.Uri
 import com.owncloud.android.lib.common.OwnCloudClient
 import com.owncloud.android.lib.common.http.HttpConstants
+import com.owncloud.android.lib.common.http.HttpConstants.PARAM_FORMAT
+import com.owncloud.android.lib.common.http.HttpConstants.VALUE_FORMAT
 import com.owncloud.android.lib.common.http.methods.nonwebdav.PostMethod
 import com.owncloud.android.lib.common.operations.RemoteOperation
 import com.owncloud.android.lib.common.operations.RemoteOperationResult
+import com.owncloud.android.lib.resources.CommonOcsResponse
 import com.owncloud.android.lib.resources.shares.RemoteShare.Companion.INIT_EXPIRATION_DATE_IN_MILLIS
+import com.owncloud.android.lib.resources.shares.responses.ShareItem
+import com.squareup.moshi.JsonAdapter
+import com.squareup.moshi.Moshi
+import com.squareup.moshi.Types
 import okhttp3.FormBody
 import timber.log.Timber
+import java.lang.reflect.Type
 import java.net.URL
 import java.text.SimpleDateFormat
 import java.util.Calendar
@@ -46,6 +56,7 @@ import java.util.Locale
  * @author masensio
  * @author David A. Velasco
  * @author David González Verdugo
+ * @author Fernando Sanz Velasco
  */
 
 /**
@@ -70,7 +81,8 @@ class CreateRemoteShareOperation(
     private val shareType: ShareType,
     private val shareWith: String,
     private val permissions: Int
-) : RemoteOperation<ShareParserResult>() {
+) : RemoteOperation<ShareResponse>() {
+
     var name = "" // Name to set for the public link
 
     var password: String = "" // Password to set for the public link
@@ -81,90 +93,125 @@ class CreateRemoteShareOperation(
 
     var retrieveShareDetails = false // To retrieve more info about the just created share
 
-    override fun run(client: OwnCloudClient): RemoteOperationResult<ShareParserResult> {
-        var result: RemoteOperationResult<ShareParserResult>
+    private fun buildRequestUri(baseUri: Uri) =
+        baseUri.buildUpon()
+            .appendEncodedPath(OCS_ROUTE)
+            .appendQueryParameter(PARAM_FORMAT, VALUE_FORMAT)
+            .build()
+
+    private fun parseResponse(response: String): ShareResponse? {
+        val moshi = Moshi.Builder().build()
+        val commonOcsType: Type = Types.newParameterizedType(CommonOcsResponse::class.java, ShareItem::class.java)
+        val adapter: JsonAdapter<CommonOcsResponse<ShareItem>> = moshi.adapter(commonOcsType)
+        val remoteShare = adapter.fromJson(response)?.ocs?.data?.toRemoteShare()
+        return ShareResponse(remoteShare?.let { listOf(it) } ?: listOf())
+    }
 
-        try {
-            val formBodyBuilder = FormBody.Builder()
-                .add(PARAM_PATH, remoteFilePath)
-                .add(PARAM_SHARE_TYPE, shareType.value.toString())
-                .add(PARAM_SHARE_WITH, shareWith)
+    private fun onResultUnsuccessful(
+        method: PostMethod,
+        response: String?,
+        status: Int
+    ): RemoteOperationResult<ShareResponse> {
+        Timber.e("Failed response while while creating new remote share operation ")
+        if (response != null) {
+            Timber.e("*** status code: $status; response message: $response")
+        } else {
+            Timber.e("*** status code: $status")
+        }
+        return RemoteOperationResult(method)
+    }
 
-            if (name.isNotEmpty()) {
-                formBodyBuilder.add(PARAM_NAME, name)
-            }
+    private fun onRequestSuccessful(response: String?): RemoteOperationResult<ShareResponse> {
+        val result = RemoteOperationResult<ShareResponse>(RemoteOperationResult.ResultCode.OK)
+        Timber.d("Successful response: $response")
+        result.data = parseResponse(response!!)
+        Timber.d("*** Creating new remote share operation completed ")
 
-            if (expirationDateInMillis > INIT_EXPIRATION_DATE_IN_MILLIS) {
-                val dateFormat = SimpleDateFormat(FORMAT_EXPIRATION_DATE, Locale.getDefault())
-                val expirationDate = Calendar.getInstance()
-                expirationDate.timeInMillis = expirationDateInMillis
-                val formattedExpirationDate = dateFormat.format(expirationDate.time)
-                formBodyBuilder.add(PARAM_EXPIRATION_DATE, formattedExpirationDate)
-            }
+        val emptyShare = result.data.shares.first()
 
-            if (publicUpload) {
-                formBodyBuilder.add(PARAM_PUBLIC_UPLOAD, publicUpload.toString())
-            }
-            if (password.isNotEmpty()) {
-                formBodyBuilder.add(PARAM_PASSWORD, password)
-            }
-            if (RemoteShare.DEFAULT_PERMISSION != permissions) {
-                formBodyBuilder.add(PARAM_PERMISSIONS, permissions.toString())
-            }
+        return if (retrieveShareDetails) {
+            // retrieve more info - PUT only returns the index of the new share
+            GetRemoteShareOperation(emptyShare.id).execute(client)
+        } else {
+            result
+        }
+    }
 
-            val requestUri = client.baseUri
-            val uriBuilder = requestUri.buildUpon()
-            uriBuilder.appendEncodedPath(ShareUtils.SHARING_API_PATH)
+    private fun createFormBody(): FormBody {
 
-            val postMethod = PostMethod(URL(uriBuilder.build().toString()), formBodyBuilder.build())
+        val formBodyBuilder = FormBody.Builder()
+            .add(PARAM_PATH, remoteFilePath)
+            .add(PARAM_SHARE_TYPE, shareType.value.toString())
+            .add(PARAM_SHARE_WITH, shareWith)
 
-            postMethod.setRequestHeader(HttpConstants.CONTENT_TYPE_HEADER, HttpConstants.CONTENT_TYPE_URLENCODED_UTF8)
-            postMethod.addRequestHeader(OCS_API_HEADER, OCS_API_HEADER_VALUE)
+        if (name.isNotEmpty()) {
+            formBodyBuilder.add(PARAM_NAME, name)
+        }
 
-            val status = client.executeHttpMethod(postMethod)
+        if (expirationDateInMillis > INIT_EXPIRATION_DATE_IN_MILLIS) {
+            val dateFormat = SimpleDateFormat(FORMAT_EXPIRATION_DATE, Locale.getDefault())
+            val expirationDate = Calendar.getInstance()
+            expirationDate.timeInMillis = expirationDateInMillis
+            val formattedExpirationDate = dateFormat.format(expirationDate.time)
+            formBodyBuilder.add(PARAM_EXPIRATION_DATE, formattedExpirationDate)
+        }
+
+        if (publicUpload) {
+            formBodyBuilder.add(PARAM_PUBLIC_UPLOAD, publicUpload.toString())
+        }
+        if (password.isNotEmpty()) {
+            formBodyBuilder.add(PARAM_PASSWORD, password)
+        }
+        if (RemoteShare.DEFAULT_PERMISSION != permissions) {
+            formBodyBuilder.add(PARAM_PERMISSIONS, permissions.toString())
+        }
 
-            val parser = ShareToRemoteOperationResultParser(
-                ShareXMLParser()
-            )
+        return formBodyBuilder.build()
+    }
 
-            if (isSuccess(status)) {
-                parser.oneOrMoreSharesRequired = true
-                parser.ownCloudVersion = client.ownCloudVersion
-                parser.serverBaseUri = client.baseUri
-                result = parser.parse(postMethod.getResponseBodyAsString())
-
-                if (result.isSuccess && retrieveShareDetails) {
-                    // retrieve more info - POST only returns the index of the new share
-                    val emptyShare = result.data.shares[0]
-                    val getInfo = GetRemoteShareOperation(
-                        emptyShare.id
-                    )
-                    result = getInfo.execute(client)
-                }
+    override fun run(client: OwnCloudClient): RemoteOperationResult<ShareResponse> {
+        val requestUri = buildRequestUri(client.baseUri)
+
+        val postMethod = PostMethod(URL(requestUri.toString()), createFormBody()).apply {
+            setRequestHeader(HttpConstants.CONTENT_TYPE_HEADER, HttpConstants.CONTENT_TYPE_URLENCODED_UTF8)
+            addRequestHeader(OCS_API_HEADER, OCS_API_HEADER_VALUE)
+        }
 
+        return try {
+            val status = client.executeHttpMethod(postMethod)
+            val response = postMethod.getResponseBodyAsString()
+
+            if (isSuccess(status)) {
+                onRequestSuccessful(response)
             } else {
-                result = parser.parse(postMethod.getResponseBodyAsString())
+                onResultUnsuccessful(postMethod, response, status)
             }
 
         } catch (e: Exception) {
-            result = RemoteOperationResult(e)
-            Timber.e(e, "Exception while Creating New Share")
+            Timber.e(e, "Exception while creating new remote share operation ")
+            RemoteOperationResult(e)
         }
-
-        return result
     }
 
     private fun isSuccess(status: Int): Boolean = status == HttpConstants.HTTP_OK
 
     companion object {
+
+        //OCS Route
+        private const val OCS_ROUTE = "ocs/v2.php/apps/files_sharing/api/v1/shares"
+
+        //Arguments - names
+
         private const val PARAM_NAME = "name"
-        private const val PARAM_PASSWORD = "password"
         private const val PARAM_EXPIRATION_DATE = "expireDate"
-        private const val PARAM_PUBLIC_UPLOAD = "publicUpload"
         private const val PARAM_PATH = "path"
         private const val PARAM_SHARE_TYPE = "shareType"
         private const val PARAM_SHARE_WITH = "shareWith"
+        private const val PARAM_PASSWORD = "password"
+        private const val PARAM_PUBLIC_UPLOAD = "publicUpload"
         private const val PARAM_PERMISSIONS = "permissions"
+
+        //Arguments - constant values
         private const val FORMAT_EXPIRATION_DATE = "yyyy-MM-dd"
     }
 }