Client integration

Signed-off-by: tobiasKaminsky <tobias@kaminsky.me>

Author: tobiasKaminsky

.idea/codeStyles/Project.xml

@@ -263,8 +263,8 @@ public static File extractAsset(String fileName, Context context) throws IOExcep
 
     @After
     public void after() {
-        removeOnClient(client);
-        removeOnClient(client2);
+//        removeOnClient(client);
+//        removeOnClient(client2);
     }
 
     private void removeOnClient(OwnCloudClient client) {

library/src/androidTest/java/com/owncloud/android/AbstractIT.java

@@ -23,6 +23,7 @@
 import com.owncloud.android.lib.resources.status.NextcloudVersion;
 import com.owncloud.android.lib.resources.status.OCCapability;
 import com.owncloud.android.lib.resources.status.OwnCloudVersion;
+import com.owncloud.android.lib.resources.status.Type;
 
 import org.junit.Test;
 
@@ -163,4 +164,17 @@ private void checkCapability(OCCapability capability, String userId) {
             assertTrue(capability.isWCFEnabled().isFalse());
         }
     }
+    
+    @Test
+    public void testClientIntegration() {
+        // get capabilities
+        RemoteOperationResult result = new GetCapabilitiesRemoteOperation().execute(nextcloudClient);
+        assertTrue(result.isSuccess());
+        assertNotNull(result.getSingleData());
+
+        OCCapability capability = (OCCapability) result.getSingleData();
+
+        assertEquals(5, capability.getClientIntegrationEndpoints(Type.CONTEXT_MENU, "").size());
+        assertEquals(2, capability.getClientIntegrationEndpoints(Type.CREATE_NEW, "").size());
+    } 
 }

library/src/androidTest/java/com/owncloud/android/GetCapabilitiesRemoteOperationIT.java

@@ -0,0 +1,19 @@
+/*
+ * Nextcloud Android Library
+ *
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2025 Tobias Kaminsky <tobias@kaminsky.me>
+ * SPDX-License-Identifier: MIT
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import com.google.gson.annotations.SerializedName
+
+data class App(
+    val version: Double,
+    @SerializedName("context-menu")
+    val contextMenu: List<Endpoint>,
+    @SerializedName("create-new")
+    val createNew: List<Endpoint>
+)

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/App.kt

@@ -0,0 +1,18 @@
+/*
+ * Nextcloud - Android Client
+ *
+ * SPDX-FileCopyrightText: 2025 Your Name <your@email.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import android.os.Parcelable
+import kotlinx.parcelize.Parcelize
+
+@Parcelize
+data class Button(
+    val label: String,
+    val type: String
+) : Element,
+    Parcelable

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/Button.kt

@@ -0,0 +1,17 @@
+/*
+ * Nextcloud - Android Client
+ *
+ * SPDX-FileCopyrightText: 2025 Your Name <your@email.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import android.os.Parcelable
+import kotlinx.parcelize.Parcelize
+
+@Parcelize
+data class ClientIntegrationUI(
+    val version: Double,
+    val root: Layout
+) : Parcelable

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/ClientIntegrationUI.kt

@@ -0,0 +1,12 @@
+/*
+ * Nextcloud Android Library
+ *
+ * SPDX-FileCopyrightText: 2025 Your Name <your@email.com>
+ * SPDX-License-Identifier: MIT
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import android.os.Parcelable
+
+interface Element : Parcelable

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/Element.kt

@@ -0,0 +1,70 @@
+/*
+ * Nextcloud - Android Client
+ *
+ * SPDX-FileCopyrightText: 2025 Your Name <your@email.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import com.google.gson.Gson
+import com.google.gson.JsonDeserializationContext
+import com.google.gson.JsonDeserializer
+import com.google.gson.JsonElement
+import com.google.gson.JsonParseException
+import com.google.gson.JsonSerializationContext
+import com.google.gson.JsonSerializer
+import java.lang.reflect.Type
+
+class ElementTypeAdapter :
+    JsonSerializer<Element>,
+    JsonDeserializer<Element> {
+    override fun serialize(
+        src: Element,
+        type: Type,
+        context: JsonSerializationContext
+    ): JsonElement {
+        // needs to be a new Gson instance, otherwise we end up in a loop
+        val element = Gson().toJsonTree(src)
+        element.asJsonObject.addProperty("element", src.javaClass.name)
+
+        return element
+    }
+
+    @Throws(JsonParseException::class, ClassNotFoundException::class, Throwable::class)
+    override fun deserialize(
+        json: JsonElement,
+        type: Type,
+        context: JsonDeserializationContext
+    ): Element? {
+        val jsonObject = json.asJsonObject
+        val typeName = jsonObject.get("element").asString
+
+        try {
+            val cls: Class<out Element> =
+                when (typeName) {
+                    "Button" ->
+                        Class.forName("com.nextcloud.android.lib.resources.clientintegration.Button")
+                            as Class<out Element>
+
+                    "Text" ->
+                        Class.forName("com.nextcloud.android.lib.resources.clientintegration.Text")
+                            as Class<out Element>
+
+                    "Image" ->
+                        Class.forName("com.nextcloud.android.lib.resources.clientintegration.Image")
+                            as Class<out Element>
+
+                    "URL" ->
+                        Class.forName("com.nextcloud.android.lib.resources.clientintegration.URL")
+                            as Class<out Element>
+
+                    else -> return null
+                }
+
+            return Gson().fromJson(json, cls)
+        } catch (e: ClassNotFoundException) {
+            throw JsonParseException(e)
+        }
+    }
+}

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/ElementTypeAdapter.kt

@@ -0,0 +1,25 @@
+/*
+ * Nextcloud Android Library
+ *
+ * SPDX-FileCopyrightText: 2025 Your Name <your@email.com>
+ * SPDX-License-Identifier: MIT
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import android.os.Parcelable
+import com.google.gson.annotations.SerializedName
+import com.owncloud.android.lib.resources.status.Method
+import kotlinx.parcelize.Parcelize
+
+@Parcelize
+data class Endpoint(
+    val name: String,
+    val url: String,
+    var method: Method?,
+    @SerializedName("mimetype_filters")
+    val mimetypeFilter: String?,
+    val params: Map<String, String>?,
+    val icon: String?,
+    val filter: String?
+) : Parcelable

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/Endpoint.kt

@@ -0,0 +1,81 @@
+/*
+ * Nextcloud Android Library
+ *
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2025 Tobias Kaminsky <tobias@kaminsky.me>
+ * SPDX-License-Identifier: MIT
+ */
+package com.nextcloud.android.lib.resources.clientintegration
+
+import com.google.gson.GsonBuilder
+import com.google.gson.JsonArray
+import com.google.gson.reflect.TypeToken
+import com.nextcloud.common.NextcloudClient
+import com.nextcloud.operations.GetMethod
+import com.owncloud.android.lib.common.operations.RemoteOperationResult
+import com.owncloud.android.lib.common.utils.Log_OC
+import com.owncloud.android.lib.ocs.ServerResponse
+import com.owncloud.android.lib.resources.OCSRemoteOperation
+import org.apache.commons.httpclient.HttpStatus
+
+/**
+ * Get client integration
+ */
+class GetClientIntegrationJsonOperation(
+    val url: String
+) : OCSRemoteOperation<JsonArray>() {
+    @Suppress("TooGenericExceptionCaught")
+    override fun run(client: NextcloudClient): RemoteOperationResult<JsonArray> {
+        var result: RemoteOperationResult<JsonArray>
+        var getMethod: GetMethod? = null
+        try {
+            getMethod =
+                GetMethod(
+                    client.baseUri.toString() + url + JSON_FORMAT,
+                    true
+                )
+            val status = client.execute(getMethod)
+            if (status == HttpStatus.SC_OK) {
+                val terms =
+                    getServerResponse(
+                        getMethod,
+                        object : TypeToken<ServerResponse<JsonArray>>() {}
+                    )?.ocs?.data
+
+                val json = parseResult(getMethod.getResponseBodyAsString())
+
+                if (terms != null) {
+                    result = RemoteOperationResult(true, getMethod)
+                    result.resultData = terms
+                } else {
+                    result = RemoteOperationResult(false, getMethod)
+                }
+            } else {
+                result = RemoteOperationResult(false, getMethod)
+            }
+        } catch (e: Exception) {
+            result = RemoteOperationResult(e)
+            Log_OC.e(
+                TAG,
+                "Get client integration failed: " + result.logMessage,
+                result.exception
+            )
+        } finally {
+            getMethod?.releaseConnection()
+        }
+        return result
+    }
+
+    fun parseResult(response: String): ClientIntegrationUI {
+        val gson =
+            GsonBuilder()
+                .registerTypeHierarchyAdapter(Element::class.java, ElementTypeAdapter())
+                .create()
+
+        return gson.fromJson(response, ClientIntegrationUI::class.java)
+    }
+
+    companion object {
+        private val TAG = GetClientIntegrationJsonOperation::class.java.simpleName
+    }
+}