Merge pull request #553 from owncloud/feature/app_registry

[Feature] Open in specific web provider

owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/appregistry/GetRemoteAppRegistryOperation.kt

@@ -0,0 +1,82 @@
+/* ownCloud Android Library is available under MIT license
+ *   @author Abel García de Prada
+ *
+ *   Copyright (C) 2023 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.appregistry
+
+import com.owncloud.android.lib.common.OwnCloudClient
+import com.owncloud.android.lib.common.http.HttpConstants
+import com.owncloud.android.lib.common.http.methods.nonwebdav.GetMethod
+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.OK
+import com.owncloud.android.lib.resources.appregistry.responses.AppRegistryResponse
+import com.squareup.moshi.JsonAdapter
+import com.squareup.moshi.Moshi
+import timber.log.Timber
+import java.net.URL
+
+class GetRemoteAppRegistryOperation : RemoteOperation<AppRegistryResponse>() {
+
+    override fun run(client: OwnCloudClient): RemoteOperationResult<AppRegistryResponse> {
+        var result: RemoteOperationResult<AppRegistryResponse>
+
+        try {
+            val uriBuilder = client.baseUri.buildUpon().apply {
+                appendEncodedPath(APP_REGISTRY_ENDPOINT)
+            }
+            val getMethod = GetMethod(URL(uriBuilder.build().toString()))
+            val status = client.executeHttpMethod(getMethod)
+
+            val response = getMethod.getResponseBodyAsString()
+
+            if (status == HttpConstants.HTTP_OK) {
+                Timber.d("Successful response $response")
+
+                // Parse the response
+                val moshi: Moshi = Moshi.Builder().build()
+                val adapter: JsonAdapter<AppRegistryResponse> = moshi.adapter(AppRegistryResponse::class.java)
+                val appRegistryResponse: AppRegistryResponse = response?.let { adapter.fromJson(it) } ?: AppRegistryResponse(value = emptyList())
+
+                result = RemoteOperationResult(OK)
+                result.data = appRegistryResponse
+
+                Timber.d("Get AppRegistry completed and parsed to ${result.data}")
+            } else {
+                result = RemoteOperationResult(getMethod)
+                Timber.e("Failed response while getting app registry from the server status code: $status; response message: $response")
+            }
+
+        } catch (e: Exception) {
+            result = RemoteOperationResult(e)
+            Timber.e(e, "Exception while getting app registry")
+        }
+
+        return result
+    }
+
+    companion object {
+        private const val APP_REGISTRY_ENDPOINT = "app/list"
+    }
+}

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

@@ -21,7 +21,7 @@
 *   THE SOFTWARE.
 *
 */
-package com.owncloud.android.lib.resources.files
+package com.owncloud.android.lib.resources.appregistry
 
 import com.owncloud.android.lib.common.OwnCloudClient
 import com.owncloud.android.lib.common.http.HttpConstants
@@ -30,7 +30,6 @@ 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
@@ -43,14 +42,16 @@ import java.util.concurrent.TimeUnit
 class GetUrlToOpenInWebRemoteOperation(
     val openWithWebEndpoint: String,
     val fileId: String,
+    val appName: String,
 ) : RemoteOperation<String>() {
 
     override fun run(client: OwnCloudClient): RemoteOperationResult<String> {
         return try {
 
-            val openInWebRequestBody = OpenInWebParams(fileId).toRequestBody()
+            val openInWebRequestBody = OpenInWebParams(fileId, appName).toRequestBody()
 
-            val stringUrl = client.baseUri.toString() + WebdavUtils.encodePath(openWithWebEndpoint) + "?$PARAM_FILE_ID=$fileId"
+            val stringUrl =
+                client.baseUri.toString() + WebdavUtils.encodePath(openWithWebEndpoint)
 
             val postMethod = PostMethod(URL(stringUrl), openInWebRequestBody).apply {
                 setReadTimeout(TIMEOUT, TimeUnit.MILLISECONDS)
@@ -77,12 +78,19 @@ class GetUrlToOpenInWebRemoteOperation(
 
     private fun isSuccess(status: Int) = status == HttpConstants.HTTP_OK || status == HttpConstants.HTTP_MULTI_STATUS
 
-    data class OpenInWebParams(val fileId: String) {
+    data class OpenInWebParams(
+        val fileId: String,
+        val appName: String,
+    ) {
         fun toRequestBody(): RequestBody =
-            FormBody.Builder().build()
+            FormBody.Builder()
+                .add(PARAM_FILE_ID, fileId)
+                .add(PARAM_APP_NAME, appName)
+                .build()
 
         companion object {
             const val PARAM_FILE_ID = "file_id"
+            const val PARAM_APP_NAME = "app_name"
         }
     }
 

owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/appregistry/responses/AppRegistryResponse.kt

@@ -0,0 +1,56 @@
+/* ownCloud Android Library is available under MIT license
+ *   @author Abel García de Prada
+ *
+ *   Copyright (C) 2023 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.appregistry.responses
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class AppRegistryResponse(
+    @Json(name = "mime-types")
+    val value: List<AppRegistryMimeTypeResponse>
+)
+
+@JsonClass(generateAdapter = true)
+data class AppRegistryMimeTypeResponse(
+    @Json(name = "mime_type") val mimeType: String,
+    val ext: String? = null,
+    @Json(name = "app_providers")
+    val appProviders: List<AppRegistryProviderResponse>,
+    val name: String? = null,
+    val icon: String? = null,
+    val description: String? = null,
+    @Json(name = "allow_creation")
+    val allowCreation: Boolean? = null,
+    @Json(name = "default_application")
+    val defaultApplication: String? = null
+)
+
+@JsonClass(generateAdapter = true)
+data class AppRegistryProviderResponse(
+    val name: String,
+    val icon: String,
+)

owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/appregistry/services/AppRegistryService.kt

@@ -0,0 +1,37 @@
+/* ownCloud Android Library is available under MIT license
+ *   Copyright (C) 2023 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.appregistry.services
+
+import com.owncloud.android.lib.common.operations.RemoteOperationResult
+import com.owncloud.android.lib.resources.Service
+import com.owncloud.android.lib.resources.appregistry.responses.AppRegistryResponse
+
+interface AppRegistryService : Service {
+    fun getAppRegistry(): RemoteOperationResult<AppRegistryResponse>
+
+    fun getUrlToOpenInWeb(
+        openWebEndpoint: String,
+        fileId: String,
+        appName: String,
+    ): RemoteOperationResult<String>
+}

owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/appregistry/services/OCAppRegistryService.kt

@@ -0,0 +1,41 @@
+/* ownCloud Android Library is available under MIT license
+ *   Copyright (C) 2023 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.appregistry.services
+
+import com.owncloud.android.lib.common.OwnCloudClient
+import com.owncloud.android.lib.common.operations.RemoteOperationResult
+import com.owncloud.android.lib.resources.appregistry.GetRemoteAppRegistryOperation
+import com.owncloud.android.lib.resources.appregistry.GetUrlToOpenInWebRemoteOperation
+import com.owncloud.android.lib.resources.appregistry.responses.AppRegistryResponse
+
+class OCAppRegistryService(override val client: OwnCloudClient) : AppRegistryService {
+    override fun getAppRegistry(): RemoteOperationResult<AppRegistryResponse> =
+        GetRemoteAppRegistryOperation().execute(client)
+
+    override fun getUrlToOpenInWeb(openWebEndpoint: String, fileId: String, appName: String): RemoteOperationResult<String> =
+        GetUrlToOpenInWebRemoteOperation(
+            openWithWebEndpoint = openWebEndpoint,
+            fileId = fileId,
+            appName = appName
+        ).execute(client)
+}

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

@@ -28,8 +28,6 @@ import com.owncloud.android.lib.resources.Service
 import com.owncloud.android.lib.resources.files.RemoteFile
 
 interface FileService : Service {
-    fun getUrlToOpenInWeb(openWebEndpoint: String, fileId: String): RemoteOperationResult<String>
-
     fun checkPathExistence(
         path: String,
         isUserLogged: Boolean,

owncloudComLibrary/src/main/java/com/owncloud/android/lib/resources/files/services/implementation/OCFileService.kt

@@ -29,7 +29,6 @@ import com.owncloud.android.lib.resources.files.CheckPathExistenceRemoteOperatio
 import com.owncloud.android.lib.resources.files.CopyRemoteFileOperation
 import com.owncloud.android.lib.resources.files.CreateRemoteFolderOperation
 import com.owncloud.android.lib.resources.files.DownloadRemoteFileOperation
-import com.owncloud.android.lib.resources.files.GetUrlToOpenInWebRemoteOperation
 import com.owncloud.android.lib.resources.files.MoveRemoteFileOperation
 import com.owncloud.android.lib.resources.files.ReadRemoteFileOperation
 import com.owncloud.android.lib.resources.files.ReadRemoteFolderOperation
@@ -39,7 +38,6 @@ import com.owncloud.android.lib.resources.files.RenameRemoteFileOperation
 import com.owncloud.android.lib.resources.files.services.FileService
 
 class OCFileService(override val client: OwnCloudClient) : FileService {
-
     override fun checkPathExistence(
         path: String,
         isUserLogged: Boolean,
@@ -51,9 +49,6 @@ class OCFileService(override val client: OwnCloudClient) : FileService {
             spaceWebDavUrl = spaceWebDavUrl,
         ).execute(client)
 
-    override fun getUrlToOpenInWeb(openWebEndpoint: String, fileId: String): RemoteOperationResult<String> =
-        GetUrlToOpenInWebRemoteOperation(openWithWebEndpoint = openWebEndpoint, fileId = fileId).execute(client)
-
     override fun copyFile(
         sourceRemotePath: String,
         targetRemotePath: String,