Add a new remote operation to retrieve the url to open a file with ocis provider

Author: abelgardep

owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/files/GetUrlToOpenInWebRemoteOperation.kt

@@ -0,0 +1,98 @@
+/* ownCloud Android Library is available under MIT license
+*   Copyright (C) 2022 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
+*   in the Software without restriction, including without limitation the rights
+*   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+*   copies of the Software, and to permit persons to whom the Software is
+*   furnished to do so, subject to the following conditions:
+*
+*   The above copyright notice and this permission notice shall be included in
+*   all copies or substantial portions of the Software.
+*
+*   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+*   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+*   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+*   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+*   BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+*   ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+*   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+*   THE SOFTWARE.
+*
+*/
+package com.owncloud.android.lib.resources.files
+
+import com.owncloud.android.lib.common.OwnCloudClient
+import com.owncloud.android.lib.common.http.HttpConstants
+import com.owncloud.android.lib.common.http.methods.nonwebdav.PostMethod
+import com.owncloud.android.lib.common.network.WebdavUtils
+import com.owncloud.android.lib.common.operations.RemoteOperation
+import com.owncloud.android.lib.common.operations.RemoteOperationResult
+import com.owncloud.android.lib.common.operations.RemoteOperationResult.ResultCode
+import com.owncloud.android.lib.resources.files.GetUrlToOpenInWebRemoteOperation.OpenInWebParams.Companion.PARAM_FILE_ID
+import com.squareup.moshi.JsonAdapter
+import com.squareup.moshi.JsonClass
+import com.squareup.moshi.Moshi
+import okhttp3.FormBody
+import okhttp3.RequestBody
+import timber.log.Timber
+import java.net.URL
+import java.util.concurrent.TimeUnit
+
+class GetUrlToOpenInWebRemoteOperation(
+    val openWithWebEndpoint: String,
+    val fileId: String,
+) : RemoteOperation<String>() {
+
+    override fun run(client: OwnCloudClient): RemoteOperationResult<String> {
+        return try {
+
+            val openInWebRequestBody = OpenInWebParams(fileId).toRequestBody()
+
+            val stringUrl = client.baseUri.toString() + WebdavUtils.encodePath(openWithWebEndpoint) + "?$PARAM_FILE_ID=$fileId"
+
+            val postMethod = PostMethod(URL(stringUrl), openInWebRequestBody).apply {
+                setReadTimeout(TIMEOUT, TimeUnit.MILLISECONDS)
+                setConnectionTimeout(TIMEOUT, TimeUnit.MILLISECONDS)
+            }
+
+            val status = client.executeHttpMethod(postMethod)
+            Timber.d("Open in web for file: $fileId - $status${if (!isSuccess(status)) "(FAIL)" else ""}")
+
+            if (isSuccess(status)) RemoteOperationResult<String>(ResultCode.OK).apply {
+                val moshi = Moshi.Builder().build()
+                val adapter: JsonAdapter<OpenInWebResponse> = moshi.adapter(OpenInWebResponse::class.java)
+
+                data = postMethod.getResponseBodyAsString()?.let { adapter.fromJson(it)!!.uri }
+            }
+            else RemoteOperationResult<String>(postMethod).apply { data = "" }
+
+        } catch (e: Exception) {
+            val result = RemoteOperationResult<String>(e)
+            Timber.e(e, "Open in web for file: $fileId failed")
+            result
+        }
+    }
+
+    private fun isSuccess(status: Int) = status == HttpConstants.HTTP_OK || status == HttpConstants.HTTP_MULTI_STATUS
+
+    data class OpenInWebParams(val fileId: String) {
+        fun toRequestBody(): RequestBody =
+            FormBody.Builder().build()
+
+        companion object {
+            const val PARAM_FILE_ID = "file_id"
+        }
+    }
+
+    @JsonClass(generateAdapter = true)
+    data class OpenInWebResponse(val uri: String)
+
+    companion object {
+        /**
+         * Maximum time to wait for a response from the server in milliseconds.
+         */
+        private const val TIMEOUT = 5_000L
+    }
+}