Feature/bca/room upgrade

changelog.d/3551.feature

@@ -0,0 +1 @@
+Room version capabilities and room upgrade support, better error feedback

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/homeserver/HomeServerCapabilities.kt

@@ -32,7 +32,13 @@ data class HomeServerCapabilities(
         /**
          * Default identity server url, provided in Wellknown
          */
-        val defaultIdentityServerUrl: String? = null
+        val defaultIdentityServerUrl: String? = null,
+        /**
+         * Room versions supported by the server
+         * This capability describes the default and available room versions a server supports, and at what level of stability.
+         * Clients should make use of this capability to determine if users need to be encouraged to upgrade their rooms.
+         */
+        val roomVersions: RoomVersionCapabilities? = null
 ) {
     companion object {
         const val MAX_UPLOAD_FILE_SIZE_UNKNOWN = -1L

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/homeserver/RoomVersionModel.kt

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2021 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.api.session.homeserver
+
+data class RoomVersionCapabilities(
+        val defaultRoomVersion: String,
+        val supportedVersion: List<RoomVersionInfo>
+)
+
+data class RoomVersionInfo(
+        val version: String,
+        val status: RoomVersionStatus
+)
+
+enum class RoomVersionStatus {
+    STABLE,
+    UNSTABLE
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/Room.kt

@@ -34,6 +34,7 @@ import org.matrix.android.sdk.api.session.room.tags.TagsService
 import org.matrix.android.sdk.api.session.room.timeline.TimelineService
 import org.matrix.android.sdk.api.session.room.typing.TypingService
 import org.matrix.android.sdk.api.session.room.uploads.UploadsService
+import org.matrix.android.sdk.api.session.room.version.RoomVersionService
 import org.matrix.android.sdk.api.session.search.SearchResult
 import org.matrix.android.sdk.api.session.space.Space
 import org.matrix.android.sdk.api.util.Optional
@@ -57,7 +58,8 @@ interface Room :
         RelationService,
         RoomCryptoService,
         RoomPushRuleService,
-        RoomAccountDataService {
+        RoomAccountDataService,
+        RoomVersionService {
 
     /**
      * The roomId of this room

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/version/RoomVersionService.kt

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2021 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.api.session.room.version
+
+interface RoomVersionService {
+    /**
+     * Return the room version of this room
+     */
+    fun getRoomVersion(): String
+
+    /**
+     * Upgrade to the given room version
+     * @return the replacement room id
+     */
+    suspend fun upgradeToVersion(version: String): String
+
+    /**
+     * Get the recommended room version for the current homeserver
+     */
+    fun getRecommendedVersion() : String
+
+    /**
+     * Ask if the user has enough power level to upgrade the room
+     */
+    fun userMayUpgradeRoom(userId: String): Boolean
+
+    /**
+     * Return true if the current room version is declared unstable by the homeserver
+     */
+    fun isUsingUnstableRoomVersion(): Boolean
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/space/Space.kt

@@ -18,6 +18,7 @@ package org.matrix.android.sdk.api.session.space
 
 import org.matrix.android.sdk.api.session.room.Room
 import org.matrix.android.sdk.api.session.room.model.RoomSummary
+import org.matrix.android.sdk.api.session.space.model.SpaceChildContent
 
 interface Space {
 
@@ -38,6 +39,8 @@ interface Space {
                             autoJoin: Boolean = false,
                             suggested: Boolean? = false)
 
+    fun getChildInfo(roomId: String): SpaceChildContent?
+
     suspend fun removeChildren(roomId: String)
 
     @Throws

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/database/RealmSessionStoreMigration.kt

@@ -46,7 +46,7 @@ import javax.inject.Inject
 class RealmSessionStoreMigration @Inject constructor() : RealmMigration {
 
     companion object {
-        const val SESSION_STORE_SCHEMA_VERSION = 14L
+        const val SESSION_STORE_SCHEMA_VERSION = 15L
     }
 
     override fun migrate(realm: DynamicRealm, oldVersion: Long, newVersion: Long) {
@@ -66,6 +66,7 @@ class RealmSessionStoreMigration @Inject constructor() : RealmMigration {
         if (oldVersion <= 11) migrateTo12(realm)
         if (oldVersion <= 12) migrateTo13(realm)
         if (oldVersion <= 13) migrateTo14(realm)
+        if (oldVersion <= 14) migrateTo15(realm)
     }
 
     private fun migrateTo1(realm: DynamicRealm) {
@@ -306,4 +307,14 @@ class RealmSessionStoreMigration @Inject constructor() : RealmMigration {
 
         roomAccountDataSchema.isEmbedded = true
     }
+
+    private fun migrateTo15(realm: DynamicRealm) {
+        Timber.d("Step 14 -> 15")
+        realm.schema.get("HomeServerCapabilitiesEntity")
+                ?.addField(HomeServerCapabilitiesEntityFields.ROOM_VERSIONS_JSON, String::class.java)
+                ?.transform { obj ->
+                    // Schedule a refresh of the capabilities
+                    obj.setLong(HomeServerCapabilitiesEntityFields.LAST_UPDATED_TIMESTAMP, 0)
+                }
+    }
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/database/mapper/HomeServerCapabilitiesMapper.kt

@@ -16,8 +16,15 @@
 
 package org.matrix.android.sdk.internal.database.mapper
 
+import org.matrix.android.sdk.api.extensions.tryOrNull
 import org.matrix.android.sdk.api.session.homeserver.HomeServerCapabilities
+import org.matrix.android.sdk.api.session.homeserver.RoomVersionCapabilities
+import org.matrix.android.sdk.api.session.homeserver.RoomVersionInfo
+import org.matrix.android.sdk.api.session.homeserver.RoomVersionStatus
 import org.matrix.android.sdk.internal.database.model.HomeServerCapabilitiesEntity
+import org.matrix.android.sdk.internal.di.MoshiProvider
+import org.matrix.android.sdk.internal.session.homeserver.RoomVersions
+import org.matrix.android.sdk.internal.session.room.version.DefaultRoomVersionService
 
 /**
  * HomeServerCapabilitiesEntity -> HomeSeverCapabilities
@@ -29,7 +36,30 @@ internal object HomeServerCapabilitiesMapper {
                 canChangePassword = entity.canChangePassword,
                 maxUploadFileSize = entity.maxUploadFileSize,
                 lastVersionIdentityServerSupported = entity.lastVersionIdentityServerSupported,
-                defaultIdentityServerUrl = entity.defaultIdentityServerUrl
+                defaultIdentityServerUrl = entity.defaultIdentityServerUrl,
+                roomVersions = mapRoomVersion(entity.roomVersionsJson)
         )
     }
+
+    private fun mapRoomVersion(roomVersionsJson: String?): RoomVersionCapabilities? {
+        roomVersionsJson ?: return null
+
+        return tryOrNull {
+            MoshiProvider.providesMoshi().adapter(RoomVersions::class.java).fromJson(roomVersionsJson)?.let {
+                RoomVersionCapabilities(
+                        defaultRoomVersion = it.default ?: DefaultRoomVersionService.DEFAULT_ROOM_VERSION,
+                        supportedVersion = it.available.entries.map { entry ->
+                            RoomVersionInfo(
+                                    version = entry.key,
+                                    status = if (entry.value == "stable") {
+                                        RoomVersionStatus.STABLE
+                                    } else {
+                                        RoomVersionStatus.UNSTABLE
+                                    }
+                            )
+                        }
+                )
+            }
+        }
+    }
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/database/model/HomeServerCapabilitiesEntity.kt

@@ -21,6 +21,7 @@ import org.matrix.android.sdk.api.session.homeserver.HomeServerCapabilities
 
 internal open class HomeServerCapabilitiesEntity(
         var canChangePassword: Boolean = true,
+        var roomVersionsJson: String? = null,
         var maxUploadFileSize: Long = HomeServerCapabilities.MAX_UPLOAD_FILE_SIZE_UNKNOWN,
         var lastVersionIdentityServerSupported: Boolean = false,
         var defaultIdentityServerUrl: String? = null,

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/homeserver/DefaultHomeServerCapabilitiesService.kt

@@ -16,18 +16,12 @@
 
 package org.matrix.android.sdk.internal.session.homeserver
 
-import com.zhuinden.monarchy.Monarchy
-import io.realm.Realm
 import org.matrix.android.sdk.api.session.homeserver.HomeServerCapabilities
 import org.matrix.android.sdk.api.session.homeserver.HomeServerCapabilitiesService
-import org.matrix.android.sdk.internal.database.mapper.HomeServerCapabilitiesMapper
-import org.matrix.android.sdk.internal.database.model.HomeServerCapabilitiesEntity
-import org.matrix.android.sdk.internal.database.query.get
-import org.matrix.android.sdk.internal.di.SessionDatabase
 import javax.inject.Inject
 
 internal class DefaultHomeServerCapabilitiesService @Inject constructor(
-        @SessionDatabase private val monarchy: Monarchy,
+        private val homeServerCapabilitiesDataSource: HomeServerCapabilitiesDataSource,
         private val getHomeServerCapabilitiesTask: GetHomeServerCapabilitiesTask
 ) : HomeServerCapabilitiesService {
 
@@ -36,11 +30,7 @@ internal class DefaultHomeServerCapabilitiesService @Inject constructor(
     }
 
     override fun getHomeServerCapabilities(): HomeServerCapabilities {
-        return Realm.getInstance(monarchy.realmConfiguration).use { realm ->
-            HomeServerCapabilitiesEntity.get(realm)?.let {
-                HomeServerCapabilitiesMapper.map(it)
-            }
-        }
+        return homeServerCapabilitiesDataSource.getHomeServerCapabilities()
                 ?: HomeServerCapabilities()
     }
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/homeserver/GetCapabilitiesResult.kt

@@ -19,6 +19,7 @@ package org.matrix.android.sdk.internal.session.homeserver
 import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
 import org.matrix.android.sdk.api.extensions.orTrue
+import org.matrix.android.sdk.api.util.JsonDict
 
 /**
  * Ref: https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-capabilities
@@ -38,9 +39,14 @@ internal data class Capabilities(
          * Capability to indicate if the user can change their password.
          */
         @Json(name = "m.change_password")
-        val changePassword: ChangePassword? = null
+        val changePassword: ChangePassword? = null,
 
-        // No need for m.room_versions for the moment
+        /**
+         * This capability describes the default and available room versions a server supports, and at what level of stability.
+         * Clients should make use of this capability to determine if users need to be encouraged to upgrade their rooms.
+         */
+        @Json(name = "m.room_versions")
+        val roomVersions: RoomVersions? = null
 )
 
 @JsonClass(generateAdapter = true)
@@ -52,6 +58,21 @@ internal data class ChangePassword(
         val enabled: Boolean?
 )
 
+@JsonClass(generateAdapter = true)
+internal data class RoomVersions(
+        /**
+         * Required. The default room version the server is using for new rooms.
+         */
+        @Json(name = "default")
+        val default: String?,
+
+        /**
+         * Required. A detailed description of the room versions the server supports.
+         */
+        @Json(name = "available")
+        val available: JsonDict
+)
+
 // The spec says: If not present, the client should assume that password changes are possible via the API
 internal fun GetCapabilitiesResult.canChangePassword(): Boolean {
     return capabilities?.changePassword?.enabled.orTrue()

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/homeserver/GetHomeServerCapabilitiesTask.kt

@@ -24,6 +24,7 @@ import org.matrix.android.sdk.internal.auth.version.Versions
 import org.matrix.android.sdk.internal.auth.version.isLoginAndRegistrationSupportedBySdk
 import org.matrix.android.sdk.internal.database.model.HomeServerCapabilitiesEntity
 import org.matrix.android.sdk.internal.database.query.getOrCreate
+import org.matrix.android.sdk.internal.di.MoshiProvider
 import org.matrix.android.sdk.internal.di.SessionDatabase
 import org.matrix.android.sdk.internal.di.UserId
 import org.matrix.android.sdk.internal.network.GlobalErrorReceiver
@@ -104,6 +105,10 @@ internal class DefaultGetHomeServerCapabilitiesTask @Inject constructor(
 
             if (getCapabilitiesResult != null) {
                 homeServerCapabilitiesEntity.canChangePassword = getCapabilitiesResult.canChangePassword()
+
+                homeServerCapabilitiesEntity.roomVersionsJson = getCapabilitiesResult.capabilities?.roomVersions?.let {
+                    MoshiProvider.providesMoshi().adapter(RoomVersions::class.java).toJson(it)
+                }
             }
 
             if (getMediaConfigResult != null) {

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/homeserver/HomeServerCapabilitiesDataSource.kt

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2021 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.session.homeserver
+
+import com.zhuinden.monarchy.Monarchy
+import io.realm.Realm
+import org.matrix.android.sdk.api.session.homeserver.HomeServerCapabilities
+import org.matrix.android.sdk.internal.database.mapper.HomeServerCapabilitiesMapper
+import org.matrix.android.sdk.internal.database.model.HomeServerCapabilitiesEntity
+import org.matrix.android.sdk.internal.database.query.get
+import org.matrix.android.sdk.internal.di.SessionDatabase
+import javax.inject.Inject
+
+internal class HomeServerCapabilitiesDataSource @Inject constructor(
+        @SessionDatabase private val monarchy: Monarchy
+) {
+    fun getHomeServerCapabilities(): HomeServerCapabilities? {
+        return Realm.getInstance(monarchy.realmConfiguration).use { realm ->
+            HomeServerCapabilitiesEntity.get(realm)?.let {
+                HomeServerCapabilitiesMapper.map(it)
+            }
+        }
+    }
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/DefaultRoom.kt

@@ -37,6 +37,7 @@ import org.matrix.android.sdk.api.session.room.tags.TagsService
 import org.matrix.android.sdk.api.session.room.timeline.TimelineService
 import org.matrix.android.sdk.api.session.room.typing.TypingService
 import org.matrix.android.sdk.api.session.room.uploads.UploadsService
+import org.matrix.android.sdk.api.session.room.version.RoomVersionService
 import org.matrix.android.sdk.api.session.search.SearchResult
 import org.matrix.android.sdk.api.session.space.Space
 import org.matrix.android.sdk.api.util.Optional
@@ -67,9 +68,11 @@ internal class DefaultRoom(override val roomId: String,
                            private val roomMembersService: MembershipService,
                            private val roomPushRuleService: RoomPushRuleService,
                            private val roomAccountDataService: RoomAccountDataService,
+                           private val roomVersionService: RoomVersionService,
                            private val sendStateTask: SendStateTask,
                            private val viaParameterFinder: ViaParameterFinder,
-                           private val searchTask: SearchTask) :
+                           private val searchTask: SearchTask
+) :
         Room,
         TimelineService by timelineService,
         SendService by sendService,
@@ -85,7 +88,8 @@ internal class DefaultRoom(override val roomId: String,
         RelationService by relationService,
         MembershipService by roomMembersService,
         RoomPushRuleService by roomPushRuleService,
-        RoomAccountDataService by roomAccountDataService {
+        RoomAccountDataService by roomAccountDataService,
+        RoomVersionService by roomVersionService {
 
     override fun getRoomSummaryLive(): LiveData<Optional<RoomSummary>> {
         return roomSummaryDataSource.getRoomSummaryLive(roomId)