valuePredicate) {
+ int size = valueHistory.size();
+ for (int valueIndex = 0; valueIndex < size; valueIndex++) {
+ T value = this.valueHistory.get(valueIndex);
+ if (valuePredicate.apply(value)) {
+ throw fail("Value at position " + valueIndex + " matches predicate "
+ + valuePredicate.toString() + ", which was not expected.");
+ }
+ }
+
+ return this;
+ }
+
+ /**
+ * Awaits until this TestObserver has any value.
+ *
+ * If this TestObserver has already value then this method returns immediately.
+ *
+ * @return this
+ * @throws InterruptedException if the current thread is interrupted while waiting
+ */
+ public LiveDataTestObserver awaitValue() throws InterruptedException {
+ valueLatch.await();
+ return this;
+ }
+
+ /**
+ * Awaits the specified amount of time or until this TestObserver has any value.
+ *
+ * If this TestObserver has already value then this method returns immediately.
+ *
+ * @return this
+ * @throws InterruptedException if the current thread is interrupted while waiting
+ */
+ public LiveDataTestObserver awaitValue(long timeout, TimeUnit timeUnit) throws InterruptedException {
+ valueLatch.await(timeout, timeUnit);
+ return this;
+ }
+
+ /**
+ * Awaits until this TestObserver receives next value.
+ *
+ * If this TestObserver has already value then it awaits for another one.
+ *
+ * @return this
+ * @throws InterruptedException if the current thread is interrupted while waiting
+ */
+ public LiveDataTestObserver awaitNextValue() throws InterruptedException {
+ return withNewLatch().awaitValue();
+ }
+
+
+ /**
+ * Awaits the specified amount of time or until this TestObserver receives next value.
+ *
+ * If this TestObserver has already value then it awaits for another one.
+ *
+ * @return this
+ * @throws InterruptedException if the current thread is interrupted while waiting
+ */
+ public LiveDataTestObserver awaitNextValue(long timeout, TimeUnit timeUnit) throws InterruptedException {
+ return withNewLatch().awaitValue(timeout, timeUnit);
+ }
+
+ private LiveDataTestObserver withNewLatch() {
+ valueLatch = new CountDownLatch(1);
+ return this;
+ }
+
+ private AssertionError fail(String message) {
+ return new AssertionError(message);
+ }
+
+ private static String valueAndClass(Object value) {
+ if (value != null) {
+ return value + " (class: " + value.getClass().getSimpleName() + ")";
+ }
+ return "null";
+ }
+
+ public static LiveDataTestObserver create() {
+ return new LiveDataTestObserver<>(new MutableLiveData());
+ }
+
+ public static LiveDataTestObserver test(LiveData liveData) {
+ LiveDataTestObserver observer = new LiveDataTestObserver<>(liveData);
+ liveData.observeForever(observer);
+ return observer;
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/MainThreadExecutor.java b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/MainThreadExecutor.java
new file mode 100644
index 00000000..7eb119ce
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/MainThreadExecutor.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android;
+
+import android.os.Handler;
+import android.os.Looper;
+
+import java.util.concurrent.Executor;
+
+public class MainThreadExecutor implements Executor {
+
+ private final Handler handler = new Handler(Looper.getMainLooper());
+
+ @Override
+ public void execute(Runnable runnable) {
+ handler.post(runnable);
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/OkReplayRuleChainNoActivity.kt b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/OkReplayRuleChainNoActivity.kt
new file mode 100644
index 00000000..9fd1fe6b
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/OkReplayRuleChainNoActivity.kt
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android
+
+import okreplay.OkReplayConfig
+import okreplay.PermissionRule
+import okreplay.RecorderRule
+import org.junit.rules.RuleChain
+import org.junit.rules.TestRule
+
+class OkReplayRuleChainNoActivity(
+ private val configuration: OkReplayConfig) {
+
+ fun get(): TestRule {
+ return RuleChain.outerRule(PermissionRule(configuration))
+ .around(RecorderRule(configuration))
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/SingleThreadCoroutineDispatcher.kt b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/SingleThreadCoroutineDispatcher.kt
new file mode 100644
index 00000000..69803c5d
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/SingleThreadCoroutineDispatcher.kt
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android
+
+import im.vector.matrix.android.internal.util.MatrixCoroutineDispatchers
+import kotlinx.coroutines.Dispatchers.Main
+
+internal val testCoroutineDispatchers = MatrixCoroutineDispatchers(Main, Main, Main, Main, Main)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/auth/AuthenticatorTest.kt b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/auth/AuthenticatorTest.kt
new file mode 100644
index 00000000..3dfc0619
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/auth/AuthenticatorTest.kt
@@ -0,0 +1,64 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.auth
+
+import androidx.test.annotation.UiThreadTest
+import androidx.test.rule.GrantPermissionRule
+import androidx.test.runner.AndroidJUnit4
+import im.vector.matrix.android.InstrumentedTest
+import im.vector.matrix.android.OkReplayRuleChainNoActivity
+import im.vector.matrix.android.api.auth.Authenticator
+import okreplay.*
+import org.junit.ClassRule
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+
+
+@RunWith(AndroidJUnit4::class)
+internal class AuthenticatorTest : InstrumentedTest {
+
+ lateinit var authenticator: Authenticator
+ lateinit var okReplayInterceptor: OkReplayInterceptor
+
+ private val okReplayConfig = OkReplayConfig.Builder()
+ .tapeRoot(AndroidTapeRoot(
+ context(), javaClass))
+ .defaultMode(TapeMode.READ_WRITE) // or TapeMode.READ_ONLY
+ .sslEnabled(true)
+ .interceptor(okReplayInterceptor)
+ .build()
+
+ @get:Rule
+ val testRule = OkReplayRuleChainNoActivity(okReplayConfig).get()
+
+ @Test
+ @UiThreadTest
+ @OkReplay(tape = "auth", mode = TapeMode.READ_WRITE)
+ fun auth() {
+
+ }
+
+ companion object {
+ @ClassRule
+ @JvmField
+ val grantExternalStoragePermissionRule: GrantPermissionRule =
+ GrantPermissionRule.grant(android.Manifest.permission.WRITE_EXTERNAL_STORAGE)
+ }
+
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/internal/crypto/CryptoStoreHelper.kt b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/internal/crypto/CryptoStoreHelper.kt
new file mode 100644
index 00000000..cea612dd
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/internal/crypto/CryptoStoreHelper.kt
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2018 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 im.vector.matrix.android.internal.crypto
+
+import im.vector.matrix.android.api.auth.data.Credentials
+import im.vector.matrix.android.internal.crypto.store.IMXCryptoStore
+import im.vector.matrix.android.internal.crypto.store.db.RealmCryptoStore
+import im.vector.matrix.android.internal.crypto.store.db.RealmCryptoStoreModule
+import io.realm.RealmConfiguration
+import java.util.*
+
+internal class CryptoStoreHelper {
+
+ fun createStore(): IMXCryptoStore {
+ return RealmCryptoStore(
+ realmConfiguration = RealmConfiguration.Builder()
+ .name("test.realm")
+ .modules(RealmCryptoStoreModule())
+ .build(),
+ credentials = createCredential())
+ }
+
+ fun createCredential() = Credentials(
+ userId = "userId_" + Random().nextInt(),
+ homeServer = "http://matrix.org",
+ accessToken = "access_token",
+ refreshToken = null,
+ deviceId = "deviceId_sample"
+ )
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/internal/crypto/CryptoStoreTest.kt b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/internal/crypto/CryptoStoreTest.kt
new file mode 100644
index 00000000..0f65ad3e
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/internal/crypto/CryptoStoreTest.kt
@@ -0,0 +1,117 @@
+/*
+ * Copyright 2018 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 im.vector.matrix.android.internal.crypto
+
+import im.vector.matrix.android.internal.crypto.model.OlmSessionWrapper
+import im.vector.matrix.android.internal.crypto.store.IMXCryptoStore
+import org.junit.Assert.*
+import org.junit.Test
+import org.matrix.olm.OlmAccount
+import org.matrix.olm.OlmManager
+import org.matrix.olm.OlmSession
+
+private const val DUMMY_DEVICE_KEY = "DeviceKey"
+
+class CryptoStoreTest {
+
+ private val cryptoStoreHelper = CryptoStoreHelper()
+
+ @Test
+ fun test_metadata_realm_ok() {
+ val cryptoStore: IMXCryptoStore = cryptoStoreHelper.createStore()
+
+ assertFalse(cryptoStore.hasData())
+
+ cryptoStore.open()
+
+ assertEquals("deviceId_sample", cryptoStore.getDeviceId())
+
+ assertTrue(cryptoStore.hasData())
+
+ // Cleanup
+ cryptoStore.close()
+ cryptoStore.deleteStore()
+ }
+
+ @Test
+ fun test_lastSessionUsed() {
+ // Ensure Olm is initialized
+ OlmManager()
+
+ val cryptoStore: IMXCryptoStore = cryptoStoreHelper.createStore()
+
+ assertNull(cryptoStore.getLastUsedSessionId(DUMMY_DEVICE_KEY))
+
+ val olmAccount1 = OlmAccount().apply {
+ generateOneTimeKeys(1)
+ }
+
+ val olmSession1 = OlmSession().apply {
+ initOutboundSession(olmAccount1,
+ olmAccount1.identityKeys()[OlmAccount.JSON_KEY_IDENTITY_KEY],
+ olmAccount1.oneTimeKeys()[OlmAccount.JSON_KEY_ONE_TIME_KEY]?.values?.first())
+ }
+
+ val sessionId1 = olmSession1.sessionIdentifier()
+ val olmSessionWrapper1 = OlmSessionWrapper(olmSession1)
+
+ cryptoStore.storeSession(olmSessionWrapper1, DUMMY_DEVICE_KEY)
+
+ assertEquals(sessionId1, cryptoStore.getLastUsedSessionId(DUMMY_DEVICE_KEY))
+
+ val olmAccount2 = OlmAccount().apply {
+ generateOneTimeKeys(1)
+ }
+
+ val olmSession2 = OlmSession().apply {
+ initOutboundSession(olmAccount2,
+ olmAccount2.identityKeys()[OlmAccount.JSON_KEY_IDENTITY_KEY],
+ olmAccount2.oneTimeKeys()[OlmAccount.JSON_KEY_ONE_TIME_KEY]?.values?.first())
+ }
+
+ val sessionId2 = olmSession2.sessionIdentifier()
+ val olmSessionWrapper2 = OlmSessionWrapper(olmSession2)
+
+ cryptoStore.storeSession(olmSessionWrapper2, DUMMY_DEVICE_KEY)
+
+ // Ensure sessionIds are distinct
+ assertNotEquals(sessionId1, sessionId2)
+
+ // Note: we cannot be sure what will be the result of getLastUsedSessionId() here
+
+ olmSessionWrapper2.onMessageReceived()
+ cryptoStore.storeSession(olmSessionWrapper2, DUMMY_DEVICE_KEY)
+
+ // sessionId2 is returned now
+ assertEquals(sessionId2, cryptoStore.getLastUsedSessionId(DUMMY_DEVICE_KEY))
+
+ Thread.sleep(2)
+
+ olmSessionWrapper1.onMessageReceived()
+ cryptoStore.storeSession(olmSessionWrapper1, DUMMY_DEVICE_KEY)
+
+ // sessionId1 is returned now
+ assertEquals(sessionId1, cryptoStore.getLastUsedSessionId(DUMMY_DEVICE_KEY))
+
+ // Cleanup
+ olmSession1.releaseSession()
+ olmSession2.releaseSession()
+
+ olmAccount1.releaseAccount()
+ olmAccount2.releaseAccount()
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/internal/util/JsonCanonicalizerTest.kt b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/internal/util/JsonCanonicalizerTest.kt
new file mode 100644
index 00000000..1ea6105d
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/internal/util/JsonCanonicalizerTest.kt
@@ -0,0 +1,162 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.util
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import im.vector.matrix.android.InstrumentedTest
+import org.junit.Assert.assertEquals
+import org.junit.Test
+import org.junit.runner.RunWith
+
+@RunWith(AndroidJUnit4::class)
+internal class JsonCanonicalizerTest : InstrumentedTest {
+
+ @Test
+ fun identityTest() {
+ listOf(
+ "{}",
+ """{"a":true}""",
+ """{"a":false}""",
+ """{"a":1}""",
+ """{"a":1.2}""",
+ """{"a":null}""",
+ """{"a":[]}""",
+ """{"a":["b":"c"]}""",
+ """{"a":["c":"b","d":"e"]}""",
+ """{"a":["d":"b","c":"e"]}"""
+ ).forEach {
+ assertEquals(it,
+ JsonCanonicalizer.canonicalize(it))
+ }
+ }
+
+ @Test
+ fun reorderTest() {
+ assertEquals("""{"a":true,"b":false}""",
+ JsonCanonicalizer.canonicalize("""{"b":false,"a":true}"""))
+ }
+
+ @Test
+ fun realSampleTest() {
+ assertEquals("""{"algorithms":["m.megolm.v1.aes-sha2","m.olm.v1.curve25519-aes-sha2"],"device_id":"VSCUNFSOUI","keys":{"curve25519:VSCUNFSOUI":"utyOjnhiQ73qNhi9HlN0OgWIowe5gthTS8r0r9TcJ3o","ed25519:VSCUNFSOUI":"qNhEt+Yggaajet0hX\/FjTRLfySgs65ldYyomm7PIx6U"},"user_id":"@benoitx:matrix.org"}""",
+ JsonCanonicalizer.canonicalize("""{"algorithms":["m.megolm.v1.aes-sha2","m.olm.v1.curve25519-aes-sha2"],"device_id":"VSCUNFSOUI","user_id":"@benoitx:matrix.org","keys":{"curve25519:VSCUNFSOUI":"utyOjnhiQ73qNhi9HlN0OgWIowe5gthTS8r0r9TcJ3o","ed25519:VSCUNFSOUI":"qNhEt+Yggaajet0hX/FjTRLfySgs65ldYyomm7PIx6U"}}"""))
+ }
+
+ @Test
+ fun doubleQuoteTest() {
+ assertEquals("{\"a\":\"\\\"\"}",
+ JsonCanonicalizer.canonicalize("{\"a\":\"\\\"\"}"))
+ }
+
+
+
+ /* ==========================================================================================
+ * Test from https://matrix.org/docs/spec/appendices.html#examples
+ * ========================================================================================== */
+
+ @Test
+ fun matrixOrg001Test() {
+ assertEquals("""{}""",
+ JsonCanonicalizer.canonicalize("""{}"""))
+ }
+
+
+ @Test
+ fun matrixOrg002Test() {
+ assertEquals("""{"one":1,"two":"Two"}""",
+ JsonCanonicalizer.canonicalize("""{
+ "one": 1,
+ "two": "Two"
+}"""))
+ }
+
+
+ @Test
+ fun matrixOrg003Test() {
+ assertEquals("""{"a":"1","b":"2"}""",
+ JsonCanonicalizer.canonicalize("""{
+ "b": "2",
+ "a": "1"
+}"""))
+ }
+
+
+ @Test
+ fun matrixOrg004Test() {
+ assertEquals("""{"a":"1","b":"2"}""",
+ JsonCanonicalizer.canonicalize("""{"b":"2","a":"1"}"""))
+ }
+
+
+ @Test
+ fun matrixOrg005Test() {
+ assertEquals("""{"auth":{"mxid":"@john.doe:example.com","profile":{"display_name":"John Doe","three_pids":[{"address":"john.doe@example.org","medium":"email"},{"address":"123456789","medium":"msisdn"}]},"success":true}}""",
+ JsonCanonicalizer.canonicalize("""{
+ "auth": {
+ "success": true,
+ "mxid": "@john.doe:example.com",
+ "profile": {
+ "display_name": "John Doe",
+ "three_pids": [
+ {
+ "medium": "email",
+ "address": "john.doe@example.org"
+ },
+ {
+ "medium": "msisdn",
+ "address": "123456789"
+ }
+ ]
+ }
+ }
+}"""))
+ }
+
+
+ @Test
+ fun matrixOrg006Test() {
+ assertEquals("""{"a":"日本語"}""",
+ JsonCanonicalizer.canonicalize("""{
+ "a": "日本語"
+}"""))
+ }
+
+
+ @Test
+ fun matrixOrg007Test() {
+ assertEquals("""{"日":1,"本":2}""",
+ JsonCanonicalizer.canonicalize("""{
+ "本": 2,
+ "日": 1
+}"""))
+ }
+
+
+ @Test
+ fun matrixOrg008Test() {
+ assertEquals("""{"a":"日"}""",
+ JsonCanonicalizer.canonicalize("{\"a\": \"\u65E5\"}"))
+ }
+
+ @Test
+ fun matrixOrg009Test() {
+ assertEquals("""{"a":null}""",
+ JsonCanonicalizer.canonicalize("""{
+ "a": null
+}"""))
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/ChunkEntityTest.kt b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/ChunkEntityTest.kt
new file mode 100644
index 00000000..be351fb0
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/ChunkEntityTest.kt
@@ -0,0 +1,202 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.session.room.timeline
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.zhuinden.monarchy.Monarchy
+import im.vector.matrix.android.InstrumentedTest
+import im.vector.matrix.android.internal.database.helper.add
+import im.vector.matrix.android.internal.database.helper.addAll
+import im.vector.matrix.android.internal.database.helper.isUnlinked
+import im.vector.matrix.android.internal.database.helper.lastStateIndex
+import im.vector.matrix.android.internal.database.helper.merge
+import im.vector.matrix.android.internal.database.model.ChunkEntity
+import im.vector.matrix.android.internal.session.room.timeline.PaginationDirection
+import im.vector.matrix.android.session.room.timeline.RoomDataHelper.createFakeListOfEvents
+import im.vector.matrix.android.session.room.timeline.RoomDataHelper.createFakeMessageEvent
+import im.vector.matrix.android.session.room.timeline.RoomDataHelper.createFakeRoomMemberEvent
+import io.realm.Realm
+import io.realm.RealmConfiguration
+import io.realm.kotlin.createObject
+import org.amshove.kluent.shouldBeFalse
+import org.amshove.kluent.shouldBeTrue
+import org.amshove.kluent.shouldEqual
+import org.junit.Before
+import org.junit.Test
+import org.junit.runner.RunWith
+
+
+@RunWith(AndroidJUnit4::class)
+internal class ChunkEntityTest : InstrumentedTest {
+
+ private lateinit var monarchy: Monarchy
+
+ @Before
+ fun setup() {
+ Realm.init(context())
+ val testConfig = RealmConfiguration.Builder().inMemory().name("test-realm").build()
+ monarchy = Monarchy.Builder().setRealmConfiguration(testConfig).build()
+ }
+
+
+ @Test
+ fun add_shouldAdd_whenNotAlreadyIncluded() {
+ monarchy.runTransactionSync { realm ->
+ val chunk: ChunkEntity = realm.createObject()
+ val fakeEvent = createFakeMessageEvent()
+ chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
+ chunk.timelineEvents.size shouldEqual 1
+ }
+ }
+
+ @Test
+ fun add_shouldNotAdd_whenAlreadyIncluded() {
+ monarchy.runTransactionSync { realm ->
+ val chunk: ChunkEntity = realm.createObject()
+ val fakeEvent = createFakeMessageEvent()
+ chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
+ chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
+ chunk.timelineEvents.size shouldEqual 1
+ }
+ }
+
+ @Test
+ fun add_shouldStateIndexIncremented_whenStateEventIsAddedForward() {
+ monarchy.runTransactionSync { realm ->
+ val chunk: ChunkEntity = realm.createObject()
+ val fakeEvent = createFakeRoomMemberEvent()
+ chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
+ chunk.lastStateIndex(PaginationDirection.FORWARDS) shouldEqual 1
+ }
+ }
+
+ @Test
+ fun add_shouldStateIndexNotIncremented_whenNoStateEventIsAdded() {
+ monarchy.runTransactionSync { realm ->
+ val chunk: ChunkEntity = realm.createObject()
+ val fakeEvent = createFakeMessageEvent()
+ chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
+ chunk.lastStateIndex(PaginationDirection.FORWARDS) shouldEqual 0
+ }
+ }
+
+ @Test
+ fun addAll_shouldStateIndexIncremented_whenStateEventsAreAddedForward() {
+ monarchy.runTransactionSync { realm ->
+ val chunk: ChunkEntity = realm.createObject()
+ val fakeEvents = createFakeListOfEvents(30)
+ val numberOfStateEvents = fakeEvents.filter { it.isStateEvent() }.size
+ chunk.addAll("roomId", fakeEvents, PaginationDirection.FORWARDS)
+ chunk.lastStateIndex(PaginationDirection.FORWARDS) shouldEqual numberOfStateEvents
+ }
+ }
+
+ @Test
+ fun addAll_shouldStateIndexDecremented_whenStateEventsAreAddedBackward() {
+ monarchy.runTransactionSync { realm ->
+ val chunk: ChunkEntity = realm.createObject()
+ val fakeEvents = createFakeListOfEvents(30)
+ val numberOfStateEvents = fakeEvents.filter { it.isStateEvent() }.size
+ val lastIsState = fakeEvents.last().isStateEvent()
+ val expectedStateIndex = if (lastIsState) -numberOfStateEvents + 1 else -numberOfStateEvents
+ chunk.addAll("roomId", fakeEvents, PaginationDirection.BACKWARDS)
+ chunk.lastStateIndex(PaginationDirection.BACKWARDS) shouldEqual expectedStateIndex
+ }
+ }
+
+ @Test
+ fun merge_shouldAddEvents_whenMergingBackward() {
+ monarchy.runTransactionSync { realm ->
+ val chunk1: ChunkEntity = realm.createObject()
+ val chunk2: ChunkEntity = realm.createObject()
+ chunk1.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS)
+ chunk2.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS)
+ chunk1.merge("roomId", chunk2, PaginationDirection.BACKWARDS)
+ chunk1.timelineEvents.size shouldEqual 60
+ }
+ }
+
+ @Test
+ fun merge_shouldAddOnlyDifferentEvents_whenMergingBackward() {
+ monarchy.runTransactionSync { realm ->
+ val chunk1: ChunkEntity = realm.createObject()
+ val chunk2: ChunkEntity = realm.createObject()
+ val eventsForChunk1 = createFakeListOfEvents(30)
+ val eventsForChunk2 = eventsForChunk1 + createFakeListOfEvents(10)
+ chunk1.isLastForward = true
+ chunk2.isLastForward = false
+ chunk1.addAll("roomId", eventsForChunk1, PaginationDirection.FORWARDS)
+ chunk2.addAll("roomId", eventsForChunk2, PaginationDirection.BACKWARDS)
+ chunk1.merge("roomId", chunk2, PaginationDirection.BACKWARDS)
+ chunk1.timelineEvents.size shouldEqual 40
+ chunk1.isLastForward.shouldBeTrue()
+ }
+ }
+
+ @Test
+ fun merge_shouldEventsBeLinked_whenMergingLinkedWithUnlinked() {
+ monarchy.runTransactionSync { realm ->
+ val chunk1: ChunkEntity = realm.createObject()
+ val chunk2: ChunkEntity = realm.createObject()
+ chunk1.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
+ chunk2.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = false)
+ chunk1.merge("roomId", chunk2, PaginationDirection.BACKWARDS)
+ chunk1.isUnlinked().shouldBeFalse()
+ }
+ }
+
+ @Test
+ fun merge_shouldEventsBeUnlinked_whenMergingUnlinkedWithUnlinked() {
+ monarchy.runTransactionSync { realm ->
+ val chunk1: ChunkEntity = realm.createObject()
+ val chunk2: ChunkEntity = realm.createObject()
+ chunk1.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
+ chunk2.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
+ chunk1.merge("roomId", chunk2, PaginationDirection.BACKWARDS)
+ chunk1.isUnlinked().shouldBeTrue()
+ }
+ }
+
+ @Test
+ fun merge_shouldPrevTokenMerged_whenMergingForwards() {
+ monarchy.runTransactionSync { realm ->
+ val chunk1: ChunkEntity = realm.createObject()
+ val chunk2: ChunkEntity = realm.createObject()
+ val prevToken = "prev_token"
+ chunk1.prevToken = prevToken
+ chunk1.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
+ chunk2.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
+ chunk1.merge("roomId", chunk2, PaginationDirection.FORWARDS)
+ chunk1.prevToken shouldEqual prevToken
+ }
+ }
+
+ @Test
+ fun merge_shouldNextTokenMerged_whenMergingBackwards() {
+ monarchy.runTransactionSync { realm ->
+ val chunk1: ChunkEntity = realm.createObject()
+ val chunk2: ChunkEntity = realm.createObject()
+ val nextToken = "next_token"
+ chunk1.nextToken = nextToken
+ chunk1.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
+ chunk2.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
+ chunk1.merge("roomId", chunk2, PaginationDirection.BACKWARDS)
+ chunk1.nextToken shouldEqual nextToken
+ }
+ }
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/FakeGetContextOfEventTask.kt b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/FakeGetContextOfEventTask.kt
new file mode 100644
index 00000000..f77c9b1a
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/FakeGetContextOfEventTask.kt
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.session.room.timeline
+
+import arrow.core.Try
+import im.vector.matrix.android.internal.session.room.timeline.GetContextOfEventTask
+import im.vector.matrix.android.internal.session.room.timeline.PaginationDirection
+import im.vector.matrix.android.internal.session.room.timeline.TokenChunkEventPersistor
+import kotlin.random.Random
+
+internal class FakeGetContextOfEventTask constructor(private val tokenChunkEventPersistor: TokenChunkEventPersistor) : GetContextOfEventTask {
+
+ override suspend fun execute(params: GetContextOfEventTask.Params): Try {
+ val fakeEvents = RoomDataHelper.createFakeListOfEvents(30)
+ val tokenChunkEvent = FakeTokenChunkEvent(
+ Random.nextLong(System.currentTimeMillis()).toString(),
+ Random.nextLong(System.currentTimeMillis()).toString(),
+ fakeEvents
+ )
+ return tokenChunkEventPersistor.insertInDb(tokenChunkEvent, params.roomId, PaginationDirection.BACKWARDS)
+ }
+
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/FakePaginationTask.kt b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/FakePaginationTask.kt
new file mode 100644
index 00000000..bf163401
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/FakePaginationTask.kt
@@ -0,0 +1,34 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.session.room.timeline
+
+import arrow.core.Try
+import im.vector.matrix.android.internal.session.room.timeline.PaginationTask
+import im.vector.matrix.android.internal.session.room.timeline.TokenChunkEventPersistor
+import javax.inject.Inject
+import kotlin.random.Random
+
+internal class FakePaginationTask @Inject constructor(private val tokenChunkEventPersistor: TokenChunkEventPersistor) : PaginationTask {
+
+ override suspend fun execute(params: PaginationTask.Params): Try {
+ val fakeEvents = RoomDataHelper.createFakeListOfEvents(30)
+ val tokenChunkEvent = FakeTokenChunkEvent(params.from, Random.nextLong(System.currentTimeMillis()).toString(), fakeEvents)
+ return tokenChunkEventPersistor.insertInDb(tokenChunkEvent, params.roomId, params.direction)
+ }
+
+}
+
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/FakeTokenChunkEvent.kt b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/FakeTokenChunkEvent.kt
new file mode 100644
index 00000000..2a9163e4
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/FakeTokenChunkEvent.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.session.room.timeline
+
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.internal.session.room.timeline.TokenChunkEvent
+
+internal data class FakeTokenChunkEvent(override val start: String?,
+ override val end: String?,
+ override val events: List = emptyList(),
+ override val stateEvents: List = emptyList()
+) : TokenChunkEvent
\ No newline at end of file
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/RoomDataHelper.kt b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/RoomDataHelper.kt
new file mode 100644
index 00000000..7ff69358
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/RoomDataHelper.kt
@@ -0,0 +1,93 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.session.room.timeline
+
+import com.zhuinden.monarchy.Monarchy
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.api.session.events.model.EventType
+import im.vector.matrix.android.api.session.events.model.toContent
+import im.vector.matrix.android.api.session.room.model.Membership
+import im.vector.matrix.android.api.session.room.model.RoomMember
+import im.vector.matrix.android.api.session.room.model.message.MessageTextContent
+import im.vector.matrix.android.api.session.room.model.message.MessageType
+import im.vector.matrix.android.internal.database.helper.addAll
+import im.vector.matrix.android.internal.database.helper.addOrUpdate
+import im.vector.matrix.android.internal.database.model.ChunkEntity
+import im.vector.matrix.android.internal.database.model.RoomEntity
+import im.vector.matrix.android.internal.session.room.timeline.PaginationDirection
+import io.realm.kotlin.createObject
+import kotlin.random.Random
+
+object RoomDataHelper {
+
+ private const val FAKE_TEST_SENDER = "@sender:test.org"
+ private val EVENT_FACTORIES = hashMapOf(
+ 0 to { createFakeMessageEvent() },
+ 1 to { createFakeRoomMemberEvent() }
+ )
+
+ fun createFakeListOfEvents(size: Int = 10): List {
+ return (0 until size).mapNotNull {
+ val nextInt = Random.nextInt(EVENT_FACTORIES.size)
+ EVENT_FACTORIES[nextInt]?.invoke()
+ }
+ }
+
+ fun createFakeEvent(type: String,
+ content: Content? = null,
+ prevContent: Content? = null,
+ sender: String = FAKE_TEST_SENDER,
+ stateKey: String = FAKE_TEST_SENDER
+ ): Event {
+ return Event(
+ type = type,
+ eventId = Random.nextLong().toString(),
+ content = content,
+ prevContent = prevContent,
+ senderId = sender,
+ stateKey = stateKey
+ )
+ }
+
+ fun createFakeMessageEvent(): Event {
+ val message = MessageTextContent(MessageType.MSGTYPE_TEXT, "Fake message #${Random.nextLong()}").toContent()
+ return createFakeEvent(EventType.MESSAGE, message)
+ }
+
+ fun createFakeRoomMemberEvent(): Event {
+ val roomMember = RoomMember(Membership.JOIN, "Fake name #${Random.nextLong()}").toContent()
+ return createFakeEvent(EventType.STATE_ROOM_MEMBER, roomMember)
+ }
+
+ fun fakeInitialSync(monarchy: Monarchy, roomId: String) {
+ monarchy.runTransactionSync { realm ->
+ val roomEntity = realm.createObject(roomId)
+ roomEntity.membership = Membership.JOIN
+ val eventList = createFakeListOfEvents(10)
+ val chunkEntity = realm.createObject().apply {
+ nextToken = null
+ prevToken = Random.nextLong(System.currentTimeMillis()).toString()
+ isLastForward = true
+ }
+ chunkEntity.addAll(roomId, eventList, PaginationDirection.FORWARDS)
+ roomEntity.addOrUpdate(chunkEntity)
+ }
+ }
+
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/TimelineTest.kt b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/TimelineTest.kt
new file mode 100644
index 00000000..f09b0376
--- /dev/null
+++ b/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/TimelineTest.kt
@@ -0,0 +1,86 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.session.room.timeline
+
+import com.zhuinden.monarchy.Monarchy
+import im.vector.matrix.android.InstrumentedTest
+
+internal class TimelineTest : InstrumentedTest {
+
+ companion object {
+ private const val ROOM_ID = "roomId"
+ }
+
+ private lateinit var monarchy: Monarchy
+
+// @Before
+// fun setup() {
+// Timber.plant(Timber.DebugTree())
+// Realm.init(context())
+// val testConfiguration = RealmConfiguration.Builder().name("test-realm")
+// .modules(SessionRealmModule()).build()
+//
+// Realm.deleteRealm(testConfiguration)
+// monarchy = Monarchy.Builder().setRealmConfiguration(testConfiguration).build()
+// RoomDataHelper.fakeInitialSync(monarchy, ROOM_ID)
+// }
+//
+// private fun createTimeline(initialEventId: String? = null): Timeline {
+// val taskExecutor = TaskExecutor(testCoroutineDispatchers)
+// val tokenChunkEventPersistor = TokenChunkEventPersistor(monarchy)
+// val paginationTask = FakePaginationTask @Inject constructor(tokenChunkEventPersistor)
+// val getContextOfEventTask = FakeGetContextOfEventTask @Inject constructor(tokenChunkEventPersistor)
+// val roomMemberExtractor = SenderRoomMemberExtractor(ROOM_ID)
+// val timelineEventFactory = TimelineEventFactory(roomMemberExtractor, EventRelationExtractor())
+// return DefaultTimeline(
+// ROOM_ID,
+// initialEventId,
+// monarchy.realmConfiguration,
+// taskExecutor,
+// getContextOfEventTask,
+// timelineEventFactory,
+// paginationTask,
+// null)
+// }
+//
+// @Test
+// fun backPaginate_shouldLoadMoreEvents_whenPaginateIsCalled() {
+// val timeline = createTimeline()
+// timeline.start()
+// val paginationCount = 30
+// var initialLoad = 0
+// val latch = CountDownLatch(2)
+// var timelineEvents: List = emptyList()
+// timeline.listener = object : Timeline.Listener {
+// override fun onUpdated(snapshot: List) {
+// if (snapshot.isNotEmpty()) {
+// if (initialLoad == 0) {
+// initialLoad = snapshot.size
+// }
+// timelineEvents = snapshot
+// latch.countDown()
+// timeline.paginate(Timeline.Direction.BACKWARDS, paginationCount)
+// }
+// }
+// }
+// latch.await()
+// timelineEvents.size shouldEqual initialLoad + paginationCount
+// timeline.dispose()
+// }
+
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/debug/java/im/vector/matrix/android/internal/network/interceptors/CurlLoggingInterceptor.kt b/matrix-sdk-android/src/debug/java/im/vector/matrix/android/internal/network/interceptors/CurlLoggingInterceptor.kt
new file mode 100644
index 00000000..3d499be3
--- /dev/null
+++ b/matrix-sdk-android/src/debug/java/im/vector/matrix/android/internal/network/interceptors/CurlLoggingInterceptor.kt
@@ -0,0 +1,102 @@
+/*
+ * Copyright (C) 2016 Jeff Gilfelt.
+ * Copyright 2019 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 im.vector.matrix.android.internal.network.interceptors
+
+import im.vector.matrix.android.internal.di.MatrixScope
+import okhttp3.Interceptor
+import okhttp3.Response
+import okhttp3.logging.HttpLoggingInterceptor
+import okio.Buffer
+import java.io.IOException
+import java.nio.charset.Charset
+import javax.inject.Inject
+
+/**
+ * An OkHttp interceptor that logs requests as curl shell commands. They can then
+ * be copied, pasted and executed inside a terminal environment. This might be
+ * useful for troubleshooting client/server API interaction during development,
+ * making it easy to isolate and share requests made by the app. Warning: The
+ * logs generated by this interceptor have the potential to leak sensitive
+ * information. It should only be used in a controlled manner or in a
+ * non-production environment.
+ */
+@MatrixScope
+internal class CurlLoggingInterceptor @Inject constructor(private val logger: HttpLoggingInterceptor.Logger)
+ : Interceptor {
+
+ /**
+ * Set any additional curl command options (see 'curl --help').
+ */
+ var curlOptions: String? = null
+
+ @Throws(IOException::class)
+ override fun intercept(chain: Interceptor.Chain): Response {
+ val request = chain.request()
+
+ var compressed = false
+
+ var curlCmd = "curl"
+ if (curlOptions != null) {
+ curlCmd += " " + curlOptions!!
+ }
+ curlCmd += " -X " + request.method()
+
+ val requestBody = request.body()
+ if (requestBody != null) {
+ val buffer = Buffer()
+ requestBody.writeTo(buffer)
+ var charset: Charset? = UTF8
+ val contentType = requestBody.contentType()
+ if (contentType != null) {
+ charset = contentType.charset(UTF8)
+ }
+ // try to keep to a single line and use a subshell to preserve any line breaks
+ curlCmd += " --data $'" + buffer.readString(charset!!).replace("\n", "\\n") + "'"
+ }
+
+ val headers = request.headers()
+ var i = 0
+ val count = headers.size()
+ while (i < count) {
+ val name = headers.name(i)
+ val value = headers.value(i)
+ if ("Accept-Encoding".equals(name, ignoreCase = true) && "gzip".equals(value, ignoreCase = true)) {
+ compressed = true
+ }
+ curlCmd += " -H \"$name: $value\""
+ i++
+ }
+
+ curlCmd += ((if (compressed) " --compressed " else " ") + "'" + request.url().toString()
+ // Replace localhost for emulator by localhost for shell
+ .replace("://10.0.2.2:8080/".toRegex(), "://127.0.0.1:8080/")
+ + "'")
+
+ // Add Json formatting
+ curlCmd += " | python -m json.tool"
+
+ logger.log("--- cURL (" + request.url() + ")")
+ logger.log(curlCmd)
+
+ return chain.proceed(request)
+ }
+
+ companion object {
+ private val UTF8 = Charset.forName("UTF-8")
+ }
+}
diff --git a/matrix-sdk-android/src/debug/java/im/vector/matrix/android/internal/network/interceptors/FormattedJsonHttpLogger.kt b/matrix-sdk-android/src/debug/java/im/vector/matrix/android/internal/network/interceptors/FormattedJsonHttpLogger.kt
new file mode 100644
index 00000000..655134d1
--- /dev/null
+++ b/matrix-sdk-android/src/debug/java/im/vector/matrix/android/internal/network/interceptors/FormattedJsonHttpLogger.kt
@@ -0,0 +1,76 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.network.interceptors
+
+import androidx.annotation.NonNull
+import im.vector.matrix.android.BuildConfig
+import okhttp3.logging.HttpLoggingInterceptor
+import org.json.JSONArray
+import org.json.JSONException
+import org.json.JSONObject
+import timber.log.Timber
+
+class FormattedJsonHttpLogger : HttpLoggingInterceptor.Logger {
+
+ companion object {
+ private const val INDENT_SPACE = 2
+ }
+
+ /**
+ * Log the message and try to log it again as a JSON formatted string
+ * Note: it can consume a lot of memory but it is only in DEBUG mode
+ *
+ * @param message
+ */
+ @Synchronized
+ override fun log(@NonNull message: String) {
+ // In RELEASE there is no log, but for sure, test again BuildConfig.DEBUG
+ if (BuildConfig.DEBUG) {
+ Timber.v(message)
+
+ if (message.startsWith("{")) {
+ // JSON Detected
+ try {
+ val o = JSONObject(message)
+ logJson(o.toString(INDENT_SPACE))
+ } catch (e: JSONException) {
+ // Finally this is not a JSON string...
+ Timber.e(e)
+ }
+
+ } else if (message.startsWith("[")) {
+ // JSON Array detected
+ try {
+ val o = JSONArray(message)
+ logJson(o.toString(INDENT_SPACE))
+ } catch (e: JSONException) {
+ // Finally not JSON...
+ Timber.e(e)
+ }
+
+ }
+ // Else not a json string to log
+ }
+ }
+
+ private fun logJson(formattedJson: String) {
+ val arr = formattedJson.split("\n".toRegex()).dropLastWhile { it.isEmpty() }.toTypedArray()
+ for (s in arr) {
+ Timber.v(s)
+ }
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/AndroidManifest.xml b/matrix-sdk-android/src/main/AndroidManifest.xml
index 90cd94ab..7191d9c8 100644
--- a/matrix-sdk-android/src/main/AndroidManifest.xml
+++ b/matrix-sdk-android/src/main/AndroidManifest.xml
@@ -1,2 +1,19 @@
+ xmlns:tools="http://schemas.android.com/tools"
+ package="im.vector.matrix.android">
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/Matrix.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/Matrix.kt
new file mode 100644
index 00000000..bdc988d2
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/Matrix.kt
@@ -0,0 +1,102 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api
+
+import android.content.Context
+import androidx.lifecycle.ProcessLifecycleOwner
+import androidx.work.Configuration
+import androidx.work.WorkManager
+import com.zhuinden.monarchy.Monarchy
+import im.vector.matrix.android.BuildConfig
+import im.vector.matrix.android.api.auth.Authenticator
+import im.vector.matrix.android.internal.SessionManager
+import im.vector.matrix.android.internal.di.DaggerMatrixComponent
+import im.vector.matrix.android.internal.network.UserAgentHolder
+import im.vector.matrix.android.internal.util.BackgroundDetectionObserver
+import org.matrix.olm.OlmManager
+import java.util.concurrent.atomic.AtomicBoolean
+import javax.inject.Inject
+
+data class MatrixConfiguration(
+ val applicationFlavor: String = "Default-application-flavor"
+) {
+
+ interface Provider {
+ fun providesMatrixConfiguration(): MatrixConfiguration
+ }
+
+}
+
+/**
+ * This is the main entry point to the matrix sdk.
+ * To get the singleton instance, use getInstance static method.
+ */
+class Matrix private constructor(context: Context, matrixConfiguration: MatrixConfiguration) {
+
+ @Inject internal lateinit var authenticator: Authenticator
+ @Inject internal lateinit var userAgentHolder: UserAgentHolder
+ @Inject internal lateinit var backgroundDetectionObserver: BackgroundDetectionObserver
+ @Inject internal lateinit var olmManager: OlmManager
+ @Inject internal lateinit var sessionManager: SessionManager
+
+ init {
+ Monarchy.init(context)
+ DaggerMatrixComponent.factory().create(context).inject(this)
+ if (context.applicationContext !is Configuration.Provider) {
+ WorkManager.initialize(context, Configuration.Builder().build())
+ }
+ ProcessLifecycleOwner.get().lifecycle.addObserver(backgroundDetectionObserver)
+ userAgentHolder.setApplicationFlavor(matrixConfiguration.applicationFlavor)
+ }
+
+ fun getUserAgent() = userAgentHolder.userAgent
+
+ fun authenticator(): Authenticator {
+ return authenticator
+ }
+
+ companion object {
+
+ private lateinit var instance: Matrix
+ private val isInit = AtomicBoolean(false)
+
+ fun initialize(context: Context, matrixConfiguration: MatrixConfiguration) {
+ if (isInit.compareAndSet(false, true)) {
+ instance = Matrix(context.applicationContext, matrixConfiguration)
+ }
+ }
+
+ fun getInstance(context: Context): Matrix {
+ if (isInit.compareAndSet(false, true)) {
+ val appContext = context.applicationContext
+ if (appContext is MatrixConfiguration.Provider) {
+ val matrixConfiguration = (appContext as MatrixConfiguration.Provider).providesMatrixConfiguration()
+ instance = Matrix(appContext, matrixConfiguration)
+ } else {
+ throw IllegalStateException("Matrix is not initialized properly." +
+ " You should call Matrix.initialize or let your application implements MatrixConfiguration.Provider.")
+ }
+ }
+ return instance
+ }
+
+ fun getSdkVersion(): String {
+ return BuildConfig.VERSION_NAME + " (" + BuildConfig.GIT_SDK_REVISION + ")"
+ }
+ }
+
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/MatrixCallback.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/MatrixCallback.kt
new file mode 100644
index 00000000..00d22b1f
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/MatrixCallback.kt
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api
+
+/**
+ * Generic callback interface for asynchronously.
+ * @param the type of data to return on success
+ */
+interface MatrixCallback {
+
+ /**
+ * On success method, default to no-op
+ * @param data the data successfully returned from the async function
+ */
+ fun onSuccess(data: T) {
+ //no-op
+ }
+
+ /**
+ * On failure method, default to no-op
+ * @param failure the failure data returned from the async function
+ */
+ fun onFailure(failure: Throwable) {
+ //no-op
+ }
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/MatrixPatterns.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/MatrixPatterns.kt
new file mode 100644
index 00000000..5cb7f4ca
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/MatrixPatterns.kt
@@ -0,0 +1,140 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api
+
+
+/**
+ * This class contains pattern to match the different Matrix ids
+ */
+object MatrixPatterns {
+
+ // Note: TLD is not mandatory (localhost, IP address...)
+ private const val DOMAIN_REGEX = ":[A-Z0-9.-]+(:[0-9]{2,5})?"
+
+ // regex pattern to find matrix user ids in a string.
+ // See https://matrix.org/speculator/spec/HEAD/appendices.html#historical-user-ids
+ private const val MATRIX_USER_IDENTIFIER_REGEX = "@[A-Z0-9\\x21-\\x39\\x3B-\\x7F]+$DOMAIN_REGEX"
+ private val PATTERN_CONTAIN_MATRIX_USER_IDENTIFIER = MATRIX_USER_IDENTIFIER_REGEX.toRegex(RegexOption.IGNORE_CASE)
+
+ // regex pattern to find room ids in a string.
+ private const val MATRIX_ROOM_IDENTIFIER_REGEX = "![A-Z0-9]+$DOMAIN_REGEX"
+ private val PATTERN_CONTAIN_MATRIX_ROOM_IDENTIFIER = MATRIX_ROOM_IDENTIFIER_REGEX.toRegex(RegexOption.IGNORE_CASE)
+
+ // regex pattern to find room aliases in a string.
+ private const val MATRIX_ROOM_ALIAS_REGEX = "#[A-Z0-9._%#@=+-]+$DOMAIN_REGEX"
+ private val PATTERN_CONTAIN_MATRIX_ALIAS = MATRIX_ROOM_ALIAS_REGEX.toRegex(RegexOption.IGNORE_CASE)
+
+ // regex pattern to find message ids in a string.
+ private const val MATRIX_EVENT_IDENTIFIER_REGEX = "\\$[A-Z0-9]+$DOMAIN_REGEX"
+ private val PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER = MATRIX_EVENT_IDENTIFIER_REGEX.toRegex(RegexOption.IGNORE_CASE)
+
+ // regex pattern to find message ids in a string.
+ private const val MATRIX_EVENT_IDENTIFIER_V3_REGEX = "\\$[A-Z0-9/+]+"
+ private val PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER_V3 = MATRIX_EVENT_IDENTIFIER_V3_REGEX.toRegex(RegexOption.IGNORE_CASE)
+
+ // Ref: https://matrix.org/docs/spec/rooms/v4#event-ids
+ private const val MATRIX_EVENT_IDENTIFIER_V4_REGEX = "\\$[A-Z0-9\\-_]+"
+ private val PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER_V4 = MATRIX_EVENT_IDENTIFIER_V4_REGEX.toRegex(RegexOption.IGNORE_CASE)
+
+ // regex pattern to find group ids in a string.
+ private const val MATRIX_GROUP_IDENTIFIER_REGEX = "\\+[A-Z0-9=_\\-./]+$DOMAIN_REGEX"
+ private val PATTERN_CONTAIN_MATRIX_GROUP_IDENTIFIER = MATRIX_GROUP_IDENTIFIER_REGEX.toRegex(RegexOption.IGNORE_CASE)
+
+ // regex pattern to find permalink with message id.
+ // Android does not support in URL so extract it.
+ private const val PERMALINK_BASE_REGEX = "https://matrix\\.to/#/"
+ private const val APP_BASE_REGEX = "https://[A-Z0-9.-]+\\.[A-Z]{2,}/[A-Z]{3,}/#/room/"
+ const val SEP_REGEX = "/"
+
+ private const val LINK_TO_ROOM_ID_REGEXP = PERMALINK_BASE_REGEX + MATRIX_ROOM_IDENTIFIER_REGEX + SEP_REGEX + MATRIX_EVENT_IDENTIFIER_REGEX
+ private val PATTERN_CONTAIN_MATRIX_TO_PERMALINK_ROOM_ID = LINK_TO_ROOM_ID_REGEXP.toRegex(RegexOption.IGNORE_CASE)
+
+ private const val LINK_TO_ROOM_ALIAS_REGEXP = PERMALINK_BASE_REGEX + MATRIX_ROOM_ALIAS_REGEX + SEP_REGEX + MATRIX_EVENT_IDENTIFIER_REGEX
+ private val PATTERN_CONTAIN_MATRIX_TO_PERMALINK_ROOM_ALIAS = LINK_TO_ROOM_ALIAS_REGEXP.toRegex(RegexOption.IGNORE_CASE)
+
+ private const val LINK_TO_APP_ROOM_ID_REGEXP = APP_BASE_REGEX + MATRIX_ROOM_IDENTIFIER_REGEX + SEP_REGEX + MATRIX_EVENT_IDENTIFIER_REGEX
+ private val PATTERN_CONTAIN_APP_LINK_PERMALINK_ROOM_ID = LINK_TO_APP_ROOM_ID_REGEXP.toRegex(RegexOption.IGNORE_CASE)
+
+ private const val LINK_TO_APP_ROOM_ALIAS_REGEXP = APP_BASE_REGEX + MATRIX_ROOM_ALIAS_REGEX + SEP_REGEX + MATRIX_EVENT_IDENTIFIER_REGEX
+ private val PATTERN_CONTAIN_APP_LINK_PERMALINK_ROOM_ALIAS = LINK_TO_APP_ROOM_ALIAS_REGEXP.toRegex(RegexOption.IGNORE_CASE)
+
+ // list of patterns to find some matrix item.
+ val MATRIX_PATTERNS = listOf(
+ PATTERN_CONTAIN_MATRIX_TO_PERMALINK_ROOM_ID,
+ PATTERN_CONTAIN_MATRIX_TO_PERMALINK_ROOM_ALIAS,
+ PATTERN_CONTAIN_APP_LINK_PERMALINK_ROOM_ID,
+ PATTERN_CONTAIN_APP_LINK_PERMALINK_ROOM_ALIAS,
+ PATTERN_CONTAIN_MATRIX_USER_IDENTIFIER,
+ PATTERN_CONTAIN_MATRIX_ALIAS,
+ PATTERN_CONTAIN_MATRIX_ROOM_IDENTIFIER,
+ PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER,
+ PATTERN_CONTAIN_MATRIX_GROUP_IDENTIFIER
+ )
+
+ /**
+ * Tells if a string is a valid user Id.
+ *
+ * @param str the string to test
+ * @return true if the string is a valid user id
+ */
+ fun isUserId(str: String?): Boolean {
+ return str != null && str matches PATTERN_CONTAIN_MATRIX_USER_IDENTIFIER
+ }
+
+ /**
+ * Tells if a string is a valid room id.
+ *
+ * @param str the string to test
+ * @return true if the string is a valid room Id
+ */
+ fun isRoomId(str: String?): Boolean {
+ return str != null && str matches PATTERN_CONTAIN_MATRIX_ROOM_IDENTIFIER
+ }
+
+ /**
+ * Tells if a string is a valid room alias.
+ *
+ * @param str the string to test
+ * @return true if the string is a valid room alias.
+ */
+ fun isRoomAlias(str: String?): Boolean {
+ return str != null && str matches PATTERN_CONTAIN_MATRIX_ALIAS
+ }
+
+ /**
+ * Tells if a string is a valid event id.
+ *
+ * @param str the string to test
+ * @return true if the string is a valid event id.
+ */
+ fun isEventId(str: String?): Boolean {
+ return str != null
+ && (str matches PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER
+ || str matches PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER_V3
+ || str matches PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER_V4)
+ }
+
+ /**
+ * Tells if a string is a valid group id.
+ *
+ * @param str the string to test
+ * @return true if the string is a valid group id.
+ */
+ fun isGroupId(str: String?): Boolean {
+ return str != null && str matches PATTERN_CONTAIN_MATRIX_GROUP_IDENTIFIER
+ }
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/Authenticator.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/Authenticator.kt
new file mode 100644
index 00000000..932ffbea
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/Authenticator.kt
@@ -0,0 +1,59 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.auth
+
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.auth.data.HomeServerConnectionConfig
+import im.vector.matrix.android.api.auth.data.SessionParams
+import im.vector.matrix.android.api.session.Session
+import im.vector.matrix.android.api.util.Cancelable
+
+/**
+ * This interface defines methods to authenticate to a matrix server.
+ */
+interface Authenticator {
+
+ /**
+ * @param homeServerConnectionConfig this param is used to configure the Homeserver
+ * @param login the login field
+ * @param password the password field
+ * @param callback the matrix callback on which you'll receive the result of authentication.
+ * @return return a [Cancelable]
+ */
+ fun authenticate(homeServerConnectionConfig: HomeServerConnectionConfig, login: String, password: String, callback: MatrixCallback): Cancelable
+
+ /**
+ * Check if there is an authenticated [Session].
+ * @return true if there is at least one active session.
+ */
+ fun hasAuthenticatedSessions(): Boolean
+
+ /**
+ * Get the last authenticated [Session], if there is an active session.
+ * @return the last active session if any, or null
+ */
+ fun getLastAuthenticatedSession(): Session?
+
+ /**
+ * Get an authenticated session. You should at least call authenticate one time before.
+ * If you logout, this session will no longer be valid.
+ *
+ * @param sessionParams the sessionParams to open with.
+ * @return the associated session if any, or null
+ */
+ fun getSession(sessionParams: SessionParams): Session?
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/Credentials.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/Credentials.kt
new file mode 100644
index 00000000..d5962e26
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/Credentials.kt
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.auth.data
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * This data class hold credentials user data.
+ * You shouldn't have to instantiate it.
+ * The access token should be use to authenticate user in all server requests.
+ */
+@JsonClass(generateAdapter = true)
+data class Credentials(
+ @Json(name = "user_id") val userId: String,
+ @Json(name = "home_server") val homeServer: String,
+ @Json(name = "access_token") val accessToken: String,
+ @Json(name = "refresh_token") val refreshToken: String?,
+ @Json(name = "device_id") val deviceId: String?)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/HomeServerConnectionConfig.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/HomeServerConnectionConfig.kt
new file mode 100644
index 00000000..f231d3f1
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/HomeServerConnectionConfig.kt
@@ -0,0 +1,265 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.auth.data
+
+import android.net.Uri
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.auth.data.HomeServerConnectionConfig.Builder
+import im.vector.matrix.android.internal.network.ssl.Fingerprint
+import okhttp3.CipherSuite
+import okhttp3.TlsVersion
+
+/**
+ * This data class holds how to connect to a specific Homeserver.
+ * It's used with [im.vector.matrix.android.api.auth.Authenticator] class.
+ * You should use the [Builder] to create one.
+ */
+@JsonClass(generateAdapter = true)
+data class HomeServerConnectionConfig(
+ val homeServerUri: Uri,
+ val identityServerUri: Uri,
+ val antiVirusServerUri: Uri? = null,
+ val allowedFingerprints: MutableList = ArrayList(),
+ val shouldPin: Boolean = false,
+ val tlsVersions: MutableList? = null,
+ val tlsCipherSuites: MutableList? = null,
+ val shouldAcceptTlsExtensions: Boolean = true,
+ val allowHttpExtension: Boolean = false,
+ val forceUsageTlsVersions: Boolean = false
+) {
+
+ /**
+ * This builder should be use to create a [HomeServerConnectionConfig] instance.
+ */
+ class Builder {
+
+ private lateinit var homeServerUri: Uri
+ private lateinit var identityServerUri: Uri
+ private var antiVirusServerUri: Uri? = null
+ private val allowedFingerprints: MutableList = ArrayList()
+ private var shouldPin: Boolean = false
+ private val tlsVersions: MutableList = ArrayList()
+ private val tlsCipherSuites: MutableList = ArrayList()
+ private var shouldAcceptTlsExtensions: Boolean = true
+ private var allowHttpExtension: Boolean = false
+ private var forceUsageTlsVersions: Boolean = false
+
+ fun withHomeServerUri(hsUriString: String): Builder {
+ return withHomeServerUri(Uri.parse(hsUriString))
+ }
+
+ /**
+ * @param hsUri The URI to use to connect to the homeserver.
+ * @return this builder
+ */
+ fun withHomeServerUri(hsUri: Uri): Builder {
+ if (hsUri.scheme != "http" && hsUri.scheme != "https") {
+ throw RuntimeException("Invalid home server URI: " + hsUri)
+ }
+ // ensure trailing /
+ homeServerUri = if (!hsUri.toString().endsWith("/")) {
+ try {
+ val url = hsUri.toString()
+ Uri.parse("$url/")
+ } catch (e: Exception) {
+ throw RuntimeException("Invalid home server URI: $hsUri")
+ }
+ } else {
+ hsUri
+ }
+ return this
+ }
+
+ fun withIdentityServerUri(identityServerUriString: String): Builder {
+ return withIdentityServerUri(Uri.parse(identityServerUriString))
+ }
+
+ /**
+ * @param identityServerUri The URI to use to manage identity.
+ * @return this builder
+ */
+ fun withIdentityServerUri(identityServerUri: Uri): Builder {
+ if (identityServerUri.scheme != "http" && identityServerUri.scheme != "https") {
+ throw RuntimeException("Invalid identity server URI: $identityServerUri")
+ }
+ // ensure trailing /
+ if (!identityServerUri.toString().endsWith("/")) {
+ try {
+ val url = identityServerUri.toString()
+ this.identityServerUri = Uri.parse("$url/")
+ } catch (e: Exception) {
+ throw RuntimeException("Invalid identity server URI: $identityServerUri")
+ }
+ } else {
+ this.identityServerUri = identityServerUri
+ }
+ return this
+ }
+
+ /**
+ * @param allowedFingerprints If using SSL, allow server certs that match these fingerprints.
+ * @return this builder
+ */
+ fun withAllowedFingerPrints(allowedFingerprints: List?): Builder {
+ if (allowedFingerprints != null) {
+ this.allowedFingerprints.addAll(allowedFingerprints)
+ }
+ return this
+ }
+
+ /**
+ * @param pin If true only allow certs matching given fingerprints, otherwise fallback to
+ * standard X509 checks.
+ * @return this builder
+ */
+ fun withPin(pin: Boolean): Builder {
+ this.shouldPin = pin
+ return this
+ }
+
+ /**
+ * @param shouldAcceptTlsExtension
+ * @return this builder
+ */
+ fun withShouldAcceptTlsExtensions(shouldAcceptTlsExtension: Boolean): Builder {
+ this.shouldAcceptTlsExtensions = shouldAcceptTlsExtension
+ return this
+ }
+
+ /**
+ * Add an accepted TLS version for TLS connections with the home server.
+ *
+ * @param tlsVersion the tls version to add to the set of TLS versions accepted.
+ * @return this builder
+ */
+ fun addAcceptedTlsVersion(tlsVersion: TlsVersion): Builder {
+ this.tlsVersions.add(tlsVersion)
+ return this
+ }
+
+ /**
+ * Force the usage of TlsVersion. This can be usefull for device on Android version < 20
+ *
+ * @param forceUsageOfTlsVersions set to true to force the usage of specified TlsVersions (with [.addAcceptedTlsVersion]
+ * @return this builder
+ */
+ fun forceUsageOfTlsVersions(forceUsageOfTlsVersions: Boolean): Builder {
+ this.forceUsageTlsVersions = forceUsageOfTlsVersions
+ return this
+ }
+
+ /**
+ * Add a TLS cipher suite to the list of accepted TLS connections with the home server.
+ *
+ * @param tlsCipherSuite the tls cipher suite to add.
+ * @return this builder
+ */
+ fun addAcceptedTlsCipherSuite(tlsCipherSuite: CipherSuite): Builder {
+ this.tlsCipherSuites.add(tlsCipherSuite)
+ return this
+ }
+
+ fun withAntiVirusServerUri(antivirusServerUriString: String?): Builder {
+ return withAntiVirusServerUri(antivirusServerUriString?.let { Uri.parse(it) })
+ }
+
+ /**
+ * Update the anti-virus server URI.
+ *
+ * @param antivirusServerUri the new anti-virus uri. Can be null
+ * @return this builder
+ */
+ fun withAntiVirusServerUri(antivirusServerUri: Uri?): Builder {
+ if (null != antivirusServerUri && "http" != antivirusServerUri.scheme && "https" != antivirusServerUri.scheme) {
+ throw RuntimeException("Invalid antivirus server URI: $antivirusServerUri")
+ }
+ this.antiVirusServerUri = antivirusServerUri
+ return this
+ }
+
+ /**
+ * Convenient method to limit the TLS versions and cipher suites for this Builder
+ * Ref:
+ * - https://www.ssi.gouv.fr/uploads/2017/02/security-recommendations-for-tls_v1.1.pdf
+ * - https://developer.android.com/reference/javax/net/ssl/SSLEngine
+ *
+ * @param tlsLimitations true to use Tls limitations
+ * @param enableCompatibilityMode set to true for Android < 20
+ * @return this builder
+ */
+ fun withTlsLimitations(tlsLimitations: Boolean, enableCompatibilityMode: Boolean): Builder {
+ if (tlsLimitations) {
+ withShouldAcceptTlsExtensions(false)
+
+ // Tls versions
+ addAcceptedTlsVersion(TlsVersion.TLS_1_2)
+ addAcceptedTlsVersion(TlsVersion.TLS_1_3)
+
+ forceUsageOfTlsVersions(enableCompatibilityMode)
+
+ // Cipher suites
+ addAcceptedTlsCipherSuite(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256)
+ addAcceptedTlsCipherSuite(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256)
+ addAcceptedTlsCipherSuite(CipherSuite.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256)
+ addAcceptedTlsCipherSuite(CipherSuite.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256)
+ addAcceptedTlsCipherSuite(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384)
+ addAcceptedTlsCipherSuite(CipherSuite.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384)
+ addAcceptedTlsCipherSuite(CipherSuite.TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256)
+ addAcceptedTlsCipherSuite(CipherSuite.TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256)
+
+ if (enableCompatibilityMode) {
+ // Adopt some preceding cipher suites for Android < 20 to be able to negotiate
+ // a TLS session.
+ addAcceptedTlsCipherSuite(CipherSuite.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA)
+ addAcceptedTlsCipherSuite(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA)
+ }
+ }
+ return this
+ }
+
+ fun withAllowHttpConnection(allowHttpExtension: Boolean): Builder {
+ this.allowHttpExtension = allowHttpExtension
+ return this
+ }
+
+ /**
+ * @return the [HomeServerConnectionConfig]
+ */
+ fun build(): HomeServerConnectionConfig {
+ return HomeServerConnectionConfig(
+ homeServerUri,
+ identityServerUri,
+ antiVirusServerUri,
+ allowedFingerprints,
+ shouldPin,
+ tlsVersions,
+ tlsCipherSuites,
+ shouldAcceptTlsExtensions,
+ allowHttpExtension,
+ forceUsageTlsVersions
+ )
+ }
+
+ }
+
+
+}
+
+
+
+
+
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/SessionParams.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/SessionParams.kt
new file mode 100644
index 00000000..a104f2c0
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/SessionParams.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.auth.data
+
+/**
+ * This data class holds necessary data to open a session.
+ * You don't have to manually instantiate it.
+ */
+data class SessionParams(
+ val credentials: Credentials,
+ val homeServerConnectionConfig: HomeServerConnectionConfig
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/comparators/DatedObjectComparators.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/comparators/DatedObjectComparators.kt
new file mode 100644
index 00000000..aad33ab7
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/comparators/DatedObjectComparators.kt
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.comparators
+
+import im.vector.matrix.android.api.interfaces.DatedObject
+import java.util.*
+
+object DatedObjectComparators {
+
+ /**
+ * Comparator to sort DatedObjects from the oldest to the latest.
+ */
+ val ascComparator by lazy {
+ Comparator { datedObject1, datedObject2 ->
+ (datedObject1.date - datedObject2.date).toInt()
+ }
+ }
+
+ /**
+ * Comparator to sort DatedObjects from the latest to the oldest.
+ */
+ val descComparator by lazy {
+ Comparator { datedObject1, datedObject2 ->
+ (datedObject2.date - datedObject1.date).toInt()
+ }
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/extensions/MatrixSdkExtensions.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/extensions/MatrixSdkExtensions.kt
new file mode 100644
index 00000000..e2e53904
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/extensions/MatrixSdkExtensions.kt
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2018 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 im.vector.matrix.android.api.extensions
+
+import im.vector.matrix.android.api.comparators.DatedObjectComparators
+import im.vector.matrix.android.internal.crypto.model.MXDeviceInfo
+import im.vector.matrix.android.internal.crypto.model.rest.DeviceInfo
+import java.util.*
+
+/* ==========================================================================================
+ * MXDeviceInfo
+ * ========================================================================================== */
+
+fun MXDeviceInfo.getFingerprintHumanReadable() = fingerprint()
+ ?.chunked(4)
+ ?.joinToString(separator = " ")
+
+
+fun List.sortByLastSeen() {
+ Collections.sort(this, DatedObjectComparators.descComparator)
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/failure/Failure.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/failure/Failure.kt
new file mode 100644
index 00000000..152adb06
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/failure/Failure.kt
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.failure
+
+import im.vector.matrix.android.api.session.crypto.MXCryptoError
+import im.vector.matrix.android.internal.auth.registration.RegistrationFlowResponse
+import java.io.IOException
+
+/**
+ * This class allows to expose different kinds of error to be then handled by the application.
+ * As it is a sealed class, you typically use it like that :
+ * when(failure) {
+ * is NetworkConnection -> Unit
+ * is ServerError -> Unit
+ * is Unknown -> Unit
+ * }
+ */
+sealed class Failure(cause: Throwable? = null) : Throwable(cause = cause) {
+ data class Unknown(val throwable: Throwable? = null) : Failure(throwable)
+ data class NetworkConnection(val ioException: IOException? = null) : Failure(ioException)
+ data class ServerError(val error: MatrixError, val httpCode: Int) : Failure(RuntimeException(error.toString()))
+ // When server send an error, but it cannot be interpreted as a MatrixError
+ data class OtherServerError(val errorBody: String, val httpCode: Int) : Failure(RuntimeException(errorBody))
+
+ data class RegistrationFlowError(val registrationFlowResponse: RegistrationFlowResponse) : Failure(RuntimeException(registrationFlowResponse.toString()))
+
+ data class CryptoError(val error: MXCryptoError) : Failure(error)
+
+ abstract class FeatureFailure : Failure()
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-core/src/main/java/im/vector/matrix/core/api/failure/MatrixError.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/failure/MatrixError.kt
similarity index 53%
rename from matrix-sdk-core/src/main/java/im/vector/matrix/core/api/failure/MatrixError.kt
rename to matrix-sdk-android/src/main/java/im/vector/matrix/android/api/failure/MatrixError.kt
index d8cfa155..1e87cfc1 100644
--- a/matrix-sdk-core/src/main/java/im/vector/matrix/core/api/failure/MatrixError.kt
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/failure/MatrixError.kt
@@ -1,14 +1,39 @@
-package im.vector.matrix.core.api.failure
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.failure
import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
-data class MatrixError(@Json(name = "errcode") val code: String,
- @Json(name = "error") val message: String) {
+/**
+ * This data class holds the error defined by the matrix specifications.
+ * You shouldn't have to instantiate it.
+ */
+@JsonClass(generateAdapter = true)
+data class MatrixError(
+ @Json(name = "errcode") val code: String,
+ @Json(name = "error") val message: String
+) {
companion object {
const val FORBIDDEN = "M_FORBIDDEN"
const val UNKNOWN = "M_UNKNOWN"
const val UNKNOWN_TOKEN = "M_UNKNOWN_TOKEN"
+ const val MISSING_TOKEN = "M_MISSING_TOKEN"
const val BAD_JSON = "M_BAD_JSON"
const val NOT_JSON = "M_NOT_JSON"
const val NOT_FOUND = "M_NOT_FOUND"
@@ -29,5 +54,6 @@ data class MatrixError(@Json(name = "errcode") val code: String,
const val TOO_LARGE = "M_TOO_LARGE"
const val M_CONSENT_NOT_GIVEN = "M_CONSENT_NOT_GIVEN"
const val RESOURCE_LIMIT_EXCEEDED = "M_RESOURCE_LIMIT_EXCEEDED"
+ const val WRONG_ROOM_KEYS_VERSION = "M_WRONG_ROOM_KEYS_VERSION"
}
}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/interfaces/DatedObject.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/interfaces/DatedObject.kt
new file mode 100644
index 00000000..cd735506
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/interfaces/DatedObject.kt
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2018 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 im.vector.matrix.android.api.interfaces
+
+/**
+ * Can be implemented by any object containing a timestamp.
+ * This interface can be use to sort such object
+ */
+interface DatedObject {
+ val date: Long
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/listeners/ProgressListener.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/listeners/ProgressListener.kt
new file mode 100644
index 00000000..854f0e9f
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/listeners/ProgressListener.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.listeners
+
+/**
+ * Interface to send a progress info
+ */
+interface ProgressListener {
+ /**
+ * @param progress from 0 to total by contract
+ * @param total
+ */
+ fun onProgress(progress: Int, total: Int)
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/listeners/StepProgressListener.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/listeners/StepProgressListener.kt
new file mode 100644
index 00000000..af5b815c
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/listeners/StepProgressListener.kt
@@ -0,0 +1,34 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.listeners
+
+/**
+ * Interface to send a progress info
+ */
+interface StepProgressListener {
+
+ sealed class Step {
+ data class ComputingKey(val progress: Int, val total: Int) : Step()
+ object DownloadingKey : Step()
+ data class ImportingKey(val progress: Int, val total: Int) : Step()
+ }
+
+ /**
+ * @param step The current step, containing progress data if available. Else you should consider progress as indeterminate
+ */
+ fun onStepProgress(step: Step)
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/MatrixLinkify.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/MatrixLinkify.kt
new file mode 100644
index 00000000..cfe5a051
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/MatrixLinkify.kt
@@ -0,0 +1,55 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.permalinks
+
+import android.text.Spannable
+import im.vector.matrix.android.api.MatrixPatterns
+
+/**
+ * MatrixLinkify take a piece of text and turns all of the
+ * matrix patterns matches in the text into clickable links.
+ */
+object MatrixLinkify {
+
+ /**
+ * Find the matrix spans i.e matrix id , user id ... to display them as URL.
+ *
+ * @param spannable the text in which the matrix items has to be clickable.
+ */
+ fun addLinks(spannable: Spannable?, callback: MatrixPermalinkSpan.Callback?): Boolean {
+ // sanity checks
+ if (spannable.isNullOrEmpty()) {
+ return false
+ }
+ val text = spannable.toString()
+ var hasMatch = false
+ for (pattern in MatrixPatterns.MATRIX_PATTERNS) {
+ for (match in pattern.findAll(spannable)) {
+ hasMatch = true
+ val startPos = match.range.first
+ if (startPos == 0 || text[startPos - 1] != '/') {
+ val endPos = match.range.last
+ val url = text.substring(match.range)
+ val span = MatrixPermalinkSpan(url, callback)
+ spannable.setSpan(span, startPos, endPos, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE)
+ }
+ }
+ }
+ return hasMatch
+ }
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/MatrixPermalinkSpan.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/MatrixPermalinkSpan.kt
new file mode 100644
index 00000000..bbef1d36
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/MatrixPermalinkSpan.kt
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.permalinks
+
+import android.text.style.ClickableSpan
+import android.view.View
+
+/**
+ * This MatrixPermalinkSpan is a clickable span which use a [Callback] to communicate back.
+ * @param url the permalink url tied to the span
+ * @param callback the callback to use.
+ */
+class MatrixPermalinkSpan(private val url: String,
+ private val callback: Callback? = null) : ClickableSpan() {
+
+ interface Callback {
+ fun onUrlClicked(url: String)
+ }
+
+ override fun onClick(widget: View) {
+ callback?.onUrlClicked(url)
+ }
+
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/PermalinkData.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/PermalinkData.kt
new file mode 100644
index 00000000..615892a1
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/PermalinkData.kt
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.permalinks
+
+import android.net.Uri
+
+/**
+ * This sealed class represents all the permalink cases.
+ * You don't have to instantiate yourself but should use [PermalinkParser] instead.
+ */
+sealed class PermalinkData {
+
+ data class EventLink(val roomIdOrAlias: String, val eventId: String) : PermalinkData()
+
+ data class RoomLink(val roomIdOrAlias: String) : PermalinkData()
+
+ data class UserLink(val userId: String) : PermalinkData()
+
+ data class GroupLink(val groupId: String) : PermalinkData()
+
+ data class FallbackLink(val uri: Uri) : PermalinkData()
+
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/PermalinkFactory.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/PermalinkFactory.kt
new file mode 100644
index 00000000..15d56eac
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/PermalinkFactory.kt
@@ -0,0 +1,94 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.permalinks
+
+import android.text.TextUtils
+import im.vector.matrix.android.api.session.events.model.Event
+
+/**
+ * Useful methods to create Matrix permalink.
+ */
+object PermalinkFactory {
+
+ const val MATRIX_TO_URL_BASE = "https://matrix.to/#/"
+
+ /**
+ * Creates a permalink for an event.
+ * Ex: "https://matrix.to/#/!nbzmcXAqpxBXjAdgoX:matrix.org/$1531497316352799BevdV:matrix.org"
+ *
+ * @param event the event
+ * @return the permalink, or null in case of error
+ */
+ fun createPermalink(event: Event): String? {
+ if (event.roomId.isNullOrEmpty() || event.eventId.isNullOrEmpty()) {
+ return null
+ }
+ return createPermalink(event.roomId, event.eventId)
+ }
+
+ /**
+ * Creates a permalink for an id (can be a user Id, Room Id, etc.).
+ * Ex: "https://matrix.to/#/@benoit:matrix.org"
+ *
+ * @param id the id
+ * @return the permalink, or null in case of error
+ */
+ fun createPermalink(id: String): String? {
+ return if (TextUtils.isEmpty(id)) {
+ null
+ } else MATRIX_TO_URL_BASE + escape(id)
+
+ }
+
+ /**
+ * Creates a permalink for an event. If you have an event you can use [.createPermalink]
+ * Ex: "https://matrix.to/#/!nbzmcXAqpxBXjAdgoX:matrix.org/$1531497316352799BevdV:matrix.org"
+ *
+ * @param roomId the id of the room
+ * @param eventId the id of the event
+ * @return the permalink
+ */
+ fun createPermalink(roomId: String, eventId: String): String {
+ return MATRIX_TO_URL_BASE + escape(roomId) + "/" + escape(eventId)
+ }
+
+ /**
+ * Extract the linked id from the universal link
+ *
+ * @param url the universal link, Ex: "https://matrix.to/#/@benoit:matrix.org"
+ * @return the id from the url, ex: "@benoit:matrix.org", or null if the url is not a permalink
+ */
+ fun getLinkedId(url: String?): String? {
+ val isSupported = url != null && url.startsWith(MATRIX_TO_URL_BASE)
+
+ return if (isSupported) {
+ url!!.substring(MATRIX_TO_URL_BASE.length)
+ } else null
+
+ }
+
+
+ /**
+ * Escape '/' in id, because it is used as a separator
+ *
+ * @param id the id to escape
+ * @return the escaped id
+ */
+ private fun escape(id: String): String {
+ return id.replace("/".toRegex(), "%2F")
+ }
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/PermalinkParser.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/PermalinkParser.kt
new file mode 100644
index 00000000..71fd16e7
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/PermalinkParser.kt
@@ -0,0 +1,76 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.permalinks
+
+import android.net.Uri
+import im.vector.matrix.android.api.MatrixPatterns
+
+/**
+ * This class turns an uri to a [PermalinkData]
+ */
+object PermalinkParser {
+
+ /**
+ * Turns an uri string to a [PermalinkData]
+ */
+ fun parse(uriString: String): PermalinkData {
+ val uri = Uri.parse(uriString)
+ return parse(uri)
+ }
+
+ /**
+ * Turns an uri to a [PermalinkData]
+ */
+ fun parse(uri: Uri): PermalinkData {
+ if (!uri.toString().startsWith(PermalinkFactory.MATRIX_TO_URL_BASE)) {
+ return PermalinkData.FallbackLink(uri)
+ }
+
+ val fragment = uri.fragment
+ if (fragment.isNullOrEmpty()) {
+ return PermalinkData.FallbackLink(uri)
+ }
+
+ val indexOfQuery = fragment.indexOf("?")
+ val safeFragment = if (indexOfQuery != -1) fragment.substring(0, indexOfQuery) else fragment
+
+ // we are limiting to 2 params
+ val params = safeFragment
+ .split(MatrixPatterns.SEP_REGEX.toRegex())
+ .filter { it.isNotEmpty() }
+ .take(2)
+
+ val identifier = params.getOrNull(0)
+ val extraParameter = params.getOrNull(1)
+ if (identifier.isNullOrEmpty()) {
+ return PermalinkData.FallbackLink(uri)
+ }
+ return when {
+ MatrixPatterns.isUserId(identifier) -> PermalinkData.UserLink(userId = identifier)
+ MatrixPatterns.isGroupId(identifier) -> PermalinkData.GroupLink(groupId = identifier)
+ MatrixPatterns.isRoomId(identifier) -> {
+ if (!extraParameter.isNullOrEmpty() && MatrixPatterns.isEventId(extraParameter)) {
+ PermalinkData.EventLink(roomIdOrAlias = identifier, eventId = extraParameter)
+ } else {
+ PermalinkData.RoomLink(roomIdOrAlias = identifier)
+ }
+ }
+ else -> PermalinkData.FallbackLink(uri)
+ }
+ }
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/Action.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/Action.kt
new file mode 100644
index 00000000..797830f4
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/Action.kt
@@ -0,0 +1,95 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules
+
+import im.vector.matrix.android.api.pushrules.rest.PushRule
+import timber.log.Timber
+
+
+class Action(val type: Type) {
+
+ enum class Type(val value: String) {
+ NOTIFY("notify"),
+ DONT_NOTIFY("dont_notify"),
+ COALESCE("coalesce"),
+ SET_TWEAK("set_tweak");
+
+ companion object {
+
+ fun safeValueOf(value: String): Type? {
+ try {
+ return valueOf(value)
+ } catch (e: IllegalArgumentException) {
+ return null
+ }
+ }
+ }
+ }
+
+ var tweak_action: String? = null
+ var stringValue: String? = null
+ var boolValue: Boolean? = null
+
+ companion object {
+ fun mapFrom(pushRule: PushRule): List? {
+ val actions = ArrayList()
+ pushRule.actions.forEach { actionStrOrObj ->
+ if (actionStrOrObj is String) {
+ when (actionStrOrObj) {
+ Action.Type.NOTIFY.value -> Action(Action.Type.NOTIFY)
+ Action.Type.DONT_NOTIFY.value -> Action(Action.Type.DONT_NOTIFY)
+ else -> {
+ Timber.w("Unsupported action type ${actionStrOrObj}")
+ null
+ }
+ }?.let {
+ actions.add(it)
+ }
+ } else if (actionStrOrObj is Map<*, *>) {
+ val tweakAction = actionStrOrObj["set_tweak"] as? String
+ when (tweakAction) {
+ "sound" -> {
+ (actionStrOrObj["value"] as? String)?.let { stringValue ->
+ Action(Action.Type.SET_TWEAK).also {
+ it.tweak_action = "sound"
+ it.stringValue = stringValue
+ actions.add(it)
+ }
+ }
+ }
+ "highlight" -> {
+ (actionStrOrObj["value"] as? Boolean)?.let { boolValue ->
+ Action(Action.Type.SET_TWEAK).also {
+ it.tweak_action = "highlight"
+ it.boolValue = boolValue
+ actions.add(it)
+ }
+ }
+ }
+ else -> {
+ Timber.w("Unsupported action type ${actionStrOrObj}")
+ }
+ }
+ } else {
+ Timber.w("Unsupported action type ${actionStrOrObj}")
+ return null
+ }
+ }
+ return if (actions.isEmpty()) null else actions
+ }
+ }
+}
+
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/Condition.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/Condition.kt
new file mode 100644
index 00000000..c0bb4f16
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/Condition.kt
@@ -0,0 +1,48 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules
+
+abstract class Condition(val kind: Kind) {
+
+ enum class Kind(val value: String) {
+ event_match("event_match"),
+ contains_display_name("contains_display_name"),
+ room_member_count("room_member_count"),
+ sender_notification_permission("sender_notification_permission"),
+ UNRECOGNIZE("");
+
+ companion object {
+
+ fun fromString(value: String): Kind {
+ return when (value) {
+ "event_match" -> event_match
+ "contains_display_name" -> contains_display_name
+ "room_member_count" -> room_member_count
+ "sender_notification_permission" -> sender_notification_permission
+ else -> UNRECOGNIZE
+ }
+ }
+
+ }
+
+ }
+
+ abstract fun isSatisfied(conditionResolver: ConditionResolver): Boolean
+
+ open fun technicalDescription(): String {
+ return "Kind: $kind"
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/ConditionResolver.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/ConditionResolver.kt
new file mode 100644
index 00000000..4d15d5de
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/ConditionResolver.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules
+
+/**
+ * Acts like a visitor on Conditions.
+ * This class as all required context needed to evaluate rules
+ */
+interface ConditionResolver {
+
+ fun resolveEventMatchCondition(eventMatchCondition: EventMatchCondition): Boolean
+ fun resolveRoomMemberCountCondition(roomMemberCountCondition: RoomMemberCountCondition): Boolean
+ fun resolveSenderNotificationPermissionCondition(senderNotificationPermissionCondition: SenderNotificationPermissionCondition): Boolean
+ fun resolveContainsDisplayNameCondition(containsDisplayNameCondition: ContainsDisplayNameCondition) : Boolean
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/ContainsDisplayNameCondition.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/ContainsDisplayNameCondition.kt
new file mode 100644
index 00000000..37bc75ad
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/ContainsDisplayNameCondition.kt
@@ -0,0 +1,79 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules
+
+import android.text.TextUtils
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.api.session.events.model.EventType
+import im.vector.matrix.android.api.session.events.model.toModel
+import im.vector.matrix.android.api.session.room.model.message.MessageContent
+import timber.log.Timber
+import java.util.regex.Pattern
+
+class ContainsDisplayNameCondition : Condition(Kind.contains_display_name) {
+
+ override fun isSatisfied(conditionResolver: ConditionResolver): Boolean {
+ return conditionResolver.resolveContainsDisplayNameCondition(this)
+ }
+
+ override fun technicalDescription(): String {
+ return "User is mentioned"
+ }
+
+ fun isSatisfied(event: Event, displayName: String): Boolean {
+ var message = when (event.type) {
+ EventType.MESSAGE -> {
+ event.content.toModel()
+ }
+ //TODO the spec says:
+ // Matches any message whose content is unencrypted and contains the user's current display name
+ // EventType.ENCRYPTED -> {
+ // event.root.getClearContent()?.toModel()
+ // }
+ else -> null
+ } ?: return false
+
+ return caseInsensitiveFind(displayName, message.body)
+ }
+
+
+ companion object {
+ /**
+ * Returns whether a string contains an occurrence of another, as a standalone word, regardless of case.
+ *
+ * @param subString the string to search for
+ * @param longString the string to search in
+ * @return whether a match was found
+ */
+ fun caseInsensitiveFind(subString: String, longString: String): Boolean {
+ // add sanity checks
+ if (TextUtils.isEmpty(subString) || TextUtils.isEmpty(longString)) {
+ return false
+ }
+
+ var res = false
+
+ try {
+ val pattern = Pattern.compile("(\\W|^)" + Pattern.quote(subString) + "(\\W|$)", Pattern.CASE_INSENSITIVE)
+ res = pattern.matcher(longString).find()
+ } catch (e: Exception) {
+ Timber.e(e, "## caseInsensitiveFind() : failed")
+ }
+
+ return res
+ }
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/EventMatchCondition.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/EventMatchCondition.kt
new file mode 100644
index 00000000..7325abba
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/EventMatchCondition.kt
@@ -0,0 +1,97 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules
+
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.internal.di.MoshiProvider
+import timber.log.Timber
+
+class EventMatchCondition(val key: String, val pattern: String) : Condition(Kind.event_match) {
+
+ override fun isSatisfied(conditionResolver: ConditionResolver) : Boolean {
+ return conditionResolver.resolveEventMatchCondition(this)
+ }
+
+ override fun technicalDescription(): String {
+ return "'$key' Matches '$pattern'"
+ }
+
+
+ fun isSatisfied(event: Event): Boolean {
+ //TODO encrypted events?
+ val rawJson = MoshiProvider.providesMoshi().adapter(Event::class.java).toJsonValue(event) as? Map<*, *>
+ ?: return false
+ val value = extractField(rawJson, key) ?: return false
+
+ //Patterns with no special glob characters should be treated as having asterisks prepended
+ // and appended when testing the condition.
+ try {
+ val modPattern = if (hasSpecialGlobChar(pattern)) simpleGlobToRegExp(pattern) else simpleGlobToRegExp("*$pattern*")
+ val regex = Regex(modPattern, RegexOption.DOT_MATCHES_ALL)
+ return regex.containsMatchIn(value)
+ } catch (e: Throwable) {
+ //e.g PatternSyntaxException
+ Timber.e(e, "Failed to evaluate push condition")
+ return false
+ }
+
+ }
+
+
+ private fun extractField(jsonObject: Map<*, *>, fieldPath: String): String? {
+ val fieldParts = fieldPath.split(".")
+ if (fieldParts.isEmpty()) return null
+
+ var jsonElement: Map<*, *> = jsonObject
+ fieldParts.forEachIndexed { index, pathSegment ->
+ if (index == fieldParts.lastIndex) {
+ return jsonElement[pathSegment]?.toString()
+ } else {
+ val sub = jsonElement[pathSegment] ?: return null
+ if (sub is Map<*, *>) {
+ jsonElement = sub
+ } else {
+ return null
+ }
+ }
+ }
+ return null
+ }
+
+ companion object {
+
+ private fun hasSpecialGlobChar(glob: String): Boolean {
+ return glob.contains("*") || glob.contains("?")
+ }
+
+ //Very simple glob to regexp converter
+ private fun simpleGlobToRegExp(glob: String): String {
+ var out = ""//"^"
+ for (i in 0 until glob.length) {
+ val c = glob[i]
+ when (c) {
+ '*' -> out += ".*"
+ '?' -> out += '.'.toString()
+ '.' -> out += "\\."
+ '\\' -> out += "\\\\"
+ else -> out += c
+ }
+ }
+ out += ""//'$'.toString()
+ return out
+ }
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/PushRuleService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/PushRuleService.kt
new file mode 100644
index 00000000..b00450b5
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/PushRuleService.kt
@@ -0,0 +1,46 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules
+
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.pushrules.rest.PushRule
+import im.vector.matrix.android.api.session.events.model.Event
+
+interface PushRuleService {
+
+ /**
+ * Fetch the push rules from the server
+ */
+ fun fetchPushRules(scope: String = "global")
+
+ //TODO get push rule set
+ fun getPushRules(scope: String = "global"): List
+
+ //TODO update rule
+
+ fun updatePushRuleEnableStatus(kind: String, pushRule: PushRule, enabled: Boolean, callback: MatrixCallback)
+
+ fun addPushRuleListener(listener: PushRuleListener)
+
+ fun removePushRuleListener(listener: PushRuleListener)
+
+// fun fulfilledBingRule(event: Event, rules: List): PushRule?
+
+ interface PushRuleListener {
+ fun onMatchRule(event: Event, actions: List)
+ fun batchFinish()
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RoomMemberCountCondition.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RoomMemberCountCondition.kt
new file mode 100644
index 00000000..b2bed4c2
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RoomMemberCountCondition.kt
@@ -0,0 +1,71 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules
+
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.api.session.room.RoomService
+import timber.log.Timber
+import java.util.regex.Pattern
+
+private val regex = Pattern.compile("^(==|<=|>=|<|>)?(\\d*)$")
+
+class RoomMemberCountCondition(val `is`: String) : Condition(Kind.room_member_count) {
+
+ override fun isSatisfied(conditionResolver: ConditionResolver): Boolean {
+ return conditionResolver.resolveRoomMemberCountCondition(this)
+ }
+
+ override fun technicalDescription(): String {
+ return "Room member count is $`is`"
+ }
+
+ fun isSatisfied(event: Event, session: RoomService?): Boolean {
+ // sanity check^
+ val roomId = event.roomId ?: return false
+ val room = session?.getRoom(roomId) ?: return false
+
+ // Parse the is field into prefix and number the first time
+ val (prefix, count) = parseIsField() ?: return false
+
+ val numMembers = room.getNumberOfJoinedMembers()
+
+ return when (prefix) {
+ "<" -> numMembers < count
+ ">" -> numMembers > count
+ "<=" -> numMembers <= count
+ ">=" -> numMembers >= count
+ else -> numMembers == count
+ }
+ }
+
+ /**
+ * Parse the is field to extract meaningful information.
+ */
+ private fun parseIsField(): Pair? {
+ try {
+ val match = regex.matcher(`is`)
+ if (match.find()) {
+ val prefix = match.group(1)
+ val count = match.group(2).toInt()
+ return prefix to count
+ }
+ } catch (t: Throwable) {
+ Timber.d(t)
+ }
+ return null
+
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RuleIds.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RuleIds.kt
new file mode 100644
index 00000000..38a64adf
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RuleIds.kt
@@ -0,0 +1,47 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules
+
+/**
+ * Known rule ids
+ *
+ * Ref: https://matrix.org/docs/spec/client_server/latest#predefined-rules
+ */
+object RuleIds {
+ // Default Override Rules
+ const val RULE_ID_DISABLE_ALL = ".m.rule.master"
+ const val RULE_ID_SUPPRESS_BOTS_NOTIFICATIONS = ".m.rule.suppress_notices"
+ const val RULE_ID_INVITE_ME = ".m.rule.invite_for_me"
+ const val RULE_ID_PEOPLE_JOIN_LEAVE = ".m.rule.member_event"
+ const val RULE_ID_CONTAIN_DISPLAY_NAME = ".m.rule.contains_display_name"
+
+ const val RULE_ID_TOMBSTONE = ".m.rule.tombstone"
+ const val RULE_ID_ROOM_NOTIF = ".m.rule.roomnotif"
+
+ // Default Content Rules
+ const val RULE_ID_CONTAIN_USER_NAME = ".m.rule.contains_user_name"
+
+ // Default Underride Rules
+ const val RULE_ID_CALL = ".m.rule.call"
+ const val RULE_ID_one_to_one_encrypted_room = ".m.rule.encrypted_room_one_to_one"
+ const val RULE_ID_ONE_TO_ONE_ROOM = ".m.rule.room_one_to_one"
+ const val RULE_ID_ALL_OTHER_MESSAGES_ROOMS = ".m.rule.message"
+ const val RULE_ID_ENCRYPTED = ".m.rule.encrypted"
+
+ // Not documented
+ const val RULE_ID_FALLBACK = ".m.rule.fallback"
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RulesetKey.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RulesetKey.kt
new file mode 100644
index 00000000..834bdf2a
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RulesetKey.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules
+
+
+enum class RulesetKey(val value: String) {
+ CONTENT("content"),
+ OVERRIDE("override"),
+ ROOM("room"),
+ SENDER("sender"),
+ UNDERRIDE("underride"),
+ UNKNOWN("")
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/SenderNotificationPermissionCondition.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/SenderNotificationPermissionCondition.kt
new file mode 100644
index 00000000..35b731c5
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/SenderNotificationPermissionCondition.kt
@@ -0,0 +1,36 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules
+
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.api.session.room.model.PowerLevels
+
+
+class SenderNotificationPermissionCondition(val key: String) : Condition(Kind.sender_notification_permission) {
+
+ override fun isSatisfied(conditionResolver: ConditionResolver): Boolean {
+ return conditionResolver.resolveSenderNotificationPermissionCondition(this)
+ }
+
+ override fun technicalDescription(): String {
+ return "User power level <$key>"
+ }
+
+
+ fun isSatisfied(event: Event, powerLevels: PowerLevels): Boolean {
+ return event.senderId != null && powerLevels.getUserPowerLevel(event.senderId) >= powerLevels.notificationLevel(key)
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/GetPushRulesResponse.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/GetPushRulesResponse.kt
new file mode 100644
index 00000000..8d567f94
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/GetPushRulesResponse.kt
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules.rest
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * All push rulesets for a user.
+ */
+@JsonClass(generateAdapter = true)
+data class GetPushRulesResponse(
+ /**
+ * Global rules, account level applying to all devices
+ */
+ @Json(name = "global")
+ val global: Ruleset,
+
+ /**
+ * Device specific rules, apply only to current device
+ */
+ @Json(name = "device")
+ val device: Ruleset? = null
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/PushCondition.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/PushCondition.kt
new file mode 100644
index 00000000..8f694016
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/PushCondition.kt
@@ -0,0 +1,79 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules.rest
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.pushrules.*
+import timber.log.Timber
+
+@JsonClass(generateAdapter = true)
+data class PushCondition(
+ /**
+ * Required. The kind of condition to apply.
+ */
+ val kind: String,
+
+ /**
+ * Required for event_match conditions. The dot- separated field of the event to match.
+ */
+
+ val key: String? = null,
+ /**
+ *Required for event_match conditions.
+ */
+
+ val pattern: String? = null,
+ /**
+ * Required for room_member_count conditions.
+ * A decimal integer optionally prefixed by one of, ==, <, >, >= or <=.
+ * A prefix of < matches rooms where the member count is strictly less than the given number and so forth.
+ * If no prefix is present, this parameter defaults to ==.
+ */
+ @Json(name = "is") val iz: String? = null
+) {
+
+ fun asExecutableCondition(): Condition? {
+ return when (Condition.Kind.fromString(this.kind)) {
+ Condition.Kind.event_match -> {
+ if (this.key != null && this.pattern != null) {
+ EventMatchCondition(key, pattern)
+ } else {
+ Timber.e("Malformed Event match condition")
+ null
+ }
+ }
+ Condition.Kind.contains_display_name -> {
+ ContainsDisplayNameCondition()
+ }
+ Condition.Kind.room_member_count -> {
+ if (this.iz.isNullOrBlank()) {
+ Timber.e("Malformed ROOM_MEMBER_COUNT condition")
+ null
+ } else {
+ RoomMemberCountCondition(this.iz)
+ }
+ }
+ Condition.Kind.sender_notification_permission -> {
+ this.key?.let { SenderNotificationPermissionCondition(it) }
+ }
+ Condition.Kind.UNRECOGNIZE -> {
+ Timber.e("Unknwon kind $kind")
+ null
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/PushRule.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/PushRule.kt
new file mode 100644
index 00000000..1e36a0d8
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/PushRule.kt
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules.rest
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+
+@JsonClass(generateAdapter = true)
+data class PushRule(
+ /**
+ * Required. The actions to perform when this rule is matched.
+ */
+ val actions: List,
+ /**
+ * Required. Whether this is a default rule, or has been set explicitly.
+ */
+ val default: Boolean? = false,
+ /**
+ * Required. Whether the push rule is enabled or not.
+ */
+ val enabled: Boolean,
+ /**
+ * Required. The ID of this rule.
+ */
+ @Json(name = "rule_id") val ruleId: String,
+ /**
+ * The conditions that must hold true for an event in order for a rule to be applied to an event
+ */
+ val conditions: List? = null,
+ /**
+ * The glob-style pattern to match against. Only applicable to content rules.
+ */
+ val pattern: String? = null
+)
+
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/Ruleset.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/Ruleset.kt
new file mode 100644
index 00000000..5f4ca15a
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/Ruleset.kt
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.pushrules.rest
+
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class Ruleset(
+ val content: List? = null,
+ val override: List? = null,
+ val room: List? = null,
+ val sender: List? = null,
+ val underride: List? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/InitialSyncProgressService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/InitialSyncProgressService.kt
new file mode 100644
index 00000000..3bb567ae
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/InitialSyncProgressService.kt
@@ -0,0 +1,29 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session
+
+import androidx.annotation.StringRes
+import androidx.lifecycle.LiveData
+
+interface InitialSyncProgressService {
+
+ fun getLiveStatus() : LiveData
+
+ data class Status(
+ @StringRes val statusText: Int?,
+ val percentProgress: Int = 0
+ )
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/Session.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/Session.kt
new file mode 100644
index 00000000..08e706c3
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/Session.kt
@@ -0,0 +1,138 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session
+
+import androidx.annotation.MainThread
+import androidx.lifecycle.LiveData
+import im.vector.matrix.android.api.auth.data.SessionParams
+import im.vector.matrix.android.api.pushrules.PushRuleService
+import im.vector.matrix.android.api.session.cache.CacheService
+import im.vector.matrix.android.api.session.content.ContentUploadStateTracker
+import im.vector.matrix.android.api.session.content.ContentUrlResolver
+import im.vector.matrix.android.api.session.crypto.CryptoService
+import im.vector.matrix.android.api.session.file.FileService
+import im.vector.matrix.android.api.session.group.GroupService
+import im.vector.matrix.android.api.session.pushers.PushersService
+import im.vector.matrix.android.api.session.room.RoomDirectoryService
+import im.vector.matrix.android.api.session.room.RoomService
+import im.vector.matrix.android.api.session.signout.SignOutService
+import im.vector.matrix.android.api.session.sync.FilterService
+import im.vector.matrix.android.api.session.sync.SyncState
+import im.vector.matrix.android.api.session.user.UserService
+
+/**
+ * This interface defines interactions with a session.
+ * An instance of a session will be provided by the SDK.
+ */
+interface Session :
+ RoomService,
+ RoomDirectoryService,
+ GroupService,
+ UserService,
+ CryptoService,
+ CacheService,
+ SignOutService,
+ FilterService,
+ FileService,
+ PushRuleService,
+ PushersService,
+ InitialSyncProgressService {
+
+ /**
+ * The params associated to the session
+ */
+ val sessionParams: SessionParams
+
+ val myUserId: String
+ get() = sessionParams.credentials.userId
+
+
+ /**
+ * This method allow to open a session. It does start some service on the background.
+ */
+ @MainThread
+ fun open()
+
+ /**
+ * Requires a one time background sync
+ */
+ fun requireBackgroundSync()
+
+ /**
+ * Launches infinite periodic background syncs
+ * THis does not work in doze mode :/
+ * If battery optimization is on it can work in app standby but that's all :/
+ */
+ fun startAutomaticBackgroundSync(repeatDelay: Long = 30_000L)
+
+ fun stopAnyBackgroundSync()
+
+ /**
+ * This method start the sync thread.
+ */
+ fun startSync()
+
+ /**
+ * This method stop the sync thread.
+ */
+ fun stopSync()
+
+ /**
+ * This method allows to listen the sync state.
+ * @return a [LiveData] of [SyncState].
+ */
+ fun syncState(): LiveData
+
+ /**
+ * This method allow to close a session. It does stop some services.
+ */
+ fun close()
+
+ /**
+ * Returns the ContentUrlResolver associated to the session.
+ */
+ fun contentUrlResolver(): ContentUrlResolver
+
+ /**
+ * Returns the ContentUploadProgressTracker associated with the session
+ */
+ fun contentUploadProgressTracker(): ContentUploadStateTracker
+
+ /**
+ * Add a listener to the session.
+ * @param listener the listener to add.
+ */
+ fun addListener(listener: Listener)
+
+ /**
+ * Remove a listener from the session.
+ * @param listener the listener to remove.
+ */
+ fun removeListener(listener: Listener)
+
+ /**
+ * A global session listener to get notified for some events.
+ */
+ interface Listener {
+ /**
+ * The access token is not valid anymore
+ */
+ fun onInvalidToken()
+
+ }
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/cache/CacheService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/cache/CacheService.kt
new file mode 100644
index 00000000..43ab78b5
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/cache/CacheService.kt
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.cache
+
+import im.vector.matrix.android.api.MatrixCallback
+
+/**
+ * This interface defines a method to sign out. It's implemented at the session level.
+ */
+interface CacheService {
+
+ /**
+ * Clear the whole cached data, except credentials. Once done, the session is closed and has to be opened again
+ */
+ fun clearCache(callback: MatrixCallback)
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/content/ContentAttachmentData.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/content/ContentAttachmentData.kt
new file mode 100644
index 00000000..c8dca869
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/content/ContentAttachmentData.kt
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.content
+
+import android.os.Parcelable
+import kotlinx.android.parcel.Parcelize
+
+@Parcelize
+data class ContentAttachmentData(
+ val size: Long = 0,
+ val duration: Long? = 0,
+ val date: Long = 0,
+ val height: Long? = 0,
+ val width: Long? = 0,
+ val name: String? = null,
+ val path: String,
+ val mimeType: String,
+ val type: Type
+) : Parcelable {
+
+ enum class Type {
+ FILE,
+ IMAGE,
+ AUDIO,
+ VIDEO
+ }
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/content/ContentUploadStateTracker.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/content/ContentUploadStateTracker.kt
new file mode 100644
index 00000000..26273ebb
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/content/ContentUploadStateTracker.kt
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.content
+
+interface ContentUploadStateTracker {
+
+ fun track(key: String, updateListener: UpdateListener)
+
+ fun untrack(key: String, updateListener: UpdateListener)
+
+ interface UpdateListener {
+ fun onUpdate(state: State)
+ }
+
+ sealed class State {
+ object Idle : State()
+ object EncryptingThumbnail : State()
+ data class UploadingThumbnail(val current: Long, val total: Long) : State()
+ object Encrypting : State()
+ data class Uploading(val current: Long, val total: Long) : State()
+ object Success : State()
+ data class Failure(val throwable: Throwable) : State()
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/content/ContentUrlResolver.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/content/ContentUrlResolver.kt
new file mode 100644
index 00000000..0a20bef8
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/content/ContentUrlResolver.kt
@@ -0,0 +1,47 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.content
+
+/**
+ * This interface defines methods for accessing content from the current session.
+ */
+interface ContentUrlResolver {
+
+ enum class ThumbnailMethod(val value: String) {
+ CROP("crop"),
+ SCALE("scale")
+ }
+
+ /**
+ * Get the actual URL for accessing the full-size image of a Matrix media content URI.
+ *
+ * @param contentUrl the Matrix media content URI (in the form of "mxc://...").
+ * @return the URL to access the described resource, or null if the url is invalid.
+ */
+ fun resolveFullSize(contentUrl: String?): String?
+
+ /**
+ * Get the actual URL for accessing the thumbnail image of a given Matrix media content URI.
+ *
+ * @param contentUrl the Matrix media content URI (in the form of "mxc://...").
+ * @param width the desired width
+ * @param height the desired height
+ * @param method the desired method (METHOD_CROP or METHOD_SCALE)
+ * @return the URL to access the described resource, or null if the url is invalid.
+ */
+ fun resolveThumbnail(contentUrl: String?, width: Int, height: Int, method: ThumbnailMethod): String?
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/CryptoService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/CryptoService.kt
new file mode 100644
index 00000000..8e933426
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/CryptoService.kt
@@ -0,0 +1,120 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.crypto
+
+import android.content.Context
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.listeners.ProgressListener
+import im.vector.matrix.android.api.session.crypto.keysbackup.KeysBackupService
+import im.vector.matrix.android.api.session.crypto.keyshare.RoomKeysRequestListener
+import im.vector.matrix.android.api.session.crypto.sas.SasVerificationService
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.internal.crypto.MXEventDecryptionResult
+import im.vector.matrix.android.internal.crypto.NewSessionListener
+import im.vector.matrix.android.internal.crypto.attachments.ElementToDecrypt
+import im.vector.matrix.android.internal.crypto.model.ImportRoomKeysResult
+import im.vector.matrix.android.internal.crypto.model.MXDeviceInfo
+import im.vector.matrix.android.internal.crypto.model.MXEncryptEventContentResult
+import im.vector.matrix.android.internal.crypto.model.MXUsersDevicesMap
+import im.vector.matrix.android.internal.crypto.model.rest.DevicesListResponse
+import im.vector.matrix.android.internal.crypto.model.rest.RoomKeyRequestBody
+import java.io.File
+
+interface CryptoService {
+
+ fun setDeviceName(deviceId: String, deviceName: String, callback: MatrixCallback)
+
+ fun deleteDevice(deviceId: String, callback: MatrixCallback)
+
+ fun deleteDeviceWithUserPassword(deviceId: String, authSession: String?, password: String, callback: MatrixCallback)
+
+ fun getCryptoVersion(context: Context, longFormat: Boolean): String
+
+ fun isCryptoEnabled(): Boolean
+
+ fun getSasVerificationService(): SasVerificationService
+
+ fun getKeysBackupService(): KeysBackupService
+
+ fun isRoomBlacklistUnverifiedDevices(roomId: String?): Boolean
+
+ fun setWarnOnUnknownDevices(warn: Boolean)
+
+ fun setDeviceVerification(verificationStatus: Int, deviceId: String, userId: String)
+
+ fun getUserDevices(userId: String): MutableList
+
+ fun setDevicesKnown(devices: List, callback: MatrixCallback?)
+
+ fun deviceWithIdentityKey(senderKey: String, algorithm: String): MXDeviceInfo?
+
+ fun getMyDevice(): MXDeviceInfo
+
+ fun getGlobalBlacklistUnverifiedDevices(): Boolean
+
+ fun setGlobalBlacklistUnverifiedDevices(block: Boolean)
+
+ fun setRoomUnBlacklistUnverifiedDevices(roomId: String)
+
+ fun getDeviceTrackingStatus(userId: String): Int
+
+ fun importRoomKeys(roomKeysAsArray: ByteArray, password: String, progressListener: ProgressListener?, callback: MatrixCallback)
+
+ fun exportRoomKeys(password: String, callback: MatrixCallback)
+
+ fun setRoomBlacklistUnverifiedDevices(roomId: String)
+
+ fun getDeviceInfo(userId: String, deviceId: String?): MXDeviceInfo?
+
+ fun reRequestRoomKeyForEvent(event: Event)
+
+ fun cancelRoomKeyRequest(requestBody: RoomKeyRequestBody)
+
+ fun addRoomKeysRequestListener(listener: RoomKeysRequestListener)
+
+ fun removeRoomKeysRequestListener(listener: RoomKeysRequestListener)
+
+ fun getDevicesList(callback: MatrixCallback)
+
+ fun inboundGroupSessionsCount(onlyBackedUp: Boolean): Int
+
+ fun isRoomEncrypted(roomId: String): Boolean
+
+ fun encryptEventContent(eventContent: Content,
+ eventType: String,
+ roomId: String,
+ callback: MatrixCallback)
+
+ @Throws(MXCryptoError::class)
+ fun decryptEvent(event: Event, timeline: String): MXEventDecryptionResult
+
+ fun decryptEventAsync(event: Event, timeline: String, callback: MatrixCallback)
+
+ fun getEncryptionAlgorithm(roomId: String): String?
+
+ fun shouldEncryptForInvitedMembers(roomId: String): Boolean
+
+ fun downloadKeys(userIds: List, forceDownload: Boolean, callback: MatrixCallback>)
+
+ fun clearCryptoCache(callback: MatrixCallback)
+
+ fun addNewSessionListener(newSessionListener: NewSessionListener)
+
+ fun removeSessionListener(listener: NewSessionListener)
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/MXCryptoError.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/MXCryptoError.kt
new file mode 100644
index 00000000..b61a1e41
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/MXCryptoError.kt
@@ -0,0 +1,93 @@
+/*
+ * Copyright 2016 OpenMarket Ltd
+ * Copyright 2017 Vector Creations Ltd
+ * Copyright 2018 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 im.vector.matrix.android.api.session.crypto
+
+import im.vector.matrix.android.internal.crypto.model.MXDeviceInfo
+import im.vector.matrix.android.internal.crypto.model.MXUsersDevicesMap
+import org.matrix.olm.OlmException
+
+/**
+ * Represents a crypto error response.
+ */
+sealed class MXCryptoError : Throwable() {
+
+ data class Base(val errorType: ErrorType,
+ val technicalMessage: String,
+ /**
+ * Describe the error with more details
+ */
+ val detailedErrorDescription: String? = null) : MXCryptoError()
+
+ data class OlmError(val olmException: OlmException) : MXCryptoError()
+
+ data class UnknownDevice(val deviceList: MXUsersDevicesMap) : MXCryptoError()
+
+ enum class ErrorType {
+ ENCRYPTING_NOT_ENABLED,
+ UNABLE_TO_ENCRYPT,
+ UNABLE_TO_DECRYPT,
+ UNKNOWN_INBOUND_SESSION_ID,
+ INBOUND_SESSION_MISMATCH_ROOM_ID,
+ MISSING_FIELDS,
+ BAD_EVENT_FORMAT,
+ MISSING_SENDER_KEY,
+ MISSING_CIPHER_TEXT,
+ BAD_DECRYPTED_FORMAT,
+ NOT_INCLUDE_IN_RECIPIENTS,
+ BAD_RECIPIENT,
+ BAD_RECIPIENT_KEY,
+ FORWARDED_MESSAGE,
+ BAD_ROOM,
+ BAD_ENCRYPTED_MESSAGE,
+ DUPLICATED_MESSAGE_INDEX,
+ MISSING_PROPERTY,
+ OLM,
+ UNKNOWN_DEVICES,
+ UNKNOWN_MESSAGE_INDEX
+ }
+
+ companion object {
+ /**
+ * Resource for technicalMessage
+ */
+ const val UNABLE_TO_ENCRYPT_REASON = "Unable to encrypt %s"
+ const val UNABLE_TO_DECRYPT_REASON = "Unable to decrypt %1\$s. Algorithm: %2\$s"
+ const val OLM_REASON = "OLM error: %1\$s"
+ const val DETAILED_OLM_REASON = "Unable to decrypt %1\$s. OLM error: %2\$s"
+ const val UNKNOWN_INBOUND_SESSION_ID_REASON = "Unknown inbound session id"
+ const val INBOUND_SESSION_MISMATCH_ROOM_ID_REASON = "Mismatched room_id for inbound group session (expected %1\$s, was %2\$s)"
+ const val MISSING_FIELDS_REASON = "Missing fields in input"
+ const val BAD_EVENT_FORMAT_TEXT_REASON = "Bad event format"
+ const val MISSING_SENDER_KEY_TEXT_REASON = "Missing senderKey"
+ const val MISSING_CIPHER_TEXT_REASON = "Missing ciphertext"
+ const val BAD_DECRYPTED_FORMAT_TEXT_REASON = "Bad decrypted event format"
+ const val NOT_INCLUDED_IN_RECIPIENT_REASON = "Not included in recipients"
+ const val BAD_RECIPIENT_REASON = "Message was intended for %1\$s"
+ const val BAD_RECIPIENT_KEY_REASON = "Message not intended for this device"
+ const val FORWARDED_MESSAGE_REASON = "Message forwarded from %1\$s"
+ const val BAD_ROOM_REASON = "Message intended for room %1\$s"
+ const val BAD_ENCRYPTED_MESSAGE_REASON = "Bad Encrypted Message"
+ const val DUPLICATE_MESSAGE_INDEX_REASON = "Duplicate message index, possible replay attack %1\$s"
+ const val ERROR_MISSING_PROPERTY_REASON = "No '%1\$s' property. Cannot prevent unknown-key attack"
+ const val UNKNOWN_DEVICES_REASON = "This room contains unknown devices which have not been verified.\n" +
+ "We strongly recommend you verify them before continuing."
+ const val NO_MORE_ALGORITHM_REASON = "Room was previously configured to use encryption, but is no longer." +
+ " Perhaps the homeserver is hiding the configuration event."
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keysbackup/KeysBackupService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keysbackup/KeysBackupService.kt
new file mode 100644
index 00000000..6728daa5
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keysbackup/KeysBackupService.kt
@@ -0,0 +1,214 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.crypto.keysbackup
+
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.listeners.ProgressListener
+import im.vector.matrix.android.api.listeners.StepProgressListener
+import im.vector.matrix.android.internal.crypto.keysbackup.model.KeysBackupVersionTrust
+import im.vector.matrix.android.internal.crypto.keysbackup.model.MegolmBackupCreationInfo
+import im.vector.matrix.android.internal.crypto.keysbackup.model.rest.KeysVersion
+import im.vector.matrix.android.internal.crypto.keysbackup.model.rest.KeysVersionResult
+import im.vector.matrix.android.internal.crypto.model.ImportRoomKeysResult
+
+interface KeysBackupService {
+ /**
+ * Retrieve the current version of the backup from the home server
+ *
+ * It can be different than keysBackupVersion.
+ * @param callback onSuccess(null) will be called if there is no backup on the server
+ */
+ fun getCurrentVersion(callback: MatrixCallback)
+
+ /**
+ * Create a new keys backup version and enable it, using the information return from [prepareKeysBackupVersion].
+ *
+ * @param keysBackupCreationInfo the info object from [prepareKeysBackupVersion].
+ * @param callback Asynchronous callback
+ */
+ fun createKeysBackupVersion(keysBackupCreationInfo: MegolmBackupCreationInfo,
+ callback: MatrixCallback)
+
+ /**
+ * Facility method to get the total number of locally stored keys
+ */
+ fun getTotalNumbersOfKeys(): Int
+
+ /**
+ * Facility method to get the number of backed up keys
+ */
+ fun getTotalNumbersOfBackedUpKeys(): Int
+
+ /**
+ * Start to back up keys immediately.
+ *
+ * @param progressListener the callback to follow the progress
+ * @param callback the main callback
+ */
+ fun backupAllGroupSessions(progressListener: ProgressListener?,
+ callback: MatrixCallback?)
+
+ /**
+ * Check trust on a key backup version.
+ *
+ * @param keysBackupVersion the backup version to check.
+ * @param callback block called when the operations completes.
+ */
+ fun getKeysBackupTrust(keysBackupVersion: KeysVersionResult,
+ callback: MatrixCallback)
+
+ /**
+ * Return the current progress of the backup
+ */
+ fun getBackupProgress(progressListener: ProgressListener)
+
+ /**
+ * Get information about a backup version defined on the homeserver.
+ *
+ * It can be different than keysBackupVersion.
+ * @param version the backup version
+ * @param callback
+ */
+ fun getVersion(version: String,
+ callback: MatrixCallback)
+
+ /**
+ * This method fetches the last backup version on the server, then compare to the currently backup version use.
+ * If versions are not the same, the current backup is deleted (on server or locally), then the backup may be started again, using the last version.
+ *
+ * @param callback true if backup is already using the last version, and false if it is not the case
+ */
+ fun forceUsingLastVersion(callback: MatrixCallback)
+
+ /**
+ * Check the server for an active key backup.
+ *
+ * If one is present and has a valid signature from one of the user's verified
+ * devices, start backing up to it.
+ */
+ fun checkAndStartKeysBackup()
+
+ fun addListener(listener: KeysBackupStateListener)
+
+ fun removeListener(listener: KeysBackupStateListener)
+
+ /**
+ * Set up the data required to create a new backup version.
+ * The backup version will not be created and enabled until [createKeysBackupVersion]
+ * is called.
+ * The returned [MegolmBackupCreationInfo] object has a `recoveryKey` member with
+ * the user-facing recovery key string.
+ *
+ * @param password an optional passphrase string that can be entered by the user
+ * when restoring the backup as an alternative to entering the recovery key.
+ * @param progressListener a progress listener, as generating private key from password may take a while
+ * @param callback Asynchronous callback
+ */
+ fun prepareKeysBackupVersion(password: String?,
+ progressListener: ProgressListener?,
+ callback: MatrixCallback)
+
+ /**
+ * Delete a keys backup version. It will delete all backed up keys on the server, and the backup itself.
+ * If we are backing up to this version. Backup will be stopped.
+ *
+ * @param version the backup version to delete.
+ * @param callback Asynchronous callback
+ */
+ fun deleteBackup(version: String,
+ callback: MatrixCallback?)
+
+ /**
+ * Ask if the backup on the server contains keys that we may do not have locally.
+ * This should be called when entering in the state READY_TO_BACKUP
+ */
+ fun canRestoreKeys(): Boolean
+
+ /**
+ * Set trust on a keys backup version.
+ * It adds (or removes) the signature of the current device to the authentication part of the keys backup version.
+ *
+ * @param keysBackupVersion the backup version to check.
+ * @param trust the trust to set to the keys backup.
+ * @param callback block called when the operations completes.
+ */
+ fun trustKeysBackupVersion(keysBackupVersion: KeysVersionResult,
+ trust: Boolean,
+ callback: MatrixCallback)
+
+ /**
+ * Set trust on a keys backup version.
+ *
+ * @param keysBackupVersion the backup version to check.
+ * @param recoveryKey the recovery key to challenge with the key backup public key.
+ * @param callback block called when the operations completes.
+ */
+ fun trustKeysBackupVersionWithRecoveryKey(keysBackupVersion: KeysVersionResult,
+ recoveryKey: String,
+ callback: MatrixCallback)
+
+ /**
+ * Set trust on a keys backup version.
+ *
+ * @param keysBackupVersion the backup version to check.
+ * @param password the pass phrase to challenge with the keyBackupVersion public key.
+ * @param callback block called when the operations completes.
+ */
+ fun trustKeysBackupVersionWithPassphrase(keysBackupVersion: KeysVersionResult,
+ password: String,
+ callback: MatrixCallback)
+
+ /**
+ * Restore a backup with a recovery key from a given backup version stored on the homeserver.
+ *
+ * @param keysVersionResult the backup version to restore from.
+ * @param recoveryKey the recovery key to decrypt the retrieved backup.
+ * @param roomId the id of the room to get backup data from.
+ * @param sessionId the id of the session to restore.
+ * @param stepProgressListener the step progress listener
+ * @param callback Callback. It provides the number of found keys and the number of successfully imported keys.
+ */
+ fun restoreKeysWithRecoveryKey(keysVersionResult: KeysVersionResult,
+ recoveryKey: String, roomId: String?,
+ sessionId: String?,
+ stepProgressListener: StepProgressListener?,
+ callback: MatrixCallback)
+
+ /**
+ * Restore a backup with a password from a given backup version stored on the homeserver.
+ *
+ * @param keysBackupVersion the backup version to restore from.
+ * @param password the password to decrypt the retrieved backup.
+ * @param roomId the id of the room to get backup data from.
+ * @param sessionId the id of the session to restore.
+ * @param stepProgressListener the step progress listener
+ * @param callback Callback. It provides the number of found keys and the number of successfully imported keys.
+ */
+ fun restoreKeyBackupWithPassword(keysBackupVersion: KeysVersionResult,
+ password: String,
+ roomId: String?,
+ sessionId: String?,
+ stepProgressListener: StepProgressListener?,
+ callback: MatrixCallback)
+
+ val keysBackupVersion: KeysVersionResult?
+ val currentBackupVersion: String?
+ val isEnabled: Boolean
+ val isStucked: Boolean
+ val state: KeysBackupState
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keysbackup/KeysBackupState.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keysbackup/KeysBackupState.kt
new file mode 100644
index 00000000..a1bd29e7
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keysbackup/KeysBackupState.kt
@@ -0,0 +1,75 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.crypto.keysbackup
+
+/**
+ * E2e keys backup states.
+ *
+ *
+ * |
+ * V deleteKeyBackupVersion (on current backup)
+ * +----------------------> UNKNOWN <-------------
+ * | |
+ * | | checkAndStartKeysBackup (at startup or on new verified device or a new detected backup)
+ * | V
+ * | CHECKING BACKUP
+ * | |
+ * | Network error |
+ * +<----------+----------------+-------> DISABLED <----------------------+
+ * | | | | |
+ * | | | | createKeysBackupVersion |
+ * | V | V |
+ * +<--- WRONG VERSION | ENABLING |
+ * | ^ | | |
+ * | | V ok | error |
+ * | | +------> READY <--------+----------------------------+
+ * V | | |
+ * NOT TRUSTED | | | on new key
+ * | | V
+ * | | WILL BACK UP (waiting a random duration)
+ * | | |
+ * | | |
+ * | | ok V
+ * | +----- BACKING UP
+ * | |
+ * | Error |
+ * +<---------------+
+ *
+ */
+enum class KeysBackupState {
+ // Need to check the current backup version on the homeserver
+ Unknown,
+ // Checking if backup is enabled on home server
+ CheckingBackUpOnHomeserver,
+ // Backup has been stopped because a new backup version has been detected on the homeserver
+ WrongBackUpVersion,
+ // Backup from this device is not enabled
+ Disabled,
+ // There is a backup available on the homeserver but it is not trusted.
+ // It is not trusted because the signature is invalid or the device that created it is not verified
+ // Use [KeysBackup.getKeysBackupTrust()] to get trust details.
+ // Consequently, the backup from this device is not enabled.
+ NotTrusted,
+ // Backup is being enabled: the backup version is being created on the homeserver
+ Enabling,
+ // Backup is enabled and ready to send backup to the homeserver
+ ReadyToBackUp,
+ // e2e keys are going to be sent to the homeserver
+ WillBackUp,
+ // e2e keys are being sent to the homeserver
+ BackingUp
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keysbackup/KeysBackupStateListener.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keysbackup/KeysBackupStateListener.kt
new file mode 100644
index 00000000..f145d779
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keysbackup/KeysBackupStateListener.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.crypto.keysbackup
+
+interface KeysBackupStateListener {
+
+ /**
+ * The keys backup state has changed
+ * @param newState the new state
+ */
+ fun onStateChange(newState: KeysBackupState)
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keyshare/RoomKeysRequestListener.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keyshare/RoomKeysRequestListener.kt
new file mode 100644
index 00000000..5bce27e1
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keyshare/RoomKeysRequestListener.kt
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2018 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 im.vector.matrix.android.api.session.crypto.keyshare
+
+import im.vector.matrix.android.internal.crypto.IncomingRoomKeyRequest
+import im.vector.matrix.android.internal.crypto.IncomingRoomKeyRequestCancellation
+
+/**
+ * Room keys events listener
+ */
+interface RoomKeysRequestListener {
+ /**
+ * An room key request has been received.
+ *
+ * @param request the request
+ */
+ fun onRoomKeyRequest(request: IncomingRoomKeyRequest)
+
+ /**
+ * A room key request cancellation has been received.
+ *
+ * @param request the cancellation request
+ */
+ fun onRoomKeyRequestCancellation(request: IncomingRoomKeyRequestCancellation)
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/CancelCode.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/CancelCode.kt
new file mode 100644
index 00000000..d999d06f
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/CancelCode.kt
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.crypto.sas
+
+enum class CancelCode(val value: String, val humanReadable: String) {
+ User("m.user", "the user cancelled the verification"),
+ Timeout("m.timeout", "the verification process timed out"),
+ UnknownTransaction("m.unknown_transaction", "the device does not know about that transaction"),
+ UnknownMethod("m.unknown_method", "the device can’t agree on a key agreement, hash, MAC, or SAS method"),
+ MismatchedCommitment("m.mismatched_commitment", "the hash commitment did not match"),
+ MismatchedSas("m.mismatched_sas", "the SAS did not match"),
+ UnexpectedMessage("m.unexpected_message", "the device received an unexpected message"),
+ InvalidMessage("m.invalid_message", "an invalid message was received"),
+ MismatchedKeys("m.key_mismatch", "Key mismatch"),
+ UserMismatchError("m.user_error", "User mismatch")
+}
+
+fun safeValueOf(code: String?): CancelCode {
+ return CancelCode.values().firstOrNull { code == it.value } ?: CancelCode.User
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/EmojiRepresentation.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/EmojiRepresentation.kt
new file mode 100644
index 00000000..0bcb96a9
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/EmojiRepresentation.kt
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.crypto.sas
+
+import androidx.annotation.StringRes
+
+data class EmojiRepresentation(val emoji: String,
+ @StringRes val nameResId: Int)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/IncomingSasVerificationTransaction.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/IncomingSasVerificationTransaction.kt
new file mode 100644
index 00000000..791c63dc
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/IncomingSasVerificationTransaction.kt
@@ -0,0 +1,34 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.crypto.sas
+
+interface IncomingSasVerificationTransaction {
+ val uxState: UxState
+
+ fun performAccept()
+
+ enum class UxState {
+ UNKNOWN,
+ SHOW_ACCEPT,
+ WAIT_FOR_KEY_AGREEMENT,
+ SHOW_SAS,
+ WAIT_FOR_VERIFICATION,
+ VERIFIED,
+ CANCELLED_BY_ME,
+ CANCELLED_BY_OTHER
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/Mode.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/Mode.kt
new file mode 100644
index 00000000..da72e98b
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/Mode.kt
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.crypto.sas
+
+object SasMode {
+ const val DECIMAL = "decimal"
+ const val EMOJI = "emoji"
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/OutgoingSasVerificationRequest.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/OutgoingSasVerificationRequest.kt
new file mode 100644
index 00000000..6aeed555
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/OutgoingSasVerificationRequest.kt
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.crypto.sas
+
+interface OutgoingSasVerificationRequest {
+ val uxState: UxState
+
+ enum class UxState {
+ UNKNOWN,
+ WAIT_FOR_START,
+ WAIT_FOR_KEY_AGREEMENT,
+ SHOW_SAS,
+ WAIT_FOR_VERIFICATION,
+ VERIFIED,
+ CANCELLED_BY_ME,
+ CANCELLED_BY_OTHER
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/SasVerificationService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/SasVerificationService.kt
new file mode 100644
index 00000000..a11c69cd
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/SasVerificationService.kt
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.crypto.sas
+
+interface SasVerificationService {
+ fun addListener(listener: SasVerificationListener)
+
+ fun removeListener(listener: SasVerificationListener)
+
+ fun markedLocallyAsManuallyVerified(userId: String, deviceID: String)
+
+ fun getExistingTransaction(otherUser: String, tid: String): SasVerificationTransaction?
+
+ fun beginKeyVerificationSAS(userId: String, deviceID: String): String?
+
+ fun beginKeyVerification(method: String, userId: String, deviceID: String): String?
+
+ // fun transactionUpdated(tx: SasVerificationTransaction)
+
+ interface SasVerificationListener {
+ fun transactionCreated(tx: SasVerificationTransaction)
+ fun transactionUpdated(tx: SasVerificationTransaction)
+ fun markedAsManuallyVerified(userId: String, deviceId: String)
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/SasVerificationTransaction.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/SasVerificationTransaction.kt
new file mode 100644
index 00000000..dc489cf6
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/SasVerificationTransaction.kt
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.crypto.sas
+
+interface SasVerificationTransaction {
+ val state: SasVerificationTxState
+
+ val cancelledReason: CancelCode?
+
+ val transactionId: String
+
+ val otherUserId: String
+
+ var otherDeviceId: String?
+
+ val isIncoming: Boolean
+
+ fun supportsEmoji(): Boolean
+
+ fun supportsDecimal(): Boolean
+
+ fun getEmojiCodeRepresentation(): List
+
+ fun getDecimalCodeRepresentation(): String
+
+ /**
+ * User wants to cancel the transaction
+ */
+ fun cancel()
+
+ /**
+ * To be called by the client when the user has verified that
+ * both short codes do match
+ */
+ fun userHasVerifiedShortCode()
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/SasVerificationTxState.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/SasVerificationTxState.kt
new file mode 100644
index 00000000..60ce8f0c
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/SasVerificationTxState.kt
@@ -0,0 +1,49 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.crypto.sas
+
+enum class SasVerificationTxState {
+ None,
+ // I have started a verification request
+ SendingStart,
+ Started,
+ // Other user/device sent me a request
+ OnStarted,
+ // I have accepted a request started by the other user/device
+ SendingAccept,
+ Accepted,
+ // My request has been accepted by the other user/device
+ OnAccepted,
+ // I have sent my public key
+ SendingKey,
+ KeySent,
+ // The other user/device has sent me his public key
+ OnKeyReceived,
+ // Short code is ready to be displayed
+ ShortCodeReady,
+ // I have compared the code and manually said that they match
+ ShortCodeAccepted,
+
+ SendingMac,
+ MacSent,
+ Verifying,
+ Verified,
+
+ //Global: The verification has been cancelled (by me or other), see cancelReason for details
+ Cancelled,
+ OnCancelled
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/AggregatedAnnotation.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/AggregatedAnnotation.kt
new file mode 100644
index 00000000..3f1c6199
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/AggregatedAnnotation.kt
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.events.model
+
+import com.squareup.moshi.JsonClass
+
+/**
+ *
+ * {
+ * "chunk": [
+ * {
+ * "type": "m.reaction",
+ * "key": "👍",
+ * "count": 3
+ * }
+ * ],
+ * "limited": false,
+ * "count": 1
+ * },
+ *
+ */
+
+@JsonClass(generateAdapter = true)
+data class AggregatedAnnotation (
+ override val limited: Boolean? = false,
+ override val count: Int? = 0,
+ val chunk: List? = null
+
+) : UnsignedRelationInfo
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/AggregatedRelations.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/AggregatedRelations.kt
new file mode 100644
index 00000000..0f8d21f5
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/AggregatedRelations.kt
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.events.model
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ *
+ * {
+ * "m.annotation": {
+ * "chunk": [
+ * {
+ * "type": "m.reaction",
+ * "key": "👍",
+ * "count": 3
+ * }
+ * ],
+ * "limited": false,
+ * "count": 1
+ * },
+ * "m.reference": {
+ * "chunk": [
+ * {
+ * "type": "m.room.message",
+ * "event_id": "$some_event_id"
+ * }
+ * ],
+ * "limited": false,
+ * "count": 1
+ * }
+ * }
+ *
+ */
+
+@JsonClass(generateAdapter = true)
+data class AggregatedRelations(
+ @Json(name = "m.annotation") val annotations: AggregatedAnnotation? = null,
+ @Json(name = "m.reference") val references: DefaultUnsignedRelationInfo? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/DefaultUnsignedRelationInfo.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/DefaultUnsignedRelationInfo.kt
new file mode 100644
index 00000000..3e2df0aa
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/DefaultUnsignedRelationInfo.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.events.model
+
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class DefaultUnsignedRelationInfo(
+ override val limited: Boolean? = false,
+ override val count: Int? = 0,
+ val chunk: List>? = null
+
+) : UnsignedRelationInfo
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/Event.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/Event.kt
new file mode 100644
index 00000000..547e627f
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/Event.kt
@@ -0,0 +1,294 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.events.model
+
+import android.text.TextUtils
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.session.crypto.MXCryptoError
+import im.vector.matrix.android.api.util.JsonDict
+import im.vector.matrix.android.internal.crypto.algorithms.olm.OlmDecryptionResult
+import im.vector.matrix.android.internal.di.MoshiProvider
+import org.json.JSONObject
+import timber.log.Timber
+
+typealias Content = JsonDict
+
+/**
+ * This methods is a facility method to map a json content to a model.
+ */
+inline fun Content?.toModel(catchError: Boolean = true): T? {
+ return this?.let {
+ val moshi = MoshiProvider.providesMoshi()
+ val moshiAdapter = moshi.adapter(T::class.java)
+ return try {
+ moshiAdapter.fromJsonValue(it)
+ } catch (e: Exception) {
+ if (catchError) {
+ Timber.e(e, "To model failed : $e")
+ null
+ } else {
+ throw e
+ }
+ }
+ }
+}
+
+/**
+ * This methods is a facility method to map a model to a json Content
+ */
+@Suppress("UNCHECKED_CAST")
+inline fun T?.toContent(): Content? {
+ return this?.let {
+ val moshi = MoshiProvider.providesMoshi()
+ val moshiAdapter = moshi.adapter(T::class.java)
+ return moshiAdapter.toJsonValue(it) as Content
+ }
+}
+
+/**
+ * Generic event class with all possible fields for events.
+ * The content and prevContent json fields can easily be mapped to a model with [toModel] method.
+ */
+@JsonClass(generateAdapter = true)
+data class Event(
+ @Json(name = "type") val type: String,
+ @Json(name = "event_id") val eventId: String? = null,
+ @Json(name = "content") val content: Content? = null,
+ @Json(name = "prev_content") val prevContent: Content? = null,
+ @Json(name = "origin_server_ts") val originServerTs: Long? = null,
+ @Json(name = "sender") val senderId: String? = null,
+ @Json(name = "state_key") val stateKey: String? = null,
+ @Json(name = "room_id") val roomId: String? = null,
+ @Json(name = "unsigned") val unsignedData: UnsignedData? = null,
+ @Json(name = "redacts") val redacts: String? = null
+) {
+
+
+ var mxDecryptionResult: OlmDecryptionResult? = null
+ var mCryptoError: MXCryptoError.ErrorType? = null
+
+
+ /**
+ * Check if event is a state event.
+ * @return true if event is state event.
+ */
+ fun isStateEvent(): Boolean {
+ return EventType.isStateEvent(getClearType())
+ }
+
+ //==============================================================================================================
+ // Crypto
+ //==============================================================================================================
+
+// /**
+// * For encrypted events, the plaintext payload for the event.
+// * This is a small MXEvent instance with typically value for `type` and 'content' fields.
+// */
+// @Transient
+// var mClearEvent: Event? = null
+// private set
+//
+// /**
+// * Curve25519 key which we believe belongs to the sender of the event.
+// * See `senderKey` property.
+// */
+// @Transient
+// private var mSenderCurve25519Key: String? = null
+//
+// /**
+// * Ed25519 key which the sender of this event (for olm) or the creator of the megolm session (for megolm) claims to own.
+// * See `claimedEd25519Key` property.
+// */
+// @Transient
+// private var mClaimedEd25519Key: String? = null
+//
+// /**
+// * Curve25519 keys of devices involved in telling us about the senderCurve25519Key and claimedEd25519Key.
+// * See `forwardingCurve25519KeyChain` property.
+// */
+// @Transient
+// private var mForwardingCurve25519KeyChain: List = ArrayList()
+//
+// /**
+// * Decryption error
+// */
+// @Transient
+// var mCryptoError: MXCryptoError? = null
+// private set
+
+ /**
+ * @return true if this event is encrypted.
+ */
+ fun isEncrypted(): Boolean {
+ return TextUtils.equals(type, EventType.ENCRYPTED)
+ }
+
+ /**
+ * Update the clear data on this event.
+ * This is used after decrypting an event; it should not be used by applications.
+ *
+ * @param decryptionResult the decryption result, including the plaintext and some key info.
+ */
+// internal fun setClearData(decryptionResult: MXEventDecryptionResult?) {
+// mClearEvent = null
+// if (decryptionResult != null) {
+// if (decryptionResult.clearEvent != null) {
+// val adapter = MoshiProvider.providesMoshi().adapter(Event::class.java)
+// mClearEvent = adapter.fromJsonValue(decryptionResult.clearEvent)
+//
+// if (mClearEvent != null) {
+// mSenderCurve25519Key = decryptionResult.senderCurve25519Key
+// mClaimedEd25519Key = decryptionResult.claimedEd25519Key
+// mForwardingCurve25519KeyChain = decryptionResult.forwardingCurve25519KeyChain
+//
+// // For encrypted events with relation, the m.relates_to is kept in clear, so we need to put it back
+// // in the clear event
+// try {
+// content?.get("m.relates_to")?.let { clearRelates ->
+// mClearEvent = mClearEvent?.copy(
+// content = HashMap(mClearEvent!!.content).apply {
+// this["m.relates_to"] = clearRelates
+// }
+// )
+// }
+// } catch (e: Exception) {
+// Timber.e(e, "Unable to restore 'm.relates_to' the clear event")
+// }
+// }
+//
+//
+// }
+// }
+// mCryptoError = null
+// }
+
+ /**
+ * @return The curve25519 key that sent this event.
+ */
+ fun getSenderKey(): String? {
+ return mxDecryptionResult?.senderKey
+ // return mClearEvent?.mSenderCurve25519Key ?: mSenderCurve25519Key
+ }
+
+ /**
+ * @return The additional keys the sender of this encrypted event claims to possess.
+ */
+ fun getKeysClaimed(): Map {
+ return mxDecryptionResult?.keysClaimed ?: HashMap()
+// val res = HashMap()
+//
+// val claimedEd25519Key = if (null != mClearEvent) mClearEvent!!.mClaimedEd25519Key else mClaimedEd25519Key
+//
+// if (null != claimedEd25519Key) {
+// res["ed25519"] = claimedEd25519Key
+// }
+//
+// return res
+ }
+//
+ /**
+ * @return the event type
+ */
+ fun getClearType(): String {
+ return mxDecryptionResult?.payload?.get("type")?.toString()
+ ?: type//get("type")?.toString() ?: type
+ }
+
+ /**
+ * @return the event content
+ */
+ fun getClearContent(): Content? {
+ return mxDecryptionResult?.payload?.get("content") as? Content ?: content
+ }
+
+// /**
+// * @return the linked crypto error
+// */
+// fun getCryptoError(): MXCryptoError? {
+// return mCryptoError
+// }
+//
+// /**
+// * Update the linked crypto error
+// *
+// * @param error the new crypto error.
+// */
+// fun setCryptoError(error: MXCryptoError?) {
+// mCryptoError = error
+// if (null != error) {
+// mClearEvent = null
+// }
+// }
+
+
+ fun toContentStringWithIndent(): String {
+ val contentMap = this.toContent()?.toMutableMap() ?: HashMap()
+ contentMap.remove("mxDecryptionResult")
+ contentMap.remove("mCryptoError")
+ return JSONObject(contentMap).toString(4)
+ }
+
+ fun toClearContentStringWithIndent(): String? {
+ val contentMap = this.mxDecryptionResult?.payload?.toMutableMap()
+ val adapter = MoshiProvider.providesMoshi().adapter(Map::class.java)
+ return contentMap?.let { JSONObject(adapter.toJson(it)).toString(4) }
+ }
+
+ /**
+ * Tells if the event is redacted
+ */
+ fun isRedacted() = unsignedData?.redactedEvent != null
+
+ override fun equals(other: Any?): Boolean {
+ if (this === other) return true
+ if (javaClass != other?.javaClass) return false
+
+ other as Event
+
+ if (type != other.type) return false
+ if (eventId != other.eventId) return false
+ if (content != other.content) return false
+ if (prevContent != other.prevContent) return false
+ if (originServerTs != other.originServerTs) return false
+ if (senderId != other.senderId) return false
+ if (stateKey != other.stateKey) return false
+ if (roomId != other.roomId) return false
+ if (unsignedData != other.unsignedData) return false
+ if (redacts != other.redacts) return false
+ if (mxDecryptionResult != other.mxDecryptionResult) return false
+ if (mCryptoError != other.mCryptoError) return false
+
+ return true
+ }
+
+ override fun hashCode(): Int {
+ var result = type.hashCode()
+ result = 31 * result + (eventId?.hashCode() ?: 0)
+ result = 31 * result + (content?.hashCode() ?: 0)
+ result = 31 * result + (prevContent?.hashCode() ?: 0)
+ result = 31 * result + (originServerTs?.hashCode() ?: 0)
+ result = 31 * result + (senderId?.hashCode() ?: 0)
+ result = 31 * result + (stateKey?.hashCode() ?: 0)
+ result = 31 * result + (roomId?.hashCode() ?: 0)
+ result = 31 * result + (unsignedData?.hashCode() ?: 0)
+ result = 31 * result + (redacts?.hashCode() ?: 0)
+ result = 31 * result + (mxDecryptionResult?.hashCode() ?: 0)
+ result = 31 * result + (mCryptoError?.hashCode() ?: 0)
+ return result
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/EventType.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/EventType.kt
new file mode 100644
index 00000000..98ce6c0f
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/EventType.kt
@@ -0,0 +1,107 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.events.model
+
+
+/**
+ * Constants defining known event types from Matrix specifications.
+ */
+object EventType {
+
+ const val PRESENCE = "m.presence"
+ const val MESSAGE = "m.room.message"
+ const val STICKER = "m.sticker"
+ const val ENCRYPTED = "m.room.encrypted"
+ const val ENCRYPTION = "m.room.encryption"
+ const val FEEDBACK = "m.room.message.feedback"
+ const val TYPING = "m.typing"
+ const val REDACTION = "m.room.redaction"
+ const val RECEIPT = "m.receipt"
+ const val TAG = "m.tag"
+ const val ROOM_KEY = "m.room_key"
+ const val FULLY_READ = "m.fully_read"
+ const val PLUMBING = "m.room.plumbing"
+ const val BOT_OPTIONS = "m.room.bot.options"
+ const val PREVIEW_URLS = "org.matrix.room.preview_urls"
+
+ // State Events
+
+ const val STATE_ROOM_NAME = "m.room.name"
+ const val STATE_ROOM_TOPIC = "m.room.topic"
+ const val STATE_ROOM_AVATAR = "m.room.avatar"
+ const val STATE_ROOM_MEMBER = "m.room.member"
+ const val STATE_ROOM_THIRD_PARTY_INVITE = "m.room.third_party_invite"
+ const val STATE_ROOM_CREATE = "m.room.create"
+ const val STATE_ROOM_JOIN_RULES = "m.room.join_rules"
+ const val STATE_ROOM_GUEST_ACCESS = "m.room.guest_access"
+ const val STATE_ROOM_POWER_LEVELS = "m.room.power_levels"
+ const val STATE_ROOM_ALIASES = "m.room.aliases"
+ const val STATE_ROOM_TOMBSTONE = "m.room.tombstone"
+ const val STATE_CANONICAL_ALIAS = "m.room.canonical_alias"
+ const val STATE_HISTORY_VISIBILITY = "m.room.history_visibility"
+ const val STATE_RELATED_GROUPS = "m.room.related_groups"
+ const val STATE_PINNED_EVENT = "m.room.pinned_events"
+
+ // Call Events
+
+ const val CALL_INVITE = "m.call.invite"
+ const val CALL_CANDIDATES = "m.call.candidates"
+ const val CALL_ANSWER = "m.call.answer"
+ const val CALL_HANGUP = "m.call.hangup"
+
+ // Key share events
+ const val ROOM_KEY_REQUEST = "m.room_key_request"
+ const val FORWARDED_ROOM_KEY = "m.forwarded_room_key"
+
+ // Interactive key verification
+ const val KEY_VERIFICATION_START = "m.key.verification.start"
+ const val KEY_VERIFICATION_ACCEPT = "m.key.verification.accept"
+ const val KEY_VERIFICATION_KEY = "m.key.verification.key"
+ const val KEY_VERIFICATION_MAC = "m.key.verification.mac"
+ const val KEY_VERIFICATION_CANCEL = "m.key.verification.cancel"
+
+ // Relation Events
+ const val REACTION = "m.reaction"
+
+ private val STATE_EVENTS = listOf(
+ STATE_ROOM_NAME,
+ STATE_ROOM_TOPIC,
+ STATE_ROOM_AVATAR,
+ STATE_ROOM_MEMBER,
+ STATE_ROOM_THIRD_PARTY_INVITE,
+ STATE_ROOM_CREATE,
+ STATE_ROOM_JOIN_RULES,
+ STATE_ROOM_GUEST_ACCESS,
+ STATE_ROOM_POWER_LEVELS,
+ STATE_ROOM_TOMBSTONE,
+ STATE_HISTORY_VISIBILITY,
+ STATE_RELATED_GROUPS,
+ STATE_PINNED_EVENT
+ )
+
+
+ fun isStateEvent(type: String): Boolean {
+ return STATE_EVENTS.contains(type)
+ }
+
+ fun isCallEvent(type: String): Boolean {
+ return type == CALL_INVITE
+ || type == CALL_CANDIDATES
+ || type == CALL_ANSWER
+ || type == CALL_HANGUP
+ }
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/RelationChunkInfo.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/RelationChunkInfo.kt
new file mode 100644
index 00000000..f4f1d866
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/RelationChunkInfo.kt
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.events.model
+
+import com.squareup.moshi.JsonClass
+
+/**
+ *
+ * {
+ * "type": "m.reaction",
+ * "key": "👍",
+ * "count": 3
+ * }
+ *
+ */
+
+@JsonClass(generateAdapter = true)
+data class RelationChunkInfo(
+ val type: String,
+ val key: String,
+ val count: Int
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/RelationType.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/RelationType.kt
new file mode 100644
index 00000000..56d4801c
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/RelationType.kt
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.events.model
+
+
+/**
+ * Constants defining known event relation types from Matrix specifications.
+ */
+object RelationType {
+
+ /** Lets you define an event which annotates an existing event.*/
+ const val ANNOTATION = "m.annotation"
+ /** Lets you define an event which replaces an existing event.*/
+ const val REPLACE = "m.replace"
+ /** ets you define an event which references an existing event.*/
+ const val REFERENCE = "m.reference"
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/UnsignedData.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/UnsignedData.kt
new file mode 100644
index 00000000..4a9547e3
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/UnsignedData.kt
@@ -0,0 +1,29 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.events.model
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class UnsignedData(
+ @Json(name = "age") val age: Long?,
+ @Json(name = "redacted_because") val redactedEvent: Event? = null,
+ @Json(name = "transaction_id") val transactionId: String? = null,
+ @Json(name = "prev_content") val prevContent: Map? = null,
+ @Json(name = "m.relations") val relations: AggregatedRelations? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/UnsignedRelationInfo.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/UnsignedRelationInfo.kt
new file mode 100644
index 00000000..5b627b62
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/UnsignedRelationInfo.kt
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.events.model
+
+
+interface UnsignedRelationInfo {
+ val limited : Boolean?
+ val count: Int?
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/file/FileService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/file/FileService.kt
new file mode 100644
index 00000000..296b7e15
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/file/FileService.kt
@@ -0,0 +1,52 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.file
+
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.internal.crypto.attachments.ElementToDecrypt
+import java.io.File
+
+
+/**
+ * This interface defines methods to get files.
+ */
+interface FileService {
+
+ enum class DownloadMode {
+ /**
+ * Download file in external storage
+ */
+ TO_EXPORT,
+ /**
+ * Download file in cache
+ */
+ FOR_INTERNAL_USE
+ }
+
+ /**
+ * Download a file.
+ * Result will be a decrypted file, stored in the cache folder. id parameter will be used to create a sub folder to avoid name collision.
+ * You can pass the eventId
+ */
+ fun downloadFile(
+ downloadMode: DownloadMode,
+ id: String,
+ fileName: String,
+ url: String?,
+ elementToDecrypt: ElementToDecrypt?,
+ callback: MatrixCallback)
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/group/Group.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/group/Group.kt
new file mode 100644
index 00000000..ae41eb9e
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/group/Group.kt
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.group
+
+/**
+ * This interface defines methods to interact within a group.
+ */
+interface Group {
+ val groupId: String
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/group/GroupService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/group/GroupService.kt
new file mode 100644
index 00000000..2ccfbff2
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/group/GroupService.kt
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.group
+
+import androidx.lifecycle.LiveData
+import im.vector.matrix.android.api.session.group.model.GroupSummary
+
+
+/**
+ * This interface defines methods to get groups. It's implemented at the session level.
+ */
+interface GroupService {
+
+ /**
+ * Get a group from a groupId
+ * @param groupId the groupId to look for.
+ * @return the group with groupId or null
+ */
+ fun getGroup(groupId: String): Group?
+
+ /**
+ * Get a live list of group summaries. This list is refreshed as soon as the data changes.
+ * @return the [LiveData] of [GroupSummary]
+ */
+ fun liveGroupSummaries(): LiveData>
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/group/model/GroupSummary.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/group/model/GroupSummary.kt
new file mode 100644
index 00000000..3089d83d
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/group/model/GroupSummary.kt
@@ -0,0 +1,30 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.group.model
+
+/**
+ * This class holds some data of a group.
+ * It can be retrieved through [im.vector.matrix.android.api.session.group.GroupService]
+ */
+data class GroupSummary(
+ val groupId: String,
+ val displayName: String = "",
+ val shortDescription: String = "",
+ val avatarUrl: String = "",
+ val roomIds: List = emptyList(),
+ val userIds: List = emptyList()
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/pushers/Pusher.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/pushers/Pusher.kt
new file mode 100644
index 00000000..7b1fa3bb
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/pushers/Pusher.kt
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.pushers
+
+data class Pusher(
+
+ val userId: String,
+
+ val pushKey: String,
+ val kind: String,
+ val appId: String,
+ val appDisplayName: String?,
+ val deviceDisplayName: String?,
+ val profileTag: String? = null,
+ val lang: String?,
+ val data: PusherData,
+
+ val state: PusherState
+)
+
+enum class PusherState {
+ UNREGISTERED,
+ REGISTERING,
+ UNREGISTERING,
+ REGISTERED,
+ FAILED_TO_REGISTER
+}
+
+data class PusherData(
+ val url: String? = null,
+ val format: String? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/pushers/PushersService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/pushers/PushersService.kt
new file mode 100644
index 00000000..1450dbb5
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/pushers/PushersService.kt
@@ -0,0 +1,66 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.pushers
+
+import androidx.lifecycle.LiveData
+import im.vector.matrix.android.api.MatrixCallback
+import java.util.*
+
+
+interface PushersService {
+
+ /**
+ * Refresh pushers from server state
+ */
+ fun refreshPushers()
+
+ /**
+ * Add a new HTTP pusher.
+ *
+ * @param pushkey the pushkey
+ * @param appId the application id
+ * @param profileTag the profile tag
+ * @param lang the language
+ * @param appDisplayName a human-readable application name
+ * @param deviceDisplayName a human-readable device name
+ * @param url the URL that should be used to send notifications
+ * @param append append the pusher
+ * @param withEventIdOnly true to limit the push content
+ *
+ * @return A work request uuid. Can be used to listen to the status
+ * (LiveData status = workManager.getWorkInfoByIdLiveData())
+ */
+ fun addHttpPusher(pushkey: String,
+ appId: String,
+ profileTag: String,
+ lang: String,
+ appDisplayName: String,
+ deviceDisplayName: String,
+ url: String,
+ append: Boolean,
+ withEventIdOnly: Boolean): UUID
+
+
+ fun removeHttpPusher(pushkey: String, appId: String, callback: MatrixCallback)
+
+ companion object {
+ const val EVENT_ID_ONLY = "event_id_only"
+ }
+
+ fun livePushers(): LiveData>
+
+ fun pushers() : List
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/Room.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/Room.kt
new file mode 100644
index 00000000..ec6b382f
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/Room.kt
@@ -0,0 +1,54 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room
+
+import androidx.lifecycle.LiveData
+import im.vector.matrix.android.api.session.room.crypto.RoomCryptoService
+import im.vector.matrix.android.api.session.room.members.MembershipService
+import im.vector.matrix.android.api.session.room.model.RoomSummary
+import im.vector.matrix.android.api.session.room.model.relation.RelationService
+import im.vector.matrix.android.api.session.room.read.ReadService
+import im.vector.matrix.android.api.session.room.send.SendService
+import im.vector.matrix.android.api.session.room.state.StateService
+import im.vector.matrix.android.api.session.room.timeline.TimelineService
+
+/**
+ * This interface defines methods to interact within a room.
+ */
+interface Room :
+ TimelineService,
+ SendService,
+ ReadService,
+ MembershipService,
+ StateService,
+ RelationService,
+ RoomCryptoService {
+
+ /**
+ * The roomId of this room
+ */
+ val roomId: String
+
+ /**
+ * A live [RoomSummary] associated with the room
+ * You can observe this summary to get dynamic data from this room.
+ */
+ fun liveRoomSummary(): LiveData
+
+ fun roomSummary(): RoomSummary?
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/RoomDirectoryService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/RoomDirectoryService.kt
new file mode 100644
index 00000000..5b66ddd8
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/RoomDirectoryService.kt
@@ -0,0 +1,49 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room
+
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.session.room.model.roomdirectory.PublicRoomsParams
+import im.vector.matrix.android.api.session.room.model.roomdirectory.PublicRoomsResponse
+import im.vector.matrix.android.api.session.room.model.thirdparty.ThirdPartyProtocol
+import im.vector.matrix.android.api.util.Cancelable
+
+/**
+ * This interface defines methods to get and join public rooms. It's implemented at the session level.
+ */
+interface RoomDirectoryService {
+
+ /**
+ * Get rooms from directory
+ */
+ fun getPublicRooms(server: String?,
+ publicRoomsParams: PublicRoomsParams,
+ callback: MatrixCallback): Cancelable
+
+ /**
+ * Join a room by id
+ */
+ fun joinRoom(roomId: String,
+ callback: MatrixCallback)
+
+ /**
+ * Fetches the overall metadata about protocols supported by the homeserver.
+ * Includes both the available protocols and all fields required for queries against each protocol.
+ */
+ fun getThirdPartyProtocol(callback: MatrixCallback>)
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/RoomService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/RoomService.kt
new file mode 100644
index 00000000..fc0bf499
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/RoomService.kt
@@ -0,0 +1,48 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room
+
+import androidx.lifecycle.LiveData
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.session.room.model.RoomSummary
+import im.vector.matrix.android.api.session.room.model.create.CreateRoomParams
+
+/**
+ * This interface defines methods to get rooms. It's implemented at the session level.
+ */
+interface RoomService {
+
+ /**
+ * Create a room
+ */
+ fun createRoom(createRoomParams: CreateRoomParams,
+ callback: MatrixCallback)
+
+ /**
+ * Get a room from a roomId
+ * @param roomId the roomId to look for.
+ * @return a room with roomId or null
+ */
+ fun getRoom(roomId: String): Room?
+
+ /**
+ * Get a live list of room summaries. This list is refreshed as soon as the data changes.
+ * @return the [LiveData] of [RoomSummary]
+ */
+ fun liveRoomSummaries(): LiveData>
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/crypto/RoomCryptoService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/crypto/RoomCryptoService.kt
new file mode 100644
index 00000000..910002ab
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/crypto/RoomCryptoService.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.crypto
+
+interface RoomCryptoService {
+
+ fun isEncrypted(): Boolean
+
+ fun encryptionAlgorithm(): String?
+
+ fun shouldEncryptForInvitedMembers(): Boolean
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/members/MembershipService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/members/MembershipService.kt
new file mode 100644
index 00000000..ca3b99b6
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/members/MembershipService.kt
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.members
+
+import androidx.lifecycle.LiveData
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.session.room.model.RoomMember
+import im.vector.matrix.android.api.util.Cancelable
+
+/**
+ * This interface defines methods to handling membership. It's implemented at the room level.
+ */
+interface MembershipService {
+
+ /**
+ * This methods load all room members if it was done yet.
+ * @return a [Cancelable]
+ */
+ fun loadRoomMembersIfNeeded(): Cancelable
+
+ /**
+ * Return the roomMember with userId or null.
+ * @param userId the userId param to look for
+ *
+ * @return the roomMember with userId or null
+ */
+ fun getRoomMember(userId: String): RoomMember?
+
+ /**
+ * Return all the roomMembers ids of the room
+ *
+ * @return a [LiveData] of roomMember list.
+ */
+ fun getRoomMemberIdsLive(): LiveData>
+
+ fun getNumberOfJoinedMembers(): Int
+
+ /**
+ * Invite a user in the room
+ */
+ fun invite(userId: String, callback: MatrixCallback)
+
+ /**
+ * Join the room, or accept an invitation.
+ */
+ fun join(callback: MatrixCallback)
+
+ /**
+ * Leave the room, or reject an invitation.
+ */
+ fun leave(callback: MatrixCallback)
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/EditAggregatedSummary.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/EditAggregatedSummary.kt
new file mode 100644
index 00000000..759ba1ec
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/EditAggregatedSummary.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import im.vector.matrix.android.api.session.events.model.Content
+
+data class EditAggregatedSummary(
+ val aggregatedContent: Content? = null,
+ // The list of the eventIDs used to build the summary (might be out of sync if chunked received from message chunk)
+ val sourceEvents: List,
+ val localEchos: List,
+ val lastEditTs: Long = 0
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/EventAnnotationsSummary.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/EventAnnotationsSummary.kt
new file mode 100644
index 00000000..18899f87
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/EventAnnotationsSummary.kt
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+data class EventAnnotationsSummary(
+ var eventId: String,
+ var reactionsSummary: List,
+ var editSummary: EditAggregatedSummary?
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/Invite.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/Invite.kt
new file mode 100644
index 00000000..c808ad55
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/Invite.kt
@@ -0,0 +1,30 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Subclass representing a search API response
+ */
+@JsonClass(generateAdapter = true)
+data class Invite(
+ @Json(name = "display_name") val displayName: String,
+ @Json(name = "signed") val signed: Signed
+
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/Membership.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/Membership.kt
new file mode 100644
index 00000000..d87bb9b3
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/Membership.kt
@@ -0,0 +1,47 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import com.squareup.moshi.Json
+
+/**
+ * Represents the membership of a user on a room
+ */
+enum class Membership(val value: String) {
+
+ NONE("none"),
+
+ @Json(name = "invite")
+ INVITE("invite"),
+
+ @Json(name = "join")
+ JOIN("join"),
+
+ @Json(name = "knock")
+ KNOCK("knock"),
+
+ @Json(name = "leave")
+ LEAVE("leave"),
+
+ @Json(name = "ban")
+ BAN("ban");
+
+ fun isLeft(): Boolean {
+ return this == KNOCK || this == LEAVE || this == BAN
+ }
+
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/PowerLevels.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/PowerLevels.kt
new file mode 100644
index 00000000..964d6182
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/PowerLevels.kt
@@ -0,0 +1,137 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import android.text.TextUtils
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.session.events.model.EventType
+import java.util.*
+
+/**
+ * Class representing the EventType.EVENT_TYPE_STATE_ROOM_POWER_LEVELS state event content.
+ */
+@JsonClass(generateAdapter = true)
+data class PowerLevels(
+ @Json(name = "ban") val ban: Int = 50,
+ @Json(name = "kick") val kick: Int = 50,
+ @Json(name = "invite") val invite: Int = 50,
+ @Json(name = "redact") val redact: Int = 50,
+ @Json(name = "events_default") val eventsDefault: Int = 0,
+ @Json(name = "events") val events: MutableMap = HashMap(),
+ @Json(name = "users_default") val usersDefault: Int = 0,
+ @Json(name = "users") val users: MutableMap = HashMap(),
+ @Json(name = "state_default") val stateDefault: Int = 50,
+ @Json(name = "notifications") val notifications: Map = HashMap()
+) {
+
+ /**
+ * Returns the user power level of a dedicated user Id
+ *
+ * @param userId the user id
+ * @return the power level
+ */
+ fun getUserPowerLevel(userId: String): Int {
+ // sanity check
+ if (!TextUtils.isEmpty(userId)) {
+ val powerLevel = users[userId]
+ return powerLevel ?: usersDefault
+ }
+
+ return usersDefault
+ }
+
+ /**
+ * Updates the user power levels of a dedicated user id
+ *
+ * @param userId the user
+ * @param powerLevel the new power level
+ */
+ fun setUserPowerLevel(userId: String?, powerLevel: Int) {
+ if (null != userId) {
+ users[userId] = Integer.valueOf(powerLevel)
+ }
+ }
+
+ /**
+ * Tell if an user can send an event of type 'eventTypeString'.
+ *
+ * @param eventTypeString the event type (in Event.EVENT_TYPE_XXX values)
+ * @param userId the user id
+ * @return true if the user can send the event
+ */
+ fun maySendEventOfType(eventTypeString: String, userId: String): Boolean {
+ return if (!TextUtils.isEmpty(eventTypeString) && !TextUtils.isEmpty(userId)) {
+ getUserPowerLevel(userId) >= minimumPowerLevelForSendingEventAsMessage(eventTypeString)
+ } else false
+
+ }
+
+ /**
+ * Tells if an user can send a room message.
+ *
+ * @param userId the user id
+ * @return true if the user can send a room message
+ */
+ fun maySendMessage(userId: String): Boolean {
+ return maySendEventOfType(EventType.MESSAGE, userId)
+ }
+
+ /**
+ * Helper to get the minimum power level the user must have to send an event of the given type
+ * as a message.
+ *
+ * @param eventTypeString the type of event (in Event.EVENT_TYPE_XXX values)
+ * @return the required minimum power level.
+ */
+ fun minimumPowerLevelForSendingEventAsMessage(eventTypeString: String?): Int {
+ return events[eventTypeString] ?: eventsDefault
+ }
+
+ /**
+ * Helper to get the minimum power level the user must have to send an event of the given type
+ * as a state event.
+ *
+ * @param eventTypeString the type of event (in Event.EVENT_TYPE_STATE_ values).
+ * @return the required minimum power level.
+ */
+ fun minimumPowerLevelForSendingEventAsStateEvent(eventTypeString: String?): Int {
+ return events[eventTypeString] ?: stateDefault
+ }
+
+
+ /**
+ * Get the notification level for a dedicated key.
+ *
+ * @param key the notification key
+ * @return the level
+ */
+ fun notificationLevel(key: String?): Int {
+ if (null != key && notifications.containsKey(key)) {
+ val valAsVoid = notifications[key]
+
+ // the first implementation was a string value
+ return if (valAsVoid is String) {
+ Integer.parseInt(valAsVoid)
+ } else {
+ valAsVoid as Int
+ }
+ }
+
+ return 50
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/ReactionAggregatedSummary.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/ReactionAggregatedSummary.kt
new file mode 100644
index 00000000..7036f681
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/ReactionAggregatedSummary.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+data class ReactionAggregatedSummary(
+ val key: String, // "👍"
+ val count: Int, // 8
+ val addedByMe: Boolean, // true
+ val firstTimestamp: Long, // unix timestamp
+ val sourceEvents: List,
+ val localEchoEvents: List
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/ReadReceipt.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/ReadReceipt.kt
new file mode 100644
index 00000000..0516b1af
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/ReadReceipt.kt
@@ -0,0 +1,23 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+data class ReadReceipt(
+ val userId: String,
+ val eventId: String,
+ val originServerTs: Long
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomAliasesContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomAliasesContent.kt
new file mode 100644
index 00000000..74b29b7a
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomAliasesContent.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Class representing the EventType.STATE_ROOM_ALIASES state event content
+ */
+@JsonClass(generateAdapter = true)
+data class RoomAliasesContent(
+ @Json(name = "aliases") val aliases: List = emptyList()
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomAvatarContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomAvatarContent.kt
new file mode 100644
index 00000000..8f81632b
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomAvatarContent.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Class representing the EventType.STATE_ROOM_AVATAR state event content
+ */
+@JsonClass(generateAdapter = true)
+data class RoomAvatarContent(
+ @Json(name = "url") val avatarUrl: String? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomCanonicalAliasContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomCanonicalAliasContent.kt
new file mode 100644
index 00000000..abaa9f0a
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomCanonicalAliasContent.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Class representing the EventType.STATE_CANONICAL_ALIAS state event content
+ */
+@JsonClass(generateAdapter = true)
+data class RoomCanonicalAliasContent(
+ @Json(name = "alias") val canonicalAlias: String? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomDirectoryVisibility.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomDirectoryVisibility.kt
new file mode 100644
index 00000000..2e1b5a39
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomDirectoryVisibility.kt
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import com.squareup.moshi.Json
+
+enum class RoomDirectoryVisibility {
+ @Json(name = "private") PRIVATE,
+ @Json(name = "public") PUBLIC
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomHistoryVisibility.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomHistoryVisibility.kt
new file mode 100644
index 00000000..9260b011
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomHistoryVisibility.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import com.squareup.moshi.Json
+
+enum class RoomHistoryVisibility {
+ @Json(name = "shared") SHARED,
+ @Json(name = "invited") INVITED,
+ @Json(name = "joined") JOINED,
+ @Json(name = "world_readable") WORLD_READABLE
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomHistoryVisibilityContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomHistoryVisibilityContent.kt
new file mode 100644
index 00000000..7781bcda
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomHistoryVisibilityContent.kt
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class RoomHistoryVisibilityContent(
+ @Json(name = "history_visibility") val historyVisibility: RoomHistoryVisibility? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomMember.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomMember.kt
new file mode 100644
index 00000000..10c3e8ec
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomMember.kt
@@ -0,0 +1,34 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.session.events.model.UnsignedData
+
+/**
+ * Class representing the EventType.STATE_ROOM_MEMBER state event content
+ */
+@JsonClass(generateAdapter = true)
+data class RoomMember(
+ @Json(name = "membership") val membership: Membership,
+ @Json(name = "displayname") val displayName: String? = null,
+ @Json(name = "avatar_url") val avatarUrl: String? = null,
+ @Json(name = "is_direct") val isDirect: Boolean = false,
+ @Json(name = "third_party_invite") val thirdPartyInvite: Invite? = null,
+ @Json(name = "unsigned") val unsignedData: UnsignedData? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomNameContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomNameContent.kt
new file mode 100644
index 00000000..48cbb91c
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomNameContent.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Class representing the EventType.STATE_ROOM_NAME state event content
+ */
+@JsonClass(generateAdapter = true)
+data class RoomNameContent(
+ @Json(name = "name") val name: String? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomSummary.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomSummary.kt
new file mode 100644
index 00000000..b54f17db
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomSummary.kt
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import im.vector.matrix.android.api.session.room.model.tag.RoomTag
+import im.vector.matrix.android.api.session.room.timeline.TimelineEvent
+
+/**
+ * This class holds some data of a room.
+ * It can be retrieved by [im.vector.matrix.android.api.session.room.Room] and [im.vector.matrix.android.api.session.room.RoomService]
+ */
+data class RoomSummary(
+ val roomId: String,
+ val displayName: String = "",
+ val topic: String = "",
+ val avatarUrl: String = "",
+ val isDirect: Boolean = false,
+ val latestEvent: TimelineEvent? = null,
+ val otherMemberIds: List = emptyList(),
+ val notificationCount: Int = 0,
+ val highlightCount: Int = 0,
+ val tags: List = emptyList(),
+ val membership: Membership = Membership.NONE
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomTopicContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomTopicContent.kt
new file mode 100644
index 00000000..8a6e3f90
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomTopicContent.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Class representing the EventType.STATE_ROOM_TOPIC state event content
+ */
+@JsonClass(generateAdapter = true)
+data class RoomTopicContent(
+ @Json(name = "topic") val topic: String? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/Signed.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/Signed.kt
new file mode 100644
index 00000000..4f0e5212
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/Signed.kt
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model
+
+import com.squareup.moshi.Json
+
+data class Signed(
+ @Json(name = "token") val token: String,
+ @Json(name = "signatures") val signatures: Any,
+ @Json(name = "mxid") val mxid: String
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/call/CallAnswerContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/call/CallAnswerContent.kt
new file mode 100644
index 00000000..05395718
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/call/CallAnswerContent.kt
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.call
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class CallAnswerContent(
+ @Json(name = "call_id") val callId: String,
+ @Json(name = "version") val version: Int,
+ @Json(name = "answer") val answer: Answer
+) {
+
+ @JsonClass(generateAdapter = true)
+ data class Answer(
+ @Json(name = "type") val type: String,
+ @Json(name = "sdp") val sdp: String
+ )
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/call/CallCandidatesContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/call/CallCandidatesContent.kt
new file mode 100644
index 00000000..48c02f3d
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/call/CallCandidatesContent.kt
@@ -0,0 +1,36 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.call
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class CallCandidatesContent(
+ @Json(name = "call_id") val callId: String,
+ @Json(name = "version") val version: Int,
+ @Json(name = "candidates") val candidates: List = emptyList()
+) {
+
+ @JsonClass(generateAdapter = true)
+ data class Candidate(
+ @Json(name = "sdpMid") val sdpMid: String,
+ @Json(name = "sdpMLineIndex") val sdpMLineIndex: String,
+ @Json(name = "candidate") val candidate: String
+ )
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/call/CallHangupContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/call/CallHangupContent.kt
new file mode 100644
index 00000000..eda2486a
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/call/CallHangupContent.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.call
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class CallHangupContent(
+ @Json(name = "call_id") val callId: String,
+ @Json(name = "version") val version: Int
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/call/CallInviteContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/call/CallInviteContent.kt
new file mode 100644
index 00000000..58e5d561
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/call/CallInviteContent.kt
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.call
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class CallInviteContent(
+ @Json(name = "call_id") val callId: String,
+ @Json(name = "version") val version: Int,
+ @Json(name = "lifetime") val lifetime: Int,
+ @Json(name = "offer") val offer: Offer
+) {
+
+ @JsonClass(generateAdapter = true)
+ data class Offer(
+ @Json(name = "type") val type: String,
+ @Json(name = "sdp") val sdp: String
+ ) {
+ companion object {
+ const val SDP_VIDEO = "m=video"
+ }
+ }
+
+
+ fun isVideo(): Boolean = offer.sdp.contains(Offer.SDP_VIDEO)
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/CreateRoomParams.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/CreateRoomParams.kt
new file mode 100644
index 00000000..77c4fcf1
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/CreateRoomParams.kt
@@ -0,0 +1,249 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.create
+
+import android.util.Patterns
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.MatrixPatterns.isUserId
+import im.vector.matrix.android.api.auth.data.Credentials
+import im.vector.matrix.android.api.auth.data.HomeServerConnectionConfig
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.api.session.events.model.EventType
+import im.vector.matrix.android.api.session.events.model.toContent
+import im.vector.matrix.android.api.session.room.model.PowerLevels
+import im.vector.matrix.android.api.session.room.model.RoomDirectoryVisibility
+import im.vector.matrix.android.api.session.room.model.RoomHistoryVisibility
+import im.vector.matrix.android.internal.auth.data.ThreePidMedium
+import java.util.*
+
+/**
+ * Parameter to create a room, with facilities functions to configure it
+ */
+@JsonClass(generateAdapter = true)
+class CreateRoomParams {
+
+ /**
+ * A public visibility indicates that the room will be shown in the published room list.
+ * A private visibility will hide the room from the published room list.
+ * Rooms default to private visibility if this key is not included.
+ * NB: This should not be confused with join_rules which also uses the word public. One of: ["public", "private"]
+ */
+ var visibility: RoomDirectoryVisibility? = null
+
+ /**
+ * The desired room alias local part. If this is included, a room alias will be created and mapped to the newly created room.
+ * The alias will belong on the same homeserver which created the room.
+ * For example, if this was set to "foo" and sent to the homeserver "example.com" the complete room alias would be #foo:example.com.
+ */
+ @Json(name = "room_alias_name")
+ var roomAliasName: String? = null
+
+ /**
+ * If this is included, an m.room.name event will be sent into the room to indicate the name of the room.
+ * See Room Events for more information on m.room.name.
+ */
+ var name: String? = null
+
+ /**
+ * If this is included, an m.room.topic event will be sent into the room to indicate the topic for the room.
+ * See Room Events for more information on m.room.topic.
+ */
+ var topic: String? = null
+
+ /**
+ * A list of user IDs to invite to the room.
+ * This will tell the server to invite everyone in the list to the newly created room.
+ */
+ @Json(name = "invite")
+ var invitedUserIds: MutableList? = null
+
+ /**
+ * A list of objects representing third party IDs to invite into the room.
+ */
+ @Json(name = "invite_3pid")
+ var invite3pids: MutableList? = null
+
+ /**
+ * Extra keys to be added to the content of the m.room.create.
+ * The server will clobber the following keys: creator.
+ * Future versions of the specification may allow the server to clobber other keys.
+ */
+ @Json(name = "creation_content")
+ var creationContent: Any? = null
+
+ /**
+ * A list of state events to set in the new room.
+ * This allows the user to override the default state events set in the new room.
+ * The expected format of the state events are an object with type, state_key and content keys set.
+ * Takes precedence over events set by presets, but gets overriden by name and topic keys.
+ */
+ @Json(name = "initial_state")
+ var initialStates: MutableList? = null
+
+ /**
+ * Convenience parameter for setting various default state events based on a preset. Must be either:
+ * private_chat => join_rules is set to invite. history_visibility is set to shared.
+ * trusted_private_chat => join_rules is set to invite. history_visibility is set to shared. All invitees are given the same power level as the
+ * room creator.
+ * public_chat: => join_rules is set to public. history_visibility is set to shared.
+ */
+ var preset: CreateRoomPreset? = null
+
+ /**
+ * This flag makes the server set the is_direct flag on the m.room.member events sent to the users in invite and invite_3pid.
+ * See Direct Messaging for more information.
+ */
+ @Json(name = "is_direct")
+ var isDirect: Boolean? = null
+
+ /**
+ * The power level content to override in the default power level event
+ */
+ @Json(name = "power_level_content_override")
+ var powerLevelContentOverride: PowerLevels? = null
+
+ /**
+ * Add the crypto algorithm to the room creation parameters.
+ *
+ * @param algorithm the algorithm
+ */
+ fun addCryptoAlgorithm(algorithm: String) {
+ if (algorithm.isNotBlank()) {
+ val contentMap = HashMap()
+ contentMap["algorithm"] = algorithm
+
+ val algoEvent = Event(type = EventType.ENCRYPTION,
+ stateKey = "",
+ content = contentMap.toContent()
+ )
+
+ if (null == initialStates) {
+ initialStates = Arrays.asList(algoEvent)
+ } else {
+ initialStates!!.add(algoEvent)
+ }
+ }
+ }
+
+ /**
+ * Force the history visibility in the room creation parameters.
+ *
+ * @param historyVisibility the expected history visibility, set null to remove any existing value.
+ */
+ fun setHistoryVisibility(historyVisibility: RoomHistoryVisibility?) {
+ // Remove the existing value if any.
+ if (initialStates != null && !initialStates!!.isEmpty()) {
+ val newInitialStates = ArrayList()
+ for (event in initialStates!!) {
+ if (event.getClearType() != EventType.STATE_HISTORY_VISIBILITY) {
+ newInitialStates.add(event)
+ }
+ }
+ initialStates = newInitialStates
+ }
+
+ if (historyVisibility != null) {
+ val contentMap = HashMap()
+ contentMap["history_visibility"] = historyVisibility
+
+ val historyVisibilityEvent = Event(type = EventType.STATE_HISTORY_VISIBILITY,
+ stateKey = "",
+ content = contentMap.toContent())
+
+ if (null == initialStates) {
+ initialStates = Arrays.asList(historyVisibilityEvent)
+ } else {
+ initialStates!!.add(historyVisibilityEvent)
+ }
+ }
+ }
+
+ /**
+ * Mark as a direct message room.
+ */
+ fun setDirectMessage() {
+ preset = CreateRoomPreset.PRESET_TRUSTED_PRIVATE_CHAT
+ isDirect = true
+ }
+
+ /**
+ * @return the invite count
+ */
+ private fun getInviteCount(): Int {
+ return invitedUserIds?.size ?: 0
+ }
+
+ /**
+ * @return the pid invite count
+ */
+ private fun getInvite3PidCount(): Int {
+ return invite3pids?.size ?: 0
+ }
+
+ /**
+ * Tells if the created room can be a direct chat one.
+ *
+ * @return true if it is a direct chat
+ */
+ fun isDirect(): Boolean {
+ return preset == CreateRoomPreset.PRESET_TRUSTED_PRIVATE_CHAT
+ && isDirect == true
+ && (1 == getInviteCount() || 1 == getInvite3PidCount())
+ }
+
+ /**
+ * @return the first invited user id
+ */
+ fun getFirstInvitedUserId(): String? {
+ return invitedUserIds?.firstOrNull() ?: invite3pids?.firstOrNull()?.address
+ }
+
+ /**
+ * Add some ids to the room creation
+ * ids might be a matrix id or an email address.
+ *
+ * @param ids the participant ids to add.
+ */
+ fun addParticipantIds(hsConfig: HomeServerConnectionConfig,
+ credentials: Credentials,
+ ids: List) {
+ for (id in ids) {
+ if (Patterns.EMAIL_ADDRESS.matcher(id).matches()) {
+ if (null == invite3pids) {
+ invite3pids = ArrayList()
+ }
+
+ val pid = Invite3Pid(idServer = hsConfig.identityServerUri.host!!,
+ medium = ThreePidMedium.EMAIL,
+ address = id)
+
+ invite3pids!!.add(pid)
+ } else if (isUserId(id)) {
+ // do not invite oneself
+ if (credentials.userId != id) {
+ if (null == invitedUserIds) {
+ invitedUserIds = ArrayList()
+ }
+
+ invitedUserIds!!.add(id)
+ }
+ }
+ // TODO add phonenumbers when it will be available
+ }
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/CreateRoomPreset.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/CreateRoomPreset.kt
new file mode 100644
index 00000000..9548062b
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/CreateRoomPreset.kt
@@ -0,0 +1,30 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.create
+
+import com.squareup.moshi.Json
+
+enum class CreateRoomPreset {
+ @Json(name = "private_chat")
+ PRESET_PRIVATE_CHAT,
+
+ @Json(name = "public_chat")
+ PRESET_PUBLIC_CHAT,
+
+ @Json(name = "trusted_private_chat")
+ PRESET_TRUSTED_PRIVATE_CHAT
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/CreateRoomResponse.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/CreateRoomResponse.kt
new file mode 100644
index 00000000..c437bcfb
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/CreateRoomResponse.kt
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.create
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+internal data class CreateRoomResponse(
+ @Json(name = "room_id") var roomId: String? = null
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/Invite3Pid.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/Invite3Pid.kt
new file mode 100644
index 00000000..5ad920a3
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/Invite3Pid.kt
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.create
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class Invite3Pid(
+ /**
+ * Required.
+ * The hostname+port of the identity server which should be used for third party identifier lookups.
+ */
+ @Json(name = "id_server")
+ val idServer: String,
+
+ /**
+ * Required.
+ * The kind of address being passed in the address field, for example email.
+ */
+ val medium: String,
+
+ /**
+ * Required.
+ * The invitee's third party identifier.
+ */
+ val address: String
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/AudioInfo.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/AudioInfo.kt
new file mode 100644
index 00000000..de30d460
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/AudioInfo.kt
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class AudioInfo(
+ /**
+ * The mimetype of the audio e.g. "audio/aac".
+ */
+ @Json(name = "mimetype") val mimeType: String,
+
+ /**
+ * The size of the audio clip in bytes.
+ */
+ @Json(name = "size") val size: Long = 0,
+
+ /**
+ * The duration of the audio in milliseconds.
+ */
+ @Json(name = "duration") val duration: Int = 0
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/FileInfo.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/FileInfo.kt
new file mode 100644
index 00000000..d5dfb04f
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/FileInfo.kt
@@ -0,0 +1,49 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.internal.crypto.model.rest.EncryptedFileInfo
+
+@JsonClass(generateAdapter = true)
+data class FileInfo(
+ /**
+ * The mimetype of the file e.g. application/msword.
+ */
+ @Json(name = "mimetype") val mimeType: String?,
+
+ /**
+ * The size of the file in bytes.
+ */
+ @Json(name = "size") val size: Long = 0,
+
+ /**
+ * Metadata about the image referred to in thumbnail_url.
+ */
+ @Json(name = "thumbnail_info") val thumbnailInfo: ThumbnailInfo? = null,
+
+ /**
+ * The URL to the thumbnail of the file. Only present if the thumbnail is unencrypted.
+ */
+ @Json(name = "thumbnail_url") val thumbnailUrl: String? = null,
+
+ /**
+ * Information on the encrypted thumbnail file, as specified in End-to-end encryption. Only present if the thumbnail is encrypted.
+ */
+ @Json(name = "thumbnail_file") val thumbnailFile: EncryptedFileInfo? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/ImageInfo.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/ImageInfo.kt
new file mode 100644
index 00000000..729bc604
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/ImageInfo.kt
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.internal.crypto.model.rest.EncryptedFileInfo
+
+@JsonClass(generateAdapter = true)
+data class ImageInfo(
+ /**
+ * The mimetype of the image, e.g. "image/jpeg".
+ */
+ @Json(name = "mimetype") val mimeType: String?,
+
+ /**
+ * The intended display width of the image in pixels. This may differ from the intrinsic dimensions of the image file.
+ */
+ @Json(name = "w") val width: Int = 0,
+
+ /**
+ * The intended display height of the image in pixels. This may differ from the intrinsic dimensions of the image file.
+ */
+ @Json(name = "h") val height: Int = 0,
+
+ /**
+ * Size of the image in bytes.
+ */
+ @Json(name = "size") val size: Int = 0,
+
+ /**
+ * Not documented
+ */
+ @Json(name = "rotation") val rotation: Int = 0,
+
+ /**
+ * Not documented
+ */
+ @Json(name = "orientation") val orientation: Int = 0,
+
+ /**
+ * Metadata about the image referred to in thumbnail_url.
+ */
+ @Json(name = "thumbnail_info") val thumbnailInfo: ThumbnailInfo? = null,
+
+ /**
+ * The URL (typically MXC URI) to a thumbnail of the image. Only present if the thumbnail is unencrypted.
+ */
+ @Json(name = "thumbnail_url") val thumbnailUrl: String? = null,
+
+ /**
+ * Information on the encrypted thumbnail file, as specified in End-to-end encryption. Only present if the thumbnail is encrypted.
+ */
+ @Json(name = "thumbnail_file") val thumbnailFile: EncryptedFileInfo? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/LocationInfo.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/LocationInfo.kt
new file mode 100644
index 00000000..f00d4882
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/LocationInfo.kt
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.internal.crypto.model.rest.EncryptedFileInfo
+
+@JsonClass(generateAdapter = true)
+data class LocationInfo(
+ /**
+ * The URL to the thumbnail of the file. Only present if the thumbnail is unencrypted.
+ */
+ @Json(name = "thumbnail_url") val thumbnailUrl: String? = null,
+
+ /**
+ * Metadata about the image referred to in thumbnail_url.
+ */
+ @Json(name = "thumbnail_info") val thumbnailInfo: ThumbnailInfo? = null,
+
+ /**
+ * Information on the encrypted thumbnail file, as specified in End-to-end encryption. Only present if the thumbnail is encrypted.
+ */
+ @Json(name = "thumbnail_file") val thumbnailFile: EncryptedFileInfo? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageAudioContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageAudioContent.kt
new file mode 100644
index 00000000..624d827d
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageAudioContent.kt
@@ -0,0 +1,54 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.room.model.relation.RelationDefaultContent
+import im.vector.matrix.android.internal.crypto.model.rest.EncryptedFileInfo
+
+@JsonClass(generateAdapter = true)
+data class MessageAudioContent(
+ /**
+ * Not documented
+ */
+ @Json(name = "msgtype") override val type: String,
+
+ /**
+ * Required. A description of the audio e.g. 'Bee Gees - Stayin' Alive', or some kind of content description for accessibility e.g. 'audio attachment'.
+ */
+ @Json(name = "body") override val body: String,
+
+ /**
+ * Metadata for the audio clip referred to in url.
+ */
+ @Json(name = "info") val audioInfo: AudioInfo? = null,
+
+ /**
+ * Required. Required if the file is not encrypted. The URL (typically MXC URI) to the audio clip.
+ */
+ @Json(name = "url") override val url: String? = null,
+
+ @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
+ @Json(name = "m.new_content") override val newContent: Content? = null,
+
+ /**
+ * Required if the file is encrypted. Information on the encrypted file, as specified in End-to-end encryption.
+ */
+ @Json(name = "file") override val encryptedFileInfo: EncryptedFileInfo? = null
+) : MessageEncryptedContent
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageContent.kt
new file mode 100644
index 00000000..c45e47fc
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageContent.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.room.model.relation.RelationDefaultContent
+
+
+interface MessageContent {
+ val type: String
+ val body: String
+ val relatesTo: RelationDefaultContent?
+ val newContent: Content?
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageDefaultContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageDefaultContent.kt
new file mode 100644
index 00000000..45ce9542
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageDefaultContent.kt
@@ -0,0 +1,30 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.room.model.relation.RelationDefaultContent
+
+@JsonClass(generateAdapter = true)
+data class MessageDefaultContent(
+ @Json(name = "msgtype") override val type: String,
+ @Json(name = "body") override val body: String,
+ @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
+ @Json(name = "m.new_content") override val newContent: Content? = null
+) : MessageContent
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageEmoteContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageEmoteContent.kt
new file mode 100644
index 00000000..88fd3bc1
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageEmoteContent.kt
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.room.model.relation.RelationDefaultContent
+
+@JsonClass(generateAdapter = true)
+data class MessageEmoteContent(
+ @Json(name = "msgtype") override val type: String,
+ @Json(name = "body") override val body: String,
+ @Json(name = "format") val format: String? = null,
+ @Json(name = "formatted_body") val formattedBody: String? = null,
+ @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
+ @Json(name = "m.new_content") override val newContent: Content? = null
+) : MessageContent
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageEncryptedContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageEncryptedContent.kt
new file mode 100644
index 00000000..125c18bb
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageEncryptedContent.kt
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import im.vector.matrix.android.internal.crypto.model.rest.EncryptedFileInfo
+
+
+/**
+ * Interface for message which can contains an encrypted file
+ */
+interface MessageEncryptedContent : MessageContent {
+ /**
+ * Required. Required if the file is unencrypted. The URL (typically MXC URI) to the image.
+ */
+ val url: String?
+
+ val encryptedFileInfo: EncryptedFileInfo?
+}
+
+/**
+ * Get the url of the encrypted file or of the file
+ */
+fun MessageEncryptedContent.getFileUrl() = encryptedFileInfo?.url ?: url
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageFileContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageFileContent.kt
new file mode 100644
index 00000000..ac70f5bf
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageFileContent.kt
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import android.content.ClipDescription
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.room.model.relation.RelationDefaultContent
+import im.vector.matrix.android.internal.crypto.model.rest.EncryptedFileInfo
+
+@JsonClass(generateAdapter = true)
+data class MessageFileContent(
+ /**
+ * Not documented
+ */
+ @Json(name = "msgtype") override val type: String,
+
+ /**
+ * Required. A human-readable description of the file. This is recommended to be the filename of the original upload.
+ */
+ @Json(name = "body") override val body: String,
+
+ /**
+ * The original filename of the uploaded file.
+ */
+ @Json(name = "filename") val filename: String? = null,
+
+ /**
+ * Information about the file referred to in url.
+ */
+ @Json(name = "info") val info: FileInfo? = null,
+
+ /**
+ * Required. Required if the file is unencrypted. The URL (typically MXC URI) to the file.
+ */
+ @Json(name = "url") override val url: String? = null,
+
+ @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
+ @Json(name = "m.new_content") override val newContent: Content? = null,
+
+ @Json(name = "file") override val encryptedFileInfo: EncryptedFileInfo? = null
+) : MessageEncryptedContent {
+
+ fun getMimeType(): String {
+ // Mimetype default to plain text, should not be used
+ return encryptedFileInfo?.mimetype
+ ?: info?.mimeType
+ ?: ClipDescription.MIMETYPE_TEXT_PLAIN
+ }
+
+ fun getFileName(): String {
+ return filename ?: body
+ }
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageImageContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageImageContent.kt
new file mode 100644
index 00000000..107a8b27
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageImageContent.kt
@@ -0,0 +1,55 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.room.model.relation.RelationDefaultContent
+import im.vector.matrix.android.internal.crypto.model.rest.EncryptedFileInfo
+
+@JsonClass(generateAdapter = true)
+data class MessageImageContent(
+ /**
+ * Required. Must be 'm.image'.
+ */
+ @Json(name = "msgtype") override val type: String,
+
+ /**
+ * Required. A textual representation of the image. This could be the alt text of the image, the filename of the image,
+ * or some kind of content description for accessibility e.g. 'image attachment'.
+ */
+ @Json(name = "body") override val body: String,
+
+ /**
+ * Metadata about the image referred to in url.
+ */
+ @Json(name = "info") val info: ImageInfo? = null,
+
+ /**
+ * Required. Required if the file is unencrypted. The URL (typically MXC URI) to the image.
+ */
+ @Json(name = "url") override val url: String? = null,
+
+ @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
+ @Json(name = "m.new_content") override val newContent: Content? = null,
+
+ /**
+ * Required if the file is encrypted. Information on the encrypted file, as specified in End-to-end encryption.
+ */
+ @Json(name = "file") override val encryptedFileInfo: EncryptedFileInfo? = null
+) : MessageEncryptedContent
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageLocationContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageLocationContent.kt
new file mode 100644
index 00000000..deddec12
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageLocationContent.kt
@@ -0,0 +1,48 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.room.model.relation.RelationDefaultContent
+
+@JsonClass(generateAdapter = true)
+data class MessageLocationContent(
+ /**
+ * Not documented
+ */
+ @Json(name = "msgtype") override val type: String,
+
+ /**
+ * Required. A description of the location e.g. 'Big Ben, London, UK', or some kind of content description for accessibility e.g. 'location attachment'.
+ */
+ @Json(name = "body") override val body: String,
+
+ /**
+ * Required. A geo URI representing this location.
+ */
+ @Json(name = "geo_uri") val geoUri: String,
+
+ /**
+ *
+ */
+ @Json(name = "info") val locationInfo: LocationInfo? = null,
+
+ @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
+ @Json(name = "m.new_content") override val newContent: Content? = null
+) : MessageContent
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageNoticeContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageNoticeContent.kt
new file mode 100644
index 00000000..54037c60
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageNoticeContent.kt
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.room.model.relation.RelationDefaultContent
+
+@JsonClass(generateAdapter = true)
+data class MessageNoticeContent(
+ @Json(name = "msgtype") override val type: String,
+ @Json(name = "body") override val body: String,
+ @Json(name = "format") val format: String? = null,
+ @Json(name = "formatted_body") val formattedBody: String? = null,
+ @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
+ @Json(name = "m.new_content") override val newContent: Content? = null
+) : MessageContent
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageTextContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageTextContent.kt
new file mode 100644
index 00000000..3256d830
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageTextContent.kt
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.room.model.relation.RelationDefaultContent
+
+@JsonClass(generateAdapter = true)
+data class MessageTextContent(
+ @Json(name = "msgtype") override val type: String,
+ @Json(name = "body") override val body: String,
+ @Json(name = "format") val format: String? = null,
+ @Json(name = "formatted_body") val formattedBody: String? = null,
+ @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
+ @Json(name = "m.new_content") override val newContent: Content? = null
+) : MessageContent
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageType.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageType.kt
new file mode 100644
index 00000000..7db33018
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageType.kt
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+object MessageType {
+
+ const val MSGTYPE_TEXT = "m.text"
+ const val MSGTYPE_EMOTE = "m.emote"
+ const val MSGTYPE_NOTICE = "m.notice"
+ const val MSGTYPE_IMAGE = "m.image"
+ const val MSGTYPE_AUDIO = "m.audio"
+ const val MSGTYPE_VIDEO = "m.video"
+ const val MSGTYPE_LOCATION = "m.location"
+ const val MSGTYPE_FILE = "m.file"
+ const val FORMAT_MATRIX_HTML = "org.matrix.custom.html"
+ // Add, in local, a fake message type in order to StickerMessage can inherit Message class
+ // Because sticker isn't a message type but a event type without msgtype field
+ const val MSGTYPE_STICKER_LOCAL = "org.matrix.android.sdk.sticker"
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageVideoContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageVideoContent.kt
new file mode 100644
index 00000000..1c84b3e7
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/MessageVideoContent.kt
@@ -0,0 +1,54 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.room.model.relation.RelationDefaultContent
+import im.vector.matrix.android.internal.crypto.model.rest.EncryptedFileInfo
+
+@JsonClass(generateAdapter = true)
+data class MessageVideoContent(
+ /**
+ * Required. Must be 'm.video'.
+ */
+ @Json(name = "msgtype") override val type: String,
+
+ /**
+ * Required. A description of the video e.g. 'Gangnam style', or some kind of content description for accessibility e.g. 'video attachment'.
+ */
+ @Json(name = "body") override val body: String,
+
+ /**
+ * Metadata about the video clip referred to in url.
+ */
+ @Json(name = "info") val videoInfo: VideoInfo? = null,
+
+ /**
+ * Required. Required if the file is unencrypted. The URL (typically MXC URI) to the video clip.
+ */
+ @Json(name = "url") override val url: String? = null,
+
+ @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
+ @Json(name = "m.new_content") override val newContent: Content? = null,
+
+ /**
+ * Required if the file is encrypted. Information on the encrypted file, as specified in End-to-end encryption.
+ */
+ @Json(name = "file") override val encryptedFileInfo: EncryptedFileInfo? = null
+) : MessageEncryptedContent
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/ThumbnailInfo.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/ThumbnailInfo.kt
new file mode 100644
index 00000000..1e308d79
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/ThumbnailInfo.kt
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class ThumbnailInfo(
+ /**
+ * The intended display width of the image in pixels. This may differ from the intrinsic dimensions of the image file.
+ */
+ @Json(name = "w") val width: Int = 0,
+
+ /**
+ * The intended display height of the image in pixels. This may differ from the intrinsic dimensions of the image file.
+ */
+ @Json(name = "h") val height: Int = 0,
+
+ /**
+ * Size of the image in bytes.
+ */
+ @Json(name = "size") val size: Long = 0,
+
+ /**
+ * The mimetype of the image, e.g. "image/jpeg".
+ */
+ @Json(name = "mimetype") val mimeType: String
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/VideoInfo.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/VideoInfo.kt
new file mode 100644
index 00000000..06220378
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/message/VideoInfo.kt
@@ -0,0 +1,64 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.internal.crypto.model.rest.EncryptedFileInfo
+
+@JsonClass(generateAdapter = true)
+data class VideoInfo(
+ /**
+ * The mimetype of the video e.g. "video/mp4".
+ */
+ @Json(name = "mimetype") val mimeType: String,
+
+ /**
+ * The width of the video in pixels.
+ */
+ @Json(name = "w") val width: Int = 0,
+
+ /**
+ * The height of the video in pixels.
+ */
+ @Json(name = "h") val height: Int = 0,
+
+ /**
+ * The size of the video in bytes.
+ */
+ @Json(name = "size") val size: Long = 0,
+
+ /**
+ * The duration of the video in milliseconds.
+ */
+ @Json(name = "duration") val duration: Int = 0,
+
+ /**
+ * Metadata about the image referred to in thumbnail_url.
+ */
+ @Json(name = "thumbnail_info") val thumbnailInfo: ThumbnailInfo? = null,
+
+ /**
+ * The URL (typically MXC URI) to an image thumbnail of the video clip. Only present if the thumbnail is unencrypted.
+ */
+ @Json(name = "thumbnail_url") val thumbnailUrl: String? = null,
+
+ /**
+ * Information on the encrypted thumbnail file, as specified in End-to-end encryption. Only present if the thumbnail is encrypted.
+ */
+ @Json(name = "thumbnail_file") val thumbnailFile: EncryptedFileInfo? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/ReactionContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/ReactionContent.kt
new file mode 100644
index 00000000..29144da9
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/ReactionContent.kt
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.relation
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class ReactionContent(
+ @Json(name = "m.relates_to") val relatesTo: ReactionInfo? = null
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/ReactionInfo.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/ReactionInfo.kt
new file mode 100644
index 00000000..72a30ec2
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/ReactionInfo.kt
@@ -0,0 +1,29 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.relation
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class ReactionInfo(
+ @Json(name = "rel_type") override val type: String?,
+ @Json(name = "event_id") override val eventId: String,
+ val key: String,
+ //always null for reaction
+ @Json(name = "m.in_reply_to") override val inReplyTo: ReplyToContent? = null
+) : RelationContent
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/RelationContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/RelationContent.kt
new file mode 100644
index 00000000..9bbdf5ab
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/RelationContent.kt
@@ -0,0 +1,23 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.relation
+
+interface RelationContent {
+ val type: String?
+ val eventId: String?
+ val inReplyTo: ReplyToContent?
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/RelationDefaultContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/RelationDefaultContent.kt
new file mode 100644
index 00000000..853a3817
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/RelationDefaultContent.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.relation
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class RelationDefaultContent(
+ @Json(name = "rel_type") override val type: String?,
+ @Json(name = "event_id") override val eventId: String?,
+ @Json(name = "m.in_reply_to") override val inReplyTo: ReplyToContent? = null
+) : RelationContent
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/RelationService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/RelationService.kt
new file mode 100644
index 00000000..81d7ddd4
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/RelationService.kt
@@ -0,0 +1,94 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.relation
+
+import androidx.lifecycle.LiveData
+import im.vector.matrix.android.api.session.room.model.EventAnnotationsSummary
+import im.vector.matrix.android.api.session.room.timeline.TimelineEvent
+import im.vector.matrix.android.api.util.Cancelable
+
+/**
+ * In some cases, events may wish to reference other events.
+ * This could be to form a thread of messages for the user to follow along with,
+ * or to provide more context as to what a particular event is describing.
+ * Relation are used to associate new information with an existing event.
+ *
+ * Relations are events which have an m.relates_to mixin in their contents,
+ * and the new information they convey is expressed in their usual event type and content.
+ *
+ * Three types of relations are defined, each defining different behaviour when aggregated:
+ *
+ * m.annotation - lets you define an event which annotates an existing event.
+ * When aggregated, groups events together based on key and returns a count.
+ * (aka SQL's COUNT) These are primarily intended for handling reactions.
+ *
+ * m.replace - lets you define an event which replaces an existing event.
+ * When aggregated, returns the most recent replacement event. (aka SQL's MAX)
+ * These are primarily intended for handling edits.
+ *
+ * m.reference - lets you define an event which references an existing event.
+ * When aggregated, currently doesn't do anything special, but in future could bundle chains of references (i.e. threads).
+ * These are primarily intended for handling replies (and in future threads).
+ */
+interface RelationService {
+
+
+ /**
+ * Sends a reaction (emoji) to the targetedEvent.
+ * @param reaction the reaction (preferably emoji)
+ * @param targetEventId the id of the event being reacted
+ */
+ fun sendReaction(reaction: String,
+ targetEventId: String): Cancelable
+
+
+ /**
+ * Undo a reaction (emoji) to the targetedEvent.
+ * @param reaction the reaction (preferably emoji)
+ * @param targetEventId the id of the event being reacted
+ * @param myUserId used to know if a reaction event was made by the user
+ */
+ fun undoReaction(reaction: String,
+ targetEventId: String,
+ myUserId: String)//: Cancelable
+
+
+ /**
+ * Edit a text message body. Limited to "m.text" contentType
+ * @param targetEventId The event to edit
+ * @param newBodyText The edited body
+ * @param compatibilityBodyText The text that will appear on clients that don't support yet edition
+ */
+ fun editTextMessage(targetEventId: String,
+ msgType: String,
+ newBodyText: String,
+ newBodyAutoMarkdown: Boolean,
+ compatibilityBodyText: String = "* $newBodyText"): Cancelable
+
+
+ /**
+ * Reply to an event in the timeline (must be in same room)
+ * https://matrix.org/docs/spec/client_server/r0.4.0.html#id350
+ * @param eventReplied the event referenced by the reply
+ * @param replyText the reply text
+ * @param autoMarkdown If true, the SDK will generate a formatted HTML message from the body text if markdown syntax is present
+ */
+ fun replyToMessage(eventReplied: TimelineEvent,
+ replyText: String,
+ autoMarkdown: Boolean = false): Cancelable?
+
+ fun getEventSummaryLive(eventId: String): LiveData
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/ReplyToContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/ReplyToContent.kt
new file mode 100644
index 00000000..3df8a534
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/relation/ReplyToContent.kt
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.relation
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class ReplyToContent(
+ @Json(name = "event_id") val eventId: String
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/roomdirectory/PublicRoom.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/roomdirectory/PublicRoom.kt
new file mode 100644
index 00000000..508cbb55
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/roomdirectory/PublicRoom.kt
@@ -0,0 +1,88 @@
+/*
+ * Copyright 2014 OpenMarket 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 im.vector.matrix.android.api.session.room.model.roomdirectory
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Class representing the objects returned by /publicRooms call.
+ */
+@JsonClass(generateAdapter = true)
+data class PublicRoom(
+
+ /**
+ * Aliases of the room. May be empty.
+ */
+ @Json(name = "aliases")
+ var aliases: List? = null,
+
+ /**
+ * The canonical alias of the room, if any.
+ */
+ @Json(name = "canonical_alias")
+ var canonicalAlias: String? = null,
+
+ /**
+ * The name of the room, if any.
+ */
+ @Json(name = "name")
+ var name: String? = null,
+
+ /**
+ * Required. The number of members joined to the room.
+ */
+ @Json(name = "num_joined_members")
+ var numJoinedMembers: Int = 0,
+
+ /**
+ * Required. The ID of the room.
+ */
+ @Json(name = "room_id")
+ var roomId: String,
+
+ /**
+ * The topic of the room, if any.
+ */
+ @Json(name = "topic")
+ var topic: String? = null,
+
+ /**
+ * Required. Whether the room may be viewed by guest users without joining.
+ */
+ @Json(name = "world_readable")
+ var worldReadable: Boolean = false,
+
+ /**
+ * Required. Whether guest users may join the room and participate in it. If they can,
+ * they will be subject to ordinary power level rules like any other user.
+ */
+ @Json(name = "guest_can_join")
+ var guestCanJoin: Boolean = false,
+
+ /**
+ * The URL for the room's avatar, if one is set.
+ */
+ @Json(name = "avatar_url")
+ var avatarUrl: String? = null,
+
+ /**
+ * Undocumented item
+ */
+ @Json(name = "m.federate")
+ var isFederated: Boolean = false
+
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/roomdirectory/PublicRoomsFilter.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/roomdirectory/PublicRoomsFilter.kt
new file mode 100644
index 00000000..b4de72e4
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/roomdirectory/PublicRoomsFilter.kt
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2014 OpenMarket 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 im.vector.matrix.android.api.session.room.model.roomdirectory
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Class to define a filter to retrieve public rooms
+ */
+@JsonClass(generateAdapter = true)
+data class PublicRoomsFilter(
+ /**
+ * A string to search for in the room metadata, e.g. name, topic, canonical alias etc. (Optional).
+ */
+ @Json(name = "generic_search_term")
+ var searchTerm: String? = null
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/roomdirectory/PublicRoomsParams.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/roomdirectory/PublicRoomsParams.kt
new file mode 100644
index 00000000..e2af1c3c
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/roomdirectory/PublicRoomsParams.kt
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2016 OpenMarket Ltd
+ * Copyright 2017 Vector Creations 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 im.vector.matrix.android.api.session.room.model.roomdirectory
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Class to pass parameters to get the public rooms list
+ */
+@JsonClass(generateAdapter = true)
+data class PublicRoomsParams(
+ /**
+ * Limit the number of results returned.
+ */
+ @Json(name = "limit")
+ var limit: Int? = null,
+
+ /**
+ * A pagination token from a previous request, allowing clients to get the next (or previous) batch of rooms.
+ * The direction of pagination is specified solely by which token is supplied, rather than via an explicit flag.
+ */
+ @Json(name = "since")
+ var since: String? = null,
+
+ /**
+ * Filter to apply to the results.
+ */
+ @Json(name = "filter")
+ var filter: PublicRoomsFilter? = null,
+
+ /**
+ * Whether or not to include all known networks/protocols from application services on the homeserver. Defaults to false.
+ */
+ @Json(name = "include_all_networks")
+ var includeAllNetworks: Boolean = false,
+
+ /**
+ * The specific third party network/protocol to request from the homeserver. Can only be used if include_all_networks is false.
+ */
+ @Json(name = "third_party_instance_id")
+ var thirdPartyInstanceId: String? = null
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/roomdirectory/PublicRoomsResponse.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/roomdirectory/PublicRoomsResponse.kt
new file mode 100644
index 00000000..3799d097
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/roomdirectory/PublicRoomsResponse.kt
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2014 OpenMarket 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 im.vector.matrix.android.api.session.room.model.roomdirectory
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Class representing the public rooms request response
+ */
+@JsonClass(generateAdapter = true)
+data class PublicRoomsResponse(
+ /**
+ * A pagination token for the response. The absence of this token means there are no more results to fetch and the client should stop paginating.
+ */
+ @Json(name = "next_batch")
+ var nextBatch: String? = null,
+
+ /**
+ * A pagination token that allows fetching previous results. The absence of this token means there are no results before this batch,
+ * i.e. this is the first batch.
+ */
+ @Json(name = "prev_batch")
+ var prevBatch: String? = null,
+
+ /**
+ * A paginated chunk of public rooms.
+ */
+ @Json(name = "chunk")
+ var chunk: List? = null,
+
+ /**
+ * An estimate on the total number of public rooms, if the server has an estimate.
+ */
+ @Json(name = "total_room_count_estimate")
+ var totalRoomCountEstimate: Int? = null
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/tag/RoomTag.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/tag/RoomTag.kt
new file mode 100644
index 00000000..0623e8d9
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/tag/RoomTag.kt
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.tag
+
+data class RoomTag(
+ val name: String,
+ val order: Double?
+) {
+
+ companion object {
+ val ROOM_TAG_FAVOURITE = "m.favourite"
+ val ROOM_TAG_LOW_PRIORITY = "m.lowpriority"
+ val ROOM_TAG_NO_TAG = "m.recent"
+ val ROOM_TAG_SERVER_NOTICE = "m.server_notice"
+ }
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/tag/RoomTagContent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/tag/RoomTagContent.kt
new file mode 100644
index 00000000..388f494d
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/tag/RoomTagContent.kt
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.tag
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class RoomTagContent(
+ @Json(name = "tags") val tags: Map> = emptyMap()
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/thirdparty/FieldType.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/thirdparty/FieldType.kt
new file mode 100644
index 00000000..2e9f6956
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/thirdparty/FieldType.kt
@@ -0,0 +1,36 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.thirdparty
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class FieldType(
+ /**
+ * Required. A regular expression for validation of a field's value. This may be relatively coarse to verify the value as the application
+ * service providing this protocol may apply additional
+ */
+ @Json(name = "regexp")
+ val regexp: String? = null,
+
+ /**
+ * Required. An placeholder serving as a valid example of the field value.
+ */
+ @Json(name = "placeholder")
+ val placeholder: String? = null
+)
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/thirdparty/RoomDirectoryData.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/thirdparty/RoomDirectoryData.kt
new file mode 100644
index 00000000..11a347c0
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/thirdparty/RoomDirectoryData.kt
@@ -0,0 +1,55 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.thirdparty
+
+/**
+ * This class describes a rooms directory server.
+ */
+data class RoomDirectoryData(
+
+ /**
+ * The server name (might be null)
+ * Set null when the server is the current user's home server.
+ */
+ val homeServer: String? = null,
+
+ /**
+ * The display name (the server description)
+ */
+ val displayName: String = DEFAULT_HOME_SERVER_NAME,
+
+ /**
+ * The third party server identifier
+ */
+ val thirdPartyInstanceId: String? = null,
+
+ /**
+ * Tell if all the federated servers must be included
+ */
+ val includeAllNetworks: Boolean = false,
+
+ /**
+ * the avatar url
+ */
+ val avatarUrl: String? = null
+) {
+
+ companion object {
+ const val DEFAULT_HOME_SERVER_NAME = "Matrix"
+ }
+
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/thirdparty/ThirdPartyProtocol.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/thirdparty/ThirdPartyProtocol.kt
new file mode 100644
index 00000000..a31df794
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/thirdparty/ThirdPartyProtocol.kt
@@ -0,0 +1,62 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.thirdparty
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class ThirdPartyProtocol(
+ /**
+ * Required. Fields which may be used to identify a third party user. These should be ordered to suggest the way that entities may be grouped,
+ * where higher groupings are ordered first. For example, the name of a network should be searched before the nickname of a user.
+ */
+ @Json(name = "user_fields")
+ var userFields: List? = null,
+
+ /**
+ * Required. Fields which may be used to identify a third party location. These should be ordered to suggest the way that
+ * entities may be grouped, where higher groupings are ordered first. For example, the name of a network should be
+ * searched before the name of a channel.
+ */
+ @Json(name = "location_fields")
+ var locationFields: List? = null,
+
+ /**
+ * Required. A content URI representing an icon for the third party protocol.
+ *
+ * FIXDOC: This field was not present in legacy Riot, and it is sometimes sent by the server (no not Required?)
+ */
+ @Json(name = "icon")
+ var icon: String? = null,
+
+ /**
+ * Required. The type definitions for the fields defined in the user_fields and location_fields. Each entry in those arrays MUST have an entry here.
+ * The string key for this object is field name itself.
+ *
+ * May be an empty object if no fields are defined.
+ */
+ @Json(name = "field_types")
+ var fieldTypes: Map? = null,
+
+ /**
+ * Required. A list of objects representing independent instances of configuration. For example, multiple networks on IRC
+ * if multiple are provided by the same application service.
+ */
+ @Json(name = "instances")
+ var instances: List? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/thirdparty/ThirdPartyProtocolInstance.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/thirdparty/ThirdPartyProtocolInstance.kt
new file mode 100644
index 00000000..d2bea700
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/thirdparty/ThirdPartyProtocolInstance.kt
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.model.thirdparty
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class ThirdPartyProtocolInstance(
+ /**
+ * Required. A human-readable description for the protocol, such as the name.
+ */
+ @Json(name = "desc")
+ var desc: String? = null,
+
+ /**
+ * An optional content URI representing the protocol. Overrides the one provided at the higher level Protocol object.
+ */
+ @Json(name = "icon")
+ var icon: String? = null,
+
+ /**
+ * Required. Preset values for fields the client may use to search by.
+ */
+ @Json(name = "fields")
+ var fields: Map? = null,
+
+ /**
+ * Required. A unique identifier across all instances.
+ */
+ @Json(name = "network_id")
+ var networkId: String? = null,
+
+ /**
+ * FIXDOC Not documented on matrix.org doc
+ */
+ @Json(name = "instance_id")
+ var instanceId: String? = null,
+
+
+ /**
+ * FIXDOC Not documented on matrix.org doc
+ */
+ @Json(name = "bot_user_id")
+ var botUserId: String? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/read/ReadService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/read/ReadService.kt
new file mode 100644
index 00000000..ab406b8e
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/read/ReadService.kt
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.read
+
+import im.vector.matrix.android.api.MatrixCallback
+
+/**
+ * This interface defines methods to handle read receipts and read marker in a room. It's implemented at the room level.
+ */
+interface ReadService {
+
+ /**
+ * Force the read marker to be set on the latest event.
+ */
+ fun markAllAsRead(callback: MatrixCallback)
+
+ /**
+ * Set the read receipt on the event with provided eventId.
+ */
+ fun setReadReceipt(eventId: String, callback: MatrixCallback)
+
+ /**
+ * Set the read marker on the event with provided eventId.
+ */
+ fun setReadMarker(fullyReadEventId: String, callback: MatrixCallback)
+
+ fun isEventRead(eventId: String): Boolean
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/send/SendService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/send/SendService.kt
new file mode 100644
index 00000000..94abd5d3
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/send/SendService.kt
@@ -0,0 +1,68 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.send
+
+import im.vector.matrix.android.api.session.content.ContentAttachmentData
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.api.session.room.model.message.MessageType
+import im.vector.matrix.android.api.util.Cancelable
+
+
+/**
+ * This interface defines methods to send events in a room. It's implemented at the room level.
+ */
+interface SendService {
+
+ /**
+ * Method to send a text message asynchronously.
+ * @param text the text message to send
+ * @param msgType the message type: MessageType.MSGTYPE_TEXT (default) or MessageType.MSGTYPE_EMOTE
+ * @param autoMarkdown If true, the SDK will generate a formatted HTML message from the body text if markdown syntax is present
+ * @return a [Cancelable]
+ */
+ fun sendTextMessage(text: String, msgType: String = MessageType.MSGTYPE_TEXT, autoMarkdown: Boolean = false): Cancelable
+
+ /**
+ * Method to send a text message with a formatted body.
+ * @param text the text message to send
+ * @param formattedText The formatted body using MessageType#FORMAT_MATRIX_HTML
+ * @return a [Cancelable]
+ */
+ fun sendFormattedTextMessage(text: String, formattedText: String): Cancelable
+
+ /**
+ * Method to send a media asynchronously.
+ * @param attachment the media to send
+ * @return a [Cancelable]
+ */
+ fun sendMedia(attachment: ContentAttachmentData): Cancelable
+
+ /**
+ * Method to send a list of media asynchronously.
+ * @param attachments the list of media to send
+ * @return a [Cancelable]
+ */
+ fun sendMedias(attachments: List): Cancelable
+
+ /**
+ * Redacts (delete) the given event.
+ * @param event The event to redact
+ * @param reason Optional reason string
+ */
+ fun redactEvent(event: Event, reason: String?): Cancelable
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/send/SendState.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/send/SendState.kt
new file mode 100644
index 00000000..75e3c0f6
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/send/SendState.kt
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.send
+
+enum class SendState {
+ UNKNOWN,
+ // the event has not been sent
+ UNSENT,
+ // the event is encrypting
+ ENCRYPTING,
+ // the event is currently sending
+ SENDING,
+ // the event has been sent
+ SENT,
+ // the event has been received from server
+ SYNCED,
+ // The event failed to be sent
+ UNDELIVERED,
+ // the event failed to be sent because some unknown devices have been found while encrypting it
+ FAILED_UNKNOWN_DEVICES;
+
+ fun isSent(): Boolean {
+ return this == SENT || this == SYNCED
+ }
+
+ fun hasFailed(): Boolean {
+ return this == UNDELIVERED || this == FAILED_UNKNOWN_DEVICES
+ }
+
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/state/StateService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/state/StateService.kt
new file mode 100644
index 00000000..79443d0b
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/state/StateService.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.state
+
+import im.vector.matrix.android.api.MatrixCallback
+
+interface StateService {
+
+ /**
+ * Update the topic of the room
+ */
+ fun updateTopic(topic: String, callback: MatrixCallback)
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/timeline/Timeline.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/timeline/Timeline.kt
new file mode 100644
index 00000000..e52ac3b4
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/timeline/Timeline.kt
@@ -0,0 +1,82 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.timeline
+
+/**
+ * A Timeline instance represents a contiguous sequence of events in a room.
+ *
+ * There are two kinds of timeline:
+ *
+ * - live timelines: they process live events from the sync. You can paginate
+ * backwards but not forwards.
+ *
+ * - past timelines: they start in the past from an `initialEventId`. You can paginate
+ * backwards and forwards.
+ *
+ */
+interface Timeline {
+
+ var listener: Listener?
+
+ /**
+ * This should be called before any other method after creating the timeline. It ensures the underlying database is open
+ */
+ fun start()
+
+ /**
+ * This should be called when you don't need the timeline. It ensures the underlying database get closed.
+ */
+ fun dispose()
+
+ /**
+ * Check if the timeline can be enriched by paginating.
+ * @param the direction to check in
+ * @return true if timeline can be enriched
+ */
+ fun hasMoreToLoad(direction: Direction): Boolean
+
+ /**
+ * This is the main method to enrich the timeline with new data.
+ * It will call the onUpdated method from [Listener] when the data will be processed.
+ * It also ensures only one pagination by direction is launched at a time, so you can safely call this multiple time in a row.
+ */
+ fun paginate(direction: Direction, count: Int)
+
+
+ interface Listener {
+ /**
+ * Call when the timeline has been updated through pagination or sync.
+ * @param snapshot the most uptodate snapshot
+ */
+ fun onUpdated(snapshot: List)
+ }
+
+ /**
+ * This is used to paginate in one or another direction.
+ */
+ enum class Direction {
+ /**
+ * It represents future events.
+ */
+ FORWARDS,
+ /**
+ * It represents past events.
+ */
+ BACKWARDS
+ }
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/timeline/TimelineEvent.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/timeline/TimelineEvent.kt
new file mode 100644
index 00000000..f626e3a7
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/timeline/TimelineEvent.kt
@@ -0,0 +1,90 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.timeline
+
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.api.session.events.model.EventType
+import im.vector.matrix.android.api.session.events.model.toModel
+import im.vector.matrix.android.api.session.room.model.EventAnnotationsSummary
+import im.vector.matrix.android.api.session.room.model.message.MessageContent
+import im.vector.matrix.android.api.session.room.send.SendState
+
+/**
+ * This data class is a wrapper around an Event. It allows to get useful data in the context of a timeline.
+ * This class is used by [TimelineService]
+ * Users can also enrich it with metadata.
+ */
+data class TimelineEvent(
+ val root: Event,
+ val localId: Long,
+ val displayIndex: Int,
+ val senderName: String?,
+ val isUniqueDisplayName: Boolean,
+ val senderAvatar: String?,
+ val sendState: SendState,
+ val annotations: EventAnnotationsSummary? = null
+) {
+
+ val metadata = HashMap()
+
+ /**
+ * The method to enrich this timeline event.
+ * If you provides multiple data with the same key, only first one will be kept.
+ * @param key the key to associate data with.
+ * @param data the data to enrich with.
+ */
+ fun enrichWith(key: String?, data: Any?) {
+ if (key == null || data == null) {
+ return
+ }
+ if (!metadata.containsKey(key)) {
+ metadata[key] = data
+ }
+ }
+
+ fun getDisambiguatedDisplayName(): String {
+ return if (isUniqueDisplayName) {
+ senderName
+ } else {
+ senderName?.let { name ->
+ "$name (${root.senderId})"
+ }
+ }
+ ?: root.senderId
+ ?: ""
+ }
+
+ /**
+ * Get the metadata associated with a key.
+ * @param key the key to get the metadata
+ * @return the metadata
+ */
+ inline fun getMetadata(key: String): T? {
+ return metadata[key] as T?
+ }
+
+ fun isEncrypted(): Boolean {
+ // warning: Do not use getClearType here
+ return EventType.ENCRYPTED == root.type
+ }
+}
+
+/**
+ * Get last MessageContent, after a possible edition
+ */
+fun TimelineEvent.getLastMessageContent(): MessageContent? = annotations?.editSummary?.aggregatedContent?.toModel()
+ ?: root.getClearContent().toModel()
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/timeline/TimelineService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/timeline/TimelineService.kt
new file mode 100644
index 00000000..5a4838ad
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/timeline/TimelineService.kt
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.room.timeline
+
+import androidx.lifecycle.LiveData
+
+/**
+ * This interface defines methods to interact with the timeline. It's implemented at the room level.
+ */
+interface TimelineService {
+
+ /**
+ * Instantiate a [Timeline] with an optional initial eventId, to be used with permalink.
+ * You can filter the type you want to grab with the allowedTypes param.
+ * @param eventId the optional initial eventId.
+ * @param allowedTypes the optional filter types
+ * @return the instantiated timeline
+ */
+ fun createTimeline(eventId: String?, allowedTypes: List? = null): Timeline
+
+
+ fun getTimeLineEvent(eventId: String): TimelineEvent?
+
+
+ fun liveTimeLineEvent(eventId: String): LiveData
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/signout/SignOutService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/signout/SignOutService.kt
new file mode 100644
index 00000000..11f7cd57
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/signout/SignOutService.kt
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.signout
+
+import im.vector.matrix.android.api.MatrixCallback
+
+/**
+ * This interface defines a method to sign out. It's implemented at the session level.
+ */
+interface SignOutService {
+
+ /**
+ * Sign out
+ */
+ fun signOut(callback: MatrixCallback)
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/sync/FilterService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/sync/FilterService.kt
new file mode 100644
index 00000000..4a29013d
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/sync/FilterService.kt
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.sync
+
+interface FilterService {
+
+ enum class FilterPreset {
+ NoFilter,
+ /**
+ * Filter for Riot, will include only known event type
+ */
+ RiotFilter
+ }
+
+ /**
+ * Configure the filter for the sync
+ */
+ fun setFilter(filterPreset: FilterPreset)
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/sync/SyncState.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/sync/SyncState.kt
new file mode 100644
index 00000000..a2af70f4
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/sync/SyncState.kt
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.sync
+
+sealed class SyncState {
+ object IDLE : SyncState()
+ data class RUNNING(val catchingUp: Boolean) : SyncState()
+ object PAUSED : SyncState()
+ object KILLING : SyncState()
+ object KILLED : SyncState()
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/user/UserService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/user/UserService.kt
new file mode 100644
index 00000000..eb09fbd2
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/user/UserService.kt
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.user
+
+import androidx.lifecycle.LiveData
+import im.vector.matrix.android.api.session.user.model.User
+
+/**
+ * This interface defines methods to get users. It's implemented at the session level.
+ */
+interface UserService {
+
+ /**
+ * Get a user from a userId
+ * @param userId the userId to look for.
+ * @return a user with userId or null
+ */
+ fun getUser(userId: String): User?
+
+ /**
+ * Observe a live user from a userId
+ * @param userId the userId to look for.
+ * @return a Livedata of user with userId
+ */
+ fun observeUser(userId: String): LiveData
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/user/model/User.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/user/model/User.kt
new file mode 100644
index 00000000..50e76053
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/user/model/User.kt
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.session.user.model
+
+/**
+ * Data class which holds information about a user.
+ * It can be retrieved with [im.vector.matrix.android.api.session.user.UserService]
+ */
+data class User(
+ val userId: String,
+ val displayName: String? = null,
+ val avatarUrl: String? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/Cancelable.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/Cancelable.kt
new file mode 100644
index 00000000..d2573de4
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/Cancelable.kt
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.util
+
+/**
+ * An interface defining a unique cancel method.
+ * It should be used with methods you want to be able to cancel, such as ones interacting with Web Services.
+ */
+interface Cancelable {
+
+ /**
+ * The cancel method, it does nothing by default.
+ */
+ fun cancel() {
+ //no-op
+ }
+}
+
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/CancelableBag.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/CancelableBag.kt
new file mode 100644
index 00000000..f5689b4d
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/CancelableBag.kt
@@ -0,0 +1,23 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.util
+
+class CancelableBag : Cancelable, MutableList by ArrayList() {
+ override fun cancel() {
+ forEach { it.cancel() }
+ }
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/MatrixCallbackDelegate.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/MatrixCallbackDelegate.kt
new file mode 100644
index 00000000..2b4e30a1
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/MatrixCallbackDelegate.kt
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.util
+
+import im.vector.matrix.android.api.MatrixCallback
+
+/**
+ * Simple MatrixCallback implementation which delegate its calls to another callback
+ */
+open class MatrixCallbackDelegate(private val callback: MatrixCallback) : MatrixCallback by callback
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/SecretStoringUtils.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/SecretStoringUtils.kt
new file mode 100644
index 00000000..6dc0d789
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/SecretStoringUtils.kt
@@ -0,0 +1,592 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.util
+
+import android.content.Context
+import android.os.Build
+import android.security.KeyPairGeneratorSpec
+import android.security.keystore.KeyGenParameterSpec
+import android.security.keystore.KeyProperties
+import androidx.annotation.RequiresApi
+import java.io.*
+import java.math.BigInteger
+import java.security.KeyPairGenerator
+import java.security.KeyStore
+import java.security.SecureRandom
+import java.util.*
+import javax.crypto.*
+import javax.crypto.spec.GCMParameterSpec
+import javax.crypto.spec.IvParameterSpec
+import javax.crypto.spec.PBEKeySpec
+import javax.crypto.spec.SecretKeySpec
+import javax.security.auth.x500.X500Principal
+
+
+/**
+ * Offers simple methods to securely store secrets in an Android Application.
+ * The encryption keys are randomly generated and securely managed by the key store, thus your secrets
+ * are safe. You only need to remember a key alias to perform encrypt/decrypt operations.
+ *
+ * Android M++
+ * On android M+, the keystore can generates and store AES keys via API. But below API M this functionality
+ * is not available.
+ *
+ * Android [K-M[
+ * For android >=KITKAT and Older androids
+ * For older androids as a fallback we generate an AES key from the alias using PBKDF2 with random salt.
+ * The salt and iv are stored with encrypted data.
+ *
+ * Sample usage:
+ *
+ * val secret = "The answer is 42"
+ * val KEncrypted = SecretStoringUtils.securelyStoreString(secret, "myAlias", context)
+ * //This can be stored anywhere e.g. encoded in b64 and stored in preference for example
+ *
+ * //to get back the secret, just call
+ * val kDecripted = SecretStoringUtils.loadSecureSecret(KEncrypted!!, "myAlias", context)
+ *
+ *
+ * You can also just use this utility to store a secret key, and use any encryption algorthim that you want.
+ *
+ * Important: Keys stored in the keystore can be wiped out (depends of the OS version, like for example if you
+ * add a pin or change the schema); So you might and with a useless pile of bytes.
+ */
+object SecretStoringUtils {
+
+ private const val ANDROID_KEY_STORE = "AndroidKeyStore"
+ private const val AES_MODE = "AES/GCM/NoPadding";
+ private const val RSA_MODE = "RSA/ECB/PKCS1Padding"
+
+ const val FORMAT_API_M: Byte = 0
+ const val FORMAT_1: Byte = 1
+ const val FORMAT_2: Byte = 2
+
+ val keyStore: KeyStore by lazy {
+ KeyStore.getInstance(ANDROID_KEY_STORE).apply {
+ load(null)
+ }
+ }
+
+ private val secureRandom = SecureRandom()
+
+ /**
+ * Encrypt the given secret using the android Keystore.
+ * On android >= M, will directly use the keystore to generate a symetric key
+ * On KitKat >= KitKat and = Build.VERSION_CODES.M) {
+ return encryptStringM(secret, keyAlias)
+ } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
+ return encryptStringJ(secret, keyAlias, context)
+ } else {
+ return encryptForOldDevicesNotGood(secret, keyAlias)
+ }
+ }
+
+ /**
+ * Decrypt a secret that was encrypted by #securelyStoreString()
+ */
+ @Throws(Exception::class)
+ fun loadSecureSecret(encrypted: ByteArray, keyAlias: String, context: Context): String? {
+ if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+ return decryptStringM(encrypted, keyAlias)
+ } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
+ return decryptStringJ(encrypted, keyAlias, context)
+ } else {
+ return decryptForOldDevicesNotGood(encrypted, keyAlias)
+ }
+ }
+
+ fun securelyStoreObject(any: Any, keyAlias: String, output: OutputStream, context: Context) {
+ if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+ saveSecureObjectM(keyAlias, output, any)
+ } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
+ return saveSecureObjectK(keyAlias, output, any, context)
+ } else {
+ return saveSecureObjectOldNotGood(keyAlias, output, any)
+ }
+ }
+
+ fun loadSecureSecret(inputStream: InputStream, keyAlias: String, context: Context): T? {
+ if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+ return loadSecureObjectM(keyAlias, inputStream)
+ } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
+ return loadSecureObjectK(keyAlias, inputStream, context)
+ } else {
+ return loadSecureObjectOldNotGood(keyAlias, inputStream)
+ }
+ }
+
+
+ @RequiresApi(Build.VERSION_CODES.M)
+ fun getOrGenerateSymmetricKeyForAlias(alias: String): SecretKey {
+ val secretKeyEntry = (keyStore.getEntry(alias, null) as? KeyStore.SecretKeyEntry)
+ ?.secretKey
+ if (secretKeyEntry == null) {
+ //we generate it
+ val generator = KeyGenerator.getInstance(KeyProperties.KEY_ALGORITHM_AES, "AndroidKeyStore")
+ val keyGenSpec = KeyGenParameterSpec.Builder(alias,
+ KeyProperties.PURPOSE_ENCRYPT or KeyProperties.PURPOSE_DECRYPT)
+ .setBlockModes(KeyProperties.BLOCK_MODE_GCM)
+ .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE)
+ .setKeySize(128)
+ .build()
+ generator.init(keyGenSpec)
+ return generator.generateKey()
+ }
+ return secretKeyEntry
+ }
+
+
+ /*
+ Symetric Key Generation is only available in M, so before M the idea is to:
+ - Generate a pair of RSA keys;
+ - Generate a random AES key;
+ - Encrypt the AES key using the RSA public key;
+ - Store the encrypted AES
+ Generate a key pair for encryption
+ */
+ @RequiresApi(Build.VERSION_CODES.JELLY_BEAN_MR2)
+ fun getOrGenerateKeyPairForAlias(alias: String, context: Context): KeyStore.PrivateKeyEntry {
+ val privateKeyEntry = (keyStore.getEntry(alias, null) as? KeyStore.PrivateKeyEntry)
+
+ if (privateKeyEntry != null) return privateKeyEntry
+
+ val start = Calendar.getInstance()
+ val end = Calendar.getInstance()
+ end.add(Calendar.YEAR, 30)
+
+ val spec = KeyPairGeneratorSpec.Builder(context)
+ .setAlias(alias)
+ .setSubject(X500Principal("CN=$alias"))
+ .setSerialNumber(BigInteger.TEN)
+ //.setEncryptionRequired() requires that the phone as a pin/schema
+ .setStartDate(start.time)
+ .setEndDate(end.time)
+ .build()
+ KeyPairGenerator.getInstance(KeyProperties.KEY_ALGORITHM_RSA, ANDROID_KEY_STORE).run {
+ initialize(spec)
+ generateKeyPair()
+ }
+ return (keyStore.getEntry(alias, null) as KeyStore.PrivateKeyEntry)
+
+ }
+
+
+ @RequiresApi(Build.VERSION_CODES.M)
+ fun encryptStringM(text: String, keyAlias: String): ByteArray? {
+ val secretKey = getOrGenerateSymmetricKeyForAlias(keyAlias)
+
+ val cipher = Cipher.getInstance(AES_MODE)
+ cipher.init(Cipher.ENCRYPT_MODE, secretKey)
+ val iv = cipher.iv
+ //we happen the iv to the final result
+ val encryptedBytes: ByteArray = cipher.doFinal(text.toByteArray(Charsets.UTF_8))
+ return formatMMake(iv, encryptedBytes)
+ }
+
+ @RequiresApi(Build.VERSION_CODES.M)
+ fun decryptStringM(encryptedChunk: ByteArray, keyAlias: String): String {
+ val (iv, encryptedText) = formatMExtract(ByteArrayInputStream(encryptedChunk))
+
+ val secretKey = getOrGenerateSymmetricKeyForAlias(keyAlias)
+
+ val cipher = Cipher.getInstance(AES_MODE)
+ val spec = GCMParameterSpec(128, iv)
+ cipher.init(Cipher.DECRYPT_MODE, secretKey, spec)
+
+ return String(cipher.doFinal(encryptedText), Charsets.UTF_8)
+ }
+
+ @RequiresApi(Build.VERSION_CODES.JELLY_BEAN_MR2)
+ fun encryptStringJ(text: String, keyAlias: String, context: Context): ByteArray? {
+ //we generate a random symetric key
+ val key = ByteArray(16)
+ secureRandom.nextBytes(key)
+ val sKey = SecretKeySpec(key, "AES")
+
+ //we encrypt this key thanks to the key store
+ val encryptedKey = rsaEncrypt(keyAlias, key, context)
+
+ val cipher = Cipher.getInstance(AES_MODE)
+ cipher.init(Cipher.ENCRYPT_MODE, sKey)
+ val iv = cipher.iv
+ val encryptedBytes: ByteArray = cipher.doFinal(text.toByteArray(Charsets.UTF_8))
+
+ return format1Make(encryptedKey, iv, encryptedBytes)
+ }
+
+ fun encryptForOldDevicesNotGood(text: String, keyAlias: String): ByteArray {
+ val salt = ByteArray(8)
+ secureRandom.nextBytes(salt)
+ val factory = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA256")
+ val spec = PBEKeySpec(keyAlias.toCharArray(), salt, 10000, 128)
+ val tmp = factory.generateSecret(spec)
+ val sKey = SecretKeySpec(tmp.encoded, "AES")
+
+ val cipher = Cipher.getInstance(AES_MODE)
+ cipher.init(Cipher.ENCRYPT_MODE, sKey)
+ val iv = cipher.iv
+ val encryptedBytes: ByteArray = cipher.doFinal(text.toByteArray(Charsets.UTF_8))
+
+ return format2Make(salt, iv, encryptedBytes)
+ }
+
+ fun decryptForOldDevicesNotGood(data: ByteArray, keyAlias: String): String? {
+
+ val (salt, iv, encrypted) = format2Extract(ByteArrayInputStream(data))
+ val factory = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA256")
+ val spec = PBEKeySpec(keyAlias.toCharArray(), salt, 10000, 128)
+ val tmp = factory.generateSecret(spec)
+ val sKey = SecretKeySpec(tmp.encoded, "AES")
+
+ val cipher = Cipher.getInstance(AES_MODE)
+// cipher.init(Cipher.ENCRYPT_MODE, sKey)
+// val encryptedBytes: ByteArray = cipher.doFinal(text.toByteArray(Charsets.UTF_8))
+
+ val specIV = if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) IvParameterSpec(iv) else GCMParameterSpec(128, iv)
+ cipher.init(Cipher.DECRYPT_MODE, sKey, specIV)
+
+ return String(cipher.doFinal(encrypted), Charsets.UTF_8)
+ }
+
+ @RequiresApi(Build.VERSION_CODES.KITKAT)
+ fun decryptStringJ(data: ByteArray, keyAlias: String, context: Context): String? {
+
+ val (encryptedKey, iv, encrypted) = format1Extract(ByteArrayInputStream(data))
+
+ //we need to decrypt the key
+ val sKeyBytes = rsaDecrypt(keyAlias, ByteArrayInputStream(encryptedKey), context)
+ val cipher = Cipher.getInstance(AES_MODE)
+ val spec = if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) IvParameterSpec(iv) else GCMParameterSpec(128, iv)
+ cipher.init(Cipher.DECRYPT_MODE, SecretKeySpec(sKeyBytes, "AES"), spec)
+
+ return String(cipher.doFinal(encrypted), Charsets.UTF_8)
+
+ }
+
+
+ @RequiresApi(Build.VERSION_CODES.M)
+ @Throws(IOException::class)
+ fun saveSecureObjectM(keyAlias: String, output: OutputStream, writeObject: Any) {
+ val secretKey = getOrGenerateSymmetricKeyForAlias(keyAlias)
+
+ val cipher = Cipher.getInstance(AES_MODE)
+ cipher.init(Cipher.ENCRYPT_MODE, secretKey/*, spec*/)
+ val iv = cipher.iv
+
+ val bos1 = ByteArrayOutputStream()
+ ObjectOutputStream(bos1).use {
+ it.writeObject(writeObject)
+ }
+ //Have to do it like that if i encapsulate the outputstream, the cipher could fail saying reuse IV
+ val doFinal = cipher.doFinal(bos1.toByteArray())
+ output.write(FORMAT_API_M.toInt())
+ output.write(iv.size)
+ output.write(iv)
+ output.write(doFinal)
+ }
+
+ @RequiresApi(Build.VERSION_CODES.KITKAT)
+ fun saveSecureObjectK(keyAlias: String, output: OutputStream, writeObject: Any, context: Context) {
+ //we generate a random symetric key
+ val key = ByteArray(16)
+ secureRandom.nextBytes(key)
+ val sKey = SecretKeySpec(key, "AES")
+
+ //we encrypt this key thanks to the key store
+ val encryptedKey = rsaEncrypt(keyAlias, key, context)
+
+ val cipher = Cipher.getInstance(AES_MODE)
+ cipher.init(Cipher.ENCRYPT_MODE, sKey)
+ val iv = cipher.iv
+
+ val bos1 = ByteArrayOutputStream()
+ val cos = CipherOutputStream(bos1, cipher)
+ ObjectOutputStream(cos).use {
+ it.writeObject(writeObject)
+ }
+
+ output.write(FORMAT_1.toInt())
+ output.write((encryptedKey.size and 0xFF00).shr(8))
+ output.write(encryptedKey.size and 0x00FF)
+ output.write(encryptedKey)
+ output.write(iv.size)
+ output.write(iv)
+ output.write(bos1.toByteArray())
+ }
+
+ fun saveSecureObjectOldNotGood(keyAlias: String, output: OutputStream, writeObject: Any) {
+ val salt = ByteArray(8)
+ secureRandom.nextBytes(salt)
+ val factory = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA256")
+ val tmp = factory.generateSecret(PBEKeySpec(keyAlias.toCharArray(), salt, 10000, 128))
+ val secretKey = SecretKeySpec(tmp.encoded, "AES")
+
+
+ val cipher = Cipher.getInstance(AES_MODE)
+ cipher.init(Cipher.ENCRYPT_MODE, secretKey)
+ val iv = cipher.iv
+
+ val bos1 = ByteArrayOutputStream()
+ ObjectOutputStream(bos1).use {
+ it.writeObject(writeObject)
+ }
+ //Have to do it like that if i encapsulate the outputstream, the cipher could fail saying reuse IV
+ val doFinal = cipher.doFinal(bos1.toByteArray())
+
+ output.write(FORMAT_2.toInt())
+ output.write(salt.size)
+ output.write(salt)
+ output.write(iv.size)
+ output.write(iv)
+ output.write(doFinal)
+ }
+
+// @RequiresApi(Build.VERSION_CODES.M)
+// @Throws(IOException::class)
+// fun saveSecureObjectM(keyAlias: String, file: File, writeObject: Any) {
+// FileOutputStream(file).use {
+// saveSecureObjectM(keyAlias, it, writeObject)
+// }
+// }
+//
+// @RequiresApi(Build.VERSION_CODES.M)
+// @Throws(IOException::class)
+// fun loadSecureObjectM(keyAlias: String, file: File): T? {
+// FileInputStream(file).use {
+// return loadSecureObjectM(keyAlias, it)
+// }
+// }
+
+ @RequiresApi(Build.VERSION_CODES.M)
+ @Throws(IOException::class)
+ fun loadSecureObjectM(keyAlias: String, inputStream: InputStream): T? {
+ val secretKey = getOrGenerateSymmetricKeyForAlias(keyAlias)
+
+ val format = inputStream.read()
+ assert(format.toByte() == FORMAT_API_M)
+
+ val ivSize = inputStream.read()
+ val iv = ByteArray(ivSize)
+ inputStream.read(iv, 0, ivSize)
+ val cipher = Cipher.getInstance(AES_MODE)
+ val spec = GCMParameterSpec(128, iv)
+ cipher.init(Cipher.DECRYPT_MODE, secretKey, spec)
+
+ CipherInputStream(inputStream, cipher).use { cipherInputStream ->
+ ObjectInputStream(cipherInputStream).use {
+ val readObject = it.readObject()
+ return readObject as? T
+ }
+ }
+
+ }
+
+ @RequiresApi(Build.VERSION_CODES.KITKAT)
+ @Throws(IOException::class)
+ fun loadSecureObjectK(keyAlias: String, inputStream: InputStream, context: Context): T? {
+
+ val (encryptedKey, iv, encrypted) = format1Extract(inputStream)
+
+ //we need to decrypt the key
+ val sKeyBytes = rsaDecrypt(keyAlias, ByteArrayInputStream(encryptedKey), context)
+ val cipher = Cipher.getInstance(AES_MODE)
+ val spec = if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) IvParameterSpec(iv) else GCMParameterSpec(128, iv)
+ cipher.init(Cipher.DECRYPT_MODE, SecretKeySpec(sKeyBytes, "AES"), spec)
+
+ val encIS = ByteArrayInputStream(encrypted)
+
+ CipherInputStream(encIS, cipher).use { cipherInputStream ->
+ ObjectInputStream(cipherInputStream).use {
+ val readObject = it.readObject()
+ return readObject as? T
+ }
+ }
+ }
+
+ @Throws(Exception::class)
+ fun loadSecureObjectOldNotGood(keyAlias: String, inputStream: InputStream): T? {
+
+ val (salt, iv, encrypted) = format2Extract(inputStream)
+
+ val factory = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA256")
+ val tmp = factory.generateSecret(PBEKeySpec(keyAlias.toCharArray(), salt, 10000, 128))
+ val sKey = SecretKeySpec(tmp.encoded, "AES")
+ //we need to decrypt the key
+
+ val cipher = Cipher.getInstance(AES_MODE)
+ val spec = if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) IvParameterSpec(iv) else GCMParameterSpec(128, iv)
+ cipher.init(Cipher.DECRYPT_MODE, sKey, spec)
+
+ val encIS = ByteArrayInputStream(encrypted)
+
+ CipherInputStream(encIS, cipher).use {
+ ObjectInputStream(it).use {
+ val readObject = it.readObject()
+ return readObject as? T
+ }
+ }
+ }
+
+
+ @RequiresApi(Build.VERSION_CODES.JELLY_BEAN_MR2)
+ @Throws(Exception::class)
+ private fun rsaEncrypt(alias: String, secret: ByteArray, context: Context): ByteArray {
+ val privateKeyEntry = getOrGenerateKeyPairForAlias(alias, context)
+ // Encrypt the text
+ val inputCipher = Cipher.getInstance(RSA_MODE)
+ inputCipher.init(Cipher.ENCRYPT_MODE, privateKeyEntry.certificate.publicKey)
+
+ val outputStream = ByteArrayOutputStream()
+ val cipherOutputStream = CipherOutputStream(outputStream, inputCipher)
+ cipherOutputStream.write(secret)
+ cipherOutputStream.close()
+
+ return outputStream.toByteArray()
+ }
+
+ @RequiresApi(Build.VERSION_CODES.JELLY_BEAN_MR2)
+ @Throws(Exception::class)
+ private fun rsaDecrypt(alias: String, encrypted: InputStream, context: Context): ByteArray {
+ val privateKeyEntry = getOrGenerateKeyPairForAlias(alias, context)
+ val output = Cipher.getInstance(RSA_MODE)
+ output.init(Cipher.DECRYPT_MODE, privateKeyEntry.privateKey)
+
+ val bos = ByteArrayOutputStream()
+ CipherInputStream(encrypted, output).use {
+ it.copyTo(bos)
+ }
+
+ return bos.toByteArray()
+ }
+
+ private fun formatMExtract(bis: InputStream): Pair {
+ val format = bis.read().toByte()
+ assert(format == FORMAT_API_M)
+
+ val ivSize = bis.read()
+ val iv = ByteArray(ivSize)
+ bis.read(iv, 0, ivSize)
+
+
+ val bos = ByteArrayOutputStream()
+ var next = bis.read()
+ while (next != -1) {
+ bos.write(next)
+ next = bis.read()
+ }
+ val encrypted = bos.toByteArray()
+ return Pair(iv, encrypted)
+ }
+
+ private fun formatMMake(iv: ByteArray, data: ByteArray): ByteArray {
+ val bos = ByteArrayOutputStream(2 + iv.size + data.size)
+ bos.write(FORMAT_API_M.toInt())
+ bos.write(iv.size)
+ bos.write(iv)
+ bos.write(data)
+ return bos.toByteArray()
+ }
+
+ private fun format1Extract(bis: InputStream): Triple {
+
+ val format = bis.read()
+ assert(format.toByte() == FORMAT_1)
+
+ val keySizeBig = bis.read()
+ val keySizeLow = bis.read()
+ val encryptedKeySize = keySizeBig.shl(8) + keySizeLow
+ val encryptedKey = ByteArray(encryptedKeySize)
+ bis.read(encryptedKey)
+
+ val ivSize = bis.read()
+ val iv = ByteArray(ivSize)
+ bis.read(iv)
+
+ val bos = ByteArrayOutputStream()
+
+ var next = bis.read()
+ while (next != -1) {
+ bos.write(next)
+ next = bis.read()
+ }
+ val encrypted = bos.toByteArray()
+ return Triple(encryptedKey, iv, encrypted)
+ }
+
+ private fun format1Make(encryptedKey: ByteArray, iv: ByteArray, encryptedBytes: ByteArray): ByteArray {
+ val bos = ByteArrayOutputStream(4 + encryptedKey.size + iv.size + encryptedBytes.size)
+ bos.write(FORMAT_1.toInt())
+ bos.write((encryptedKey.size and 0xFF00).shr(8))
+ bos.write(encryptedKey.size and 0x00FF)
+ bos.write(encryptedKey)
+ bos.write(iv.size)
+ bos.write(iv)
+ bos.write(encryptedBytes)
+
+ return bos.toByteArray()
+ }
+
+ private fun format2Make(salt: ByteArray, iv: ByteArray, encryptedBytes: ByteArray): ByteArray {
+ val bos = ByteArrayOutputStream(3 + salt.size + iv.size + encryptedBytes.size)
+ bos.write(FORMAT_2.toInt())
+ bos.write(salt.size)
+ bos.write(salt)
+ bos.write(iv.size)
+ bos.write(iv)
+ bos.write(encryptedBytes)
+
+ return bos.toByteArray()
+ }
+
+ private fun format2Extract(bis: InputStream): Triple {
+
+ val format = bis.read()
+ assert(format.toByte() == FORMAT_2)
+
+ val saltSize = bis.read()
+ val salt = ByteArray(saltSize)
+ bis.read(salt)
+
+ val ivSize = bis.read()
+ val iv = ByteArray(ivSize)
+ bis.read(iv)
+
+ val bos = ByteArrayOutputStream()
+
+ var next = bis.read()
+ while (next != -1) {
+ bos.write(next)
+ next = bis.read()
+ }
+ val encrypted = bos.toByteArray()
+ return Triple(salt, iv, encrypted)
+ }
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/Types.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/Types.kt
new file mode 100644
index 00000000..c2f710df
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/util/Types.kt
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.api.util
+
+import com.squareup.moshi.Types
+import java.lang.reflect.ParameterizedType
+
+typealias JsonDict = Map
+
+internal val JSON_DICT_PARAMETERIZED_TYPE: ParameterizedType = Types.newParameterizedType(Map::class.java, String::class.java, Any::class.java)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/SessionManager.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/SessionManager.kt
new file mode 100644
index 00000000..7cc73ceb
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/SessionManager.kt
@@ -0,0 +1,65 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal
+
+import im.vector.matrix.android.api.auth.data.SessionParams
+import im.vector.matrix.android.api.session.Session
+import im.vector.matrix.android.internal.auth.SessionParamsStore
+import im.vector.matrix.android.internal.di.MatrixComponent
+import im.vector.matrix.android.internal.di.MatrixScope
+import im.vector.matrix.android.internal.session.DaggerSessionComponent
+import im.vector.matrix.android.internal.session.SessionComponent
+import javax.inject.Inject
+
+@MatrixScope
+internal class SessionManager @Inject constructor(private val matrixComponent: MatrixComponent,
+ private val sessionParamsStore: SessionParamsStore) {
+
+ private val sessionComponents = HashMap()
+
+ fun getSessionComponent(userId: String): SessionComponent? {
+ val sessionParams = sessionParamsStore.get(userId) ?: return null
+ return getOrCreateSessionComponent(sessionParams)
+ }
+
+ fun getOrCreateSession(sessionParams: SessionParams): Session {
+ return getOrCreateSessionComponent(sessionParams).session()
+ }
+
+ fun releaseSession(userId: String) {
+ if (sessionComponents.containsKey(userId).not()) {
+ throw RuntimeException("You don't have a session for the user $userId")
+ }
+ sessionComponents.remove(userId)?.also {
+ it.session().close()
+ }
+ }
+
+ private fun getOrCreateSessionComponent(sessionParams: SessionParams): SessionComponent {
+ val userId = sessionParams.credentials.userId
+ if (sessionComponents.containsKey(userId)) {
+ return sessionComponents[userId]!!
+ }
+ return DaggerSessionComponent
+ .factory()
+ .create(matrixComponent, sessionParams)
+ .also {
+ sessionComponents[sessionParams.credentials.userId] = it
+ }
+ }
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/AuthAPI.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/AuthAPI.kt
new file mode 100644
index 00000000..d795a3c4
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/AuthAPI.kt
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.auth
+
+import im.vector.matrix.android.api.auth.data.Credentials
+import im.vector.matrix.android.internal.auth.data.PasswordLoginParams
+import im.vector.matrix.android.internal.network.NetworkConstants
+import retrofit2.Call
+import retrofit2.http.Body
+import retrofit2.http.Headers
+import retrofit2.http.POST
+
+/**
+ * The login REST API.
+ */
+internal interface AuthAPI {
+
+ /**
+ * Pass params to the server for the current login phase.
+ * Set all the timeouts to 1 minute
+ *
+ * @param loginParams the login parameters
+ */
+ @Headers("CONNECT_TIMEOUT:60000", "READ_TIMEOUT:60000", "WRITE_TIMEOUT:60000")
+ @POST(NetworkConstants.URI_API_PREFIX_PATH_R0 + "login")
+ fun login(@Body loginParams: PasswordLoginParams): Call
+
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/AuthModule.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/AuthModule.kt
new file mode 100644
index 00000000..2459c354
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/AuthModule.kt
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.auth
+
+import android.content.Context
+import dagger.Binds
+import dagger.Module
+import dagger.Provides
+import im.vector.matrix.android.api.auth.Authenticator
+import im.vector.matrix.android.internal.auth.db.AuthRealmModule
+import im.vector.matrix.android.internal.auth.db.RealmSessionParamsStore
+import im.vector.matrix.android.internal.database.configureEncryption
+import im.vector.matrix.android.internal.di.AuthDatabase
+import io.realm.RealmConfiguration
+import java.io.File
+
+@Module
+internal abstract class AuthModule {
+
+ @Module
+ companion object {
+ @JvmStatic
+ @Provides
+ @AuthDatabase
+ fun providesRealmConfiguration(context: Context): RealmConfiguration {
+ val old = File(context.filesDir, "matrix-sdk-auth")
+ if (old.exists()) {
+ old.renameTo(File(context.filesDir, "matrix-sdk-auth.realm"))
+ }
+ return RealmConfiguration.Builder()
+ .configureEncryption("matrix-sdk-auth", context)
+ .name("matrix-sdk-auth.realm")
+ .modules(AuthRealmModule())
+ .deleteRealmIfMigrationNeeded()
+ .build()
+ }
+ }
+
+
+ @Binds
+ abstract fun bindSessionParamsStore(sessionParamsStore: RealmSessionParamsStore): SessionParamsStore
+
+ @Binds
+ abstract fun bindAuthenticator(authenticator: DefaultAuthenticator): Authenticator
+
+}
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/DefaultAuthenticator.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/DefaultAuthenticator.kt
new file mode 100644
index 00000000..81e64f5b
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/DefaultAuthenticator.kt
@@ -0,0 +1,106 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.auth
+
+import android.util.Patterns
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.auth.Authenticator
+import im.vector.matrix.android.api.auth.data.Credentials
+import im.vector.matrix.android.api.auth.data.HomeServerConnectionConfig
+import im.vector.matrix.android.api.auth.data.SessionParams
+import im.vector.matrix.android.api.session.Session
+import im.vector.matrix.android.api.util.Cancelable
+import im.vector.matrix.android.internal.SessionManager
+import im.vector.matrix.android.internal.auth.data.PasswordLoginParams
+import im.vector.matrix.android.internal.auth.data.ThreePidMedium
+import im.vector.matrix.android.internal.di.Unauthenticated
+import im.vector.matrix.android.internal.extensions.foldToCallback
+import im.vector.matrix.android.internal.network.RetrofitFactory
+import im.vector.matrix.android.internal.network.executeRequest
+import im.vector.matrix.android.internal.util.CancelableCoroutine
+import im.vector.matrix.android.internal.util.MatrixCoroutineDispatchers
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
+import okhttp3.OkHttpClient
+import javax.inject.Inject
+
+internal class DefaultAuthenticator @Inject constructor(@Unauthenticated
+ private val okHttpClient: OkHttpClient,
+ private val retrofitFactory: RetrofitFactory,
+ private val coroutineDispatchers: MatrixCoroutineDispatchers,
+ private val sessionParamsStore: SessionParamsStore,
+ private val sessionManager: SessionManager
+) : Authenticator {
+
+ override fun hasAuthenticatedSessions(): Boolean {
+ return sessionParamsStore.getLast() != null
+ }
+
+ override fun getLastAuthenticatedSession(): Session? {
+ val sessionParams = sessionParamsStore.getLast()
+ return sessionParams?.let {
+ sessionManager.getOrCreateSession(it)
+ }
+ }
+
+ override fun getSession(sessionParams: SessionParams): Session? {
+ return sessionManager.getOrCreateSession(sessionParams)
+ }
+
+ override fun authenticate(homeServerConnectionConfig: HomeServerConnectionConfig,
+ login: String,
+ password: String,
+ callback: MatrixCallback): Cancelable {
+
+ val job = GlobalScope.launch(coroutineDispatchers.main) {
+ val sessionOrFailure = authenticate(homeServerConnectionConfig, login, password)
+ sessionOrFailure.foldToCallback(callback)
+ }
+ return CancelableCoroutine(job)
+
+ }
+
+ private suspend fun authenticate(homeServerConnectionConfig: HomeServerConnectionConfig,
+ login: String,
+ password: String) = withContext(coroutineDispatchers.io) {
+
+ val authAPI = buildAuthAPI(homeServerConnectionConfig)
+ val loginParams = if (Patterns.EMAIL_ADDRESS.matcher(login).matches()) {
+ PasswordLoginParams.thirdPartyIdentifier(ThreePidMedium.EMAIL, login, password, "Mobile")
+ } else {
+ PasswordLoginParams.userIdentifier(login, password, "Mobile")
+ }
+ executeRequest {
+ apiCall = authAPI.login(loginParams)
+ }.map {
+ val sessionParams = SessionParams(it, homeServerConnectionConfig)
+ sessionParamsStore.save(sessionParams)
+ sessionParams
+ }.map {
+ sessionManager.getOrCreateSession(it)
+ }
+
+ }
+
+ private fun buildAuthAPI(homeServerConnectionConfig: HomeServerConnectionConfig): AuthAPI {
+ val retrofit = retrofitFactory.create(okHttpClient, homeServerConnectionConfig.homeServerUri.toString())
+ return retrofit.create(AuthAPI::class.java)
+ }
+
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/SessionParamsStore.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/SessionParamsStore.kt
new file mode 100644
index 00000000..e7729d37
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/SessionParamsStore.kt
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.auth
+
+import arrow.core.Try
+import im.vector.matrix.android.api.auth.data.SessionParams
+
+internal interface SessionParamsStore {
+
+ fun get(userId: String): SessionParams?
+
+ fun getLast(): SessionParams?
+
+ fun getAll(): List
+
+ fun save(sessionParams: SessionParams): Try
+
+ fun delete(userId: String): Try
+
+ fun deleteAll(): Try
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/InteractiveAuthenticationFlow.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/InteractiveAuthenticationFlow.kt
new file mode 100644
index 00000000..ae75b273
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/InteractiveAuthenticationFlow.kt
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.auth.data
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * An interactive authentication flow.
+ */
+@JsonClass(generateAdapter = true)
+data class InteractiveAuthenticationFlow(
+
+ @Json(name = "type")
+ val type: String? = null,
+
+ @Json(name = "stages")
+ val stages: List? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/LoginFlowResponse.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/LoginFlowResponse.kt
new file mode 100644
index 00000000..834b0aee
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/LoginFlowResponse.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.auth.data
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+internal data class LoginFlowResponse(
+ @Json(name = "flows")
+ val flows: List
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/LoginFlowTypes.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/LoginFlowTypes.kt
new file mode 100644
index 00000000..1e129f1b
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/LoginFlowTypes.kt
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.auth.data
+
+object LoginFlowTypes {
+ const val PASSWORD = "m.login.password"
+ const val OAUTH2 = "m.login.oauth2"
+ const val EMAIL_CODE = "m.login.email.code"
+ const val EMAIL_URL = "m.login.email.url"
+ const val EMAIL_IDENTITY = "m.login.email.identity"
+ const val MSISDN = "m.login.msisdn"
+ const val RECAPTCHA = "m.login.recaptcha"
+ const val DUMMY = "m.login.dummy"
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/LoginParams.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/LoginParams.kt
new file mode 100644
index 00000000..af859aeb
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/LoginParams.kt
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.auth.data
+
+internal interface LoginParams {
+ val type: String
+}
\ No newline at end of file
diff --git a/matrix-sdk-core/src/main/java/im/vector/matrix/core/internal/login/data/PasswordLoginParams.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/PasswordLoginParams.kt
similarity index 55%
rename from matrix-sdk-core/src/main/java/im/vector/matrix/core/internal/login/data/PasswordLoginParams.kt
rename to matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/PasswordLoginParams.kt
index 74be74d0..372b18a9 100644
--- a/matrix-sdk-core/src/main/java/im/vector/matrix/core/internal/login/data/PasswordLoginParams.kt
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/data/PasswordLoginParams.kt
@@ -1,10 +1,26 @@
-package im.vector.matrix.core.internal.login.data
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.auth.data
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
@JsonClass(generateAdapter = true)
-data class PasswordLoginParams(@Json(name = "identifier") val identifier: Map,
+internal data class PasswordLoginParams(@Json(name = "identifier") val identifier: Map,
@Json(name = "password") val password: String,
@Json(name = "type") override val type: String,
@Json(name = "initial_device_display_name") val deviceDisplayName: String?,
@@ -25,7 +41,10 @@ data class PasswordLoginParams(@Json(name = "identifier") val identifier: Map()
identifier[IDENTIFIER_KEY_TYPE] = IDENTIFIER_KEY_TYPE_USER
identifier[IDENTIFIER_KEY_USER] = user
@@ -33,7 +52,11 @@ data class PasswordLoginParams(@Json(name = "identifier") val identifier: Map()
identifier[IDENTIFIER_KEY_TYPE] = IDENTIFIER_KEY_TYPE_THIRD_PARTY
identifier[IDENTIFIER_KEY_MEDIUM] = medium
@@ -42,6 +65,4 @@ data class PasswordLoginParams(@Json(name = "identifier") val identifier: Map {
+ val realm = Realm.getInstance(realmConfiguration)
+ val sessionParams = realm
+ .where(SessionParamsEntity::class.java)
+ .findAll()
+ .mapNotNull { mapper.map(it) }
+ realm.close()
+ return sessionParams
+ }
+
+ override fun save(sessionParams: SessionParams): Try {
+ return Try {
+ val entity = mapper.map(sessionParams)
+ if (entity != null) {
+ val realm = Realm.getInstance(realmConfiguration)
+ realm.executeTransaction {
+ it.insert(entity)
+ }
+ realm.close()
+ }
+ sessionParams
+ }
+ }
+
+ override fun delete(userId: String): Try {
+ return Try {
+ val realm = Realm.getInstance(realmConfiguration)
+ realm.executeTransaction {
+ it.where(SessionParamsEntity::class.java)
+ .equalTo(SessionParamsEntityFields.USER_ID, userId)
+ .findAll()
+ .deleteAllFromRealm()
+ }
+ realm.close()
+ }
+ }
+
+ override fun deleteAll(): Try {
+ return Try {
+ val realm = Realm.getInstance(realmConfiguration)
+ realm.executeTransaction {
+ it.where(SessionParamsEntity::class.java)
+ .findAll()
+ .deleteAllFromRealm()
+ }
+ realm.close()
+ }
+ }
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/db/SessionParamsEntity.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/db/SessionParamsEntity.kt
new file mode 100644
index 00000000..e6569d28
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/db/SessionParamsEntity.kt
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.auth.db
+
+import io.realm.RealmObject
+import io.realm.annotations.PrimaryKey
+
+internal open class SessionParamsEntity(
+ @PrimaryKey var userId: String = "",
+ var credentialsJson: String = "",
+ var homeServerConnectionConfigJson: String = ""
+) : RealmObject()
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/db/SessionParamsMapper.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/db/SessionParamsMapper.kt
new file mode 100644
index 00000000..64303ea0
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/db/SessionParamsMapper.kt
@@ -0,0 +1,56 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.auth.db
+
+import com.squareup.moshi.Moshi
+import im.vector.matrix.android.api.auth.data.Credentials
+import im.vector.matrix.android.api.auth.data.HomeServerConnectionConfig
+import im.vector.matrix.android.api.auth.data.SessionParams
+import im.vector.matrix.android.internal.di.MatrixScope
+import javax.inject.Inject
+
+internal class SessionParamsMapper @Inject constructor(moshi: Moshi) {
+
+ private val credentialsAdapter = moshi.adapter(Credentials::class.java)
+ private val homeServerConnectionConfigAdapter = moshi.adapter(HomeServerConnectionConfig::class.java)
+
+ fun map(entity: SessionParamsEntity?): SessionParams? {
+ if (entity == null) {
+ return null
+ }
+ val credentials = credentialsAdapter.fromJson(entity.credentialsJson)
+ val homeServerConnectionConfig = homeServerConnectionConfigAdapter.fromJson(entity.homeServerConnectionConfigJson)
+ if (credentials == null || homeServerConnectionConfig == null) {
+ return null
+ }
+ return SessionParams(credentials, homeServerConnectionConfig)
+ }
+
+ fun map(sessionParams: SessionParams?): SessionParamsEntity? {
+ if (sessionParams == null) {
+ return null
+ }
+ val credentialsJson = credentialsAdapter.toJson(sessionParams.credentials)
+ val homeServerConnectionConfigJson = homeServerConnectionConfigAdapter.toJson(sessionParams.homeServerConnectionConfig)
+ if (credentialsJson == null || homeServerConnectionConfigJson == null) {
+ return null
+ }
+ return SessionParamsEntity(sessionParams.credentials.userId, credentialsJson, homeServerConnectionConfigJson)
+ }
+
+
+}
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/registration/RegistrationFlowResponse.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/registration/RegistrationFlowResponse.kt
new file mode 100644
index 00000000..0eb7b05b
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/auth/registration/RegistrationFlowResponse.kt
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2019 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 im.vector.matrix.android.internal.auth.registration
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.util.JsonDict
+import im.vector.matrix.android.internal.auth.data.InteractiveAuthenticationFlow
+
+@JsonClass(generateAdapter = true)
+data class RegistrationFlowResponse(
+
+ /**
+ * The list of flows.
+ */
+ @Json(name = "flows")
+ var flows: List? = null,
+
+ /**
+ * The list of stages the client has completed successfully.
+ */
+ @Json(name = "completed")
+ var completedStages: List? = null,
+
+ /**
+ * The session identifier that the client must pass back to the home server, if one is provided,
+ * in subsequent attempts to authenticate in the same API call.
+ */
+ @Json(name = "session")
+ var session: String? = null,
+
+ /**
+ * The information that the client will need to know in order to use a given type of authentication.
+ * For each login stage type presented, that type may be present as a key in this dictionary.
+ * For example, the public key of reCAPTCHA stage could be given here.
+ */
+ @Json(name = "params")
+ var params: JsonDict? = null
+)
\ No newline at end of file
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/crypto/CryptoConstants.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/crypto/CryptoConstants.kt
new file mode 100644
index 00000000..c045019c
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/crypto/CryptoConstants.kt
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2018 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 im.vector.matrix.android.internal.crypto
+
+/**
+ * Matrix algorithm value for olm.
+ */
+const val MXCRYPTO_ALGORITHM_OLM = "m.olm.v1.curve25519-aes-sha2"
+
+/**
+ * Matrix algorithm value for megolm.
+ */
+const val MXCRYPTO_ALGORITHM_MEGOLM = "m.megolm.v1.aes-sha2"
+
+/**
+ * Matrix algorithm value for megolm keys backup.
+ */
+const val MXCRYPTO_ALGORITHM_MEGOLM_BACKUP = "m.megolm_backup.v1.curve25519-aes-sha2"
diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/crypto/CryptoManager.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/crypto/CryptoManager.kt
new file mode 100755
index 00000000..d52a457c
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/crypto/CryptoManager.kt
@@ -0,0 +1,1078 @@
+/*
+ * Copyright 2016 OpenMarket Ltd
+ * Copyright 2017 Vector Creations Ltd
+ * Copyright 2018 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 im.vector.matrix.android.internal.crypto
+
+import android.content.Context
+import android.os.Handler
+import android.os.Looper
+import android.text.TextUtils
+import arrow.core.Try
+import com.squareup.moshi.Types
+import com.zhuinden.monarchy.Monarchy
+import dagger.Lazy
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.auth.data.Credentials
+import im.vector.matrix.android.api.failure.Failure
+import im.vector.matrix.android.api.listeners.ProgressListener
+import im.vector.matrix.android.api.session.crypto.CryptoService
+import im.vector.matrix.android.api.session.crypto.MXCryptoError
+import im.vector.matrix.android.api.session.crypto.keysbackup.KeysBackupService
+import im.vector.matrix.android.api.session.crypto.keyshare.RoomKeysRequestListener
+import im.vector.matrix.android.api.session.crypto.sas.SasVerificationService
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.api.session.events.model.EventType
+import im.vector.matrix.android.api.session.events.model.toModel
+import im.vector.matrix.android.api.session.room.model.Membership
+import im.vector.matrix.android.api.session.room.model.RoomHistoryVisibility
+import im.vector.matrix.android.api.session.room.model.RoomHistoryVisibilityContent
+import im.vector.matrix.android.api.session.room.model.RoomMember
+import im.vector.matrix.android.internal.crypto.actions.MegolmSessionDataImporter
+import im.vector.matrix.android.internal.crypto.actions.SetDeviceVerificationAction
+import im.vector.matrix.android.internal.crypto.algorithms.IMXEncrypting
+import im.vector.matrix.android.internal.crypto.algorithms.megolm.MXMegolmEncryptionFactory
+import im.vector.matrix.android.internal.crypto.algorithms.olm.MXOlmEncryptionFactory
+import im.vector.matrix.android.internal.crypto.keysbackup.KeysBackup
+import im.vector.matrix.android.internal.crypto.model.ImportRoomKeysResult
+import im.vector.matrix.android.internal.crypto.model.MXDeviceInfo
+import im.vector.matrix.android.internal.crypto.model.MXEncryptEventContentResult
+import im.vector.matrix.android.internal.crypto.model.MXUsersDevicesMap
+import im.vector.matrix.android.internal.crypto.model.event.RoomKeyContent
+import im.vector.matrix.android.internal.crypto.model.rest.DevicesListResponse
+import im.vector.matrix.android.internal.crypto.model.rest.KeysUploadResponse
+import im.vector.matrix.android.internal.crypto.model.rest.RoomKeyRequestBody
+import im.vector.matrix.android.internal.crypto.repository.WarnOnUnknownDeviceRepository
+import im.vector.matrix.android.internal.crypto.store.IMXCryptoStore
+import im.vector.matrix.android.internal.crypto.tasks.*
+import im.vector.matrix.android.internal.crypto.verification.DefaultSasVerificationService
+import im.vector.matrix.android.internal.database.model.EventEntity
+import im.vector.matrix.android.internal.database.query.where
+import im.vector.matrix.android.internal.di.CryptoDatabase
+import im.vector.matrix.android.internal.di.MoshiProvider
+import im.vector.matrix.android.internal.extensions.foldToCallback
+import im.vector.matrix.android.internal.session.SessionScope
+import im.vector.matrix.android.internal.session.cache.ClearCacheTask
+import im.vector.matrix.android.internal.session.room.membership.LoadRoomMembersTask
+import im.vector.matrix.android.internal.session.room.membership.RoomMembers
+import im.vector.matrix.android.internal.session.sync.model.SyncResponse
+import im.vector.matrix.android.internal.task.TaskExecutor
+import im.vector.matrix.android.internal.task.configureWith
+import im.vector.matrix.android.internal.task.toConfigurableTask
+import im.vector.matrix.android.internal.util.JsonCanonicalizer
+import im.vector.matrix.android.internal.util.MatrixCoroutineDispatchers
+import im.vector.matrix.android.internal.util.fetchCopied
+import kotlinx.coroutines.*
+import org.matrix.olm.OlmManager
+import timber.log.Timber
+import java.util.*
+import java.util.concurrent.atomic.AtomicBoolean
+import javax.inject.Inject
+import kotlin.coroutines.EmptyCoroutineContext
+
+/**
+ * A `CryptoService` class instance manages the end-to-end crypto for a session.
+ *
+ *
+ * Messages posted by the user are automatically redirected to CryptoService in order to be encrypted
+ * before sending.
+ * In the other hand, received events goes through CryptoService for decrypting.
+ * CryptoService maintains all necessary keys and their sharing with other devices required for the crypto.
+ * Specially, it tracks all room membership changes events in order to do keys updates.
+ */
+@SessionScope
+internal class CryptoManager @Inject constructor(
+ // Olm Manager
+ private val olmManager: OlmManager,
+ // The credentials,
+ private val credentials: Credentials,
+ private val myDeviceInfoHolder: Lazy,
+ // the crypto store
+ private val cryptoStore: IMXCryptoStore,
+ // Olm device
+ private val olmDevice: MXOlmDevice,
+ // Set of parameters used to configure/customize the end-to-end crypto.
+ private val cryptoConfig: MXCryptoConfig = MXCryptoConfig(),
+ // Device list manager
+ private val deviceListManager: DeviceListManager,
+ // The key backup service.
+ private val keysBackup: KeysBackup,
+ //
+ private val objectSigner: ObjectSigner,
+ //
+ private val oneTimeKeysUploader: OneTimeKeysUploader,
+ //
+ private val roomDecryptorProvider: RoomDecryptorProvider,
+ // The SAS verification service.
+ private val sasVerificationService: DefaultSasVerificationService,
+ //
+ private val incomingRoomKeyRequestManager: IncomingRoomKeyRequestManager,
+ //
+ private val outgoingRoomKeyRequestManager: OutgoingRoomKeyRequestManager,
+ // Actions
+ private val setDeviceVerificationAction: SetDeviceVerificationAction,
+ private val megolmSessionDataImporter: MegolmSessionDataImporter,
+ private val warnOnUnknownDevicesRepository: WarnOnUnknownDeviceRepository,
+ // Repository
+ private val megolmEncryptionFactory: MXMegolmEncryptionFactory,
+ private val olmEncryptionFactory: MXOlmEncryptionFactory,
+ private val deleteDeviceTask: DeleteDeviceTask,
+ private val deleteDeviceWithUserPasswordTask: DeleteDeviceWithUserPasswordTask,
+ // Tasks
+ private val getDevicesTask: GetDevicesTask,
+ private val setDeviceNameTask: SetDeviceNameTask,
+ private val uploadKeysTask: UploadKeysTask,
+ private val loadRoomMembersTask: LoadRoomMembersTask,
+ @CryptoDatabase private val clearCryptoDataTask: ClearCacheTask,
+ private val monarchy: Monarchy,
+ private val coroutineDispatchers: MatrixCoroutineDispatchers,
+ private val taskExecutor: TaskExecutor
+) : CryptoService {
+
+ private val uiHandler = Handler(Looper.getMainLooper())
+
+ // MXEncrypting instance for each room.
+ private val roomEncryptors: MutableMap = HashMap()
+ private val isStarting = AtomicBoolean(false)
+ private val isStarted = AtomicBoolean(false)
+
+ fun onStateEvent(roomId: String, event: Event) {
+ when {
+ event.getClearType() == EventType.ENCRYPTION -> onRoomEncryptionEvent(roomId, event)
+ event.getClearType() == EventType.STATE_ROOM_MEMBER -> onRoomMembershipEvent(roomId, event)
+ event.getClearType() == EventType.STATE_HISTORY_VISIBILITY -> onRoomHistoryVisibilityEvent(roomId, event)
+ }
+ }
+
+ fun onLiveEvent(roomId: String, event: Event) {
+ when {
+ event.getClearType() == EventType.ENCRYPTION -> onRoomEncryptionEvent(roomId, event)
+ event.getClearType() == EventType.STATE_ROOM_MEMBER -> onRoomMembershipEvent(roomId, event)
+ event.getClearType() == EventType.STATE_HISTORY_VISIBILITY -> onRoomHistoryVisibilityEvent(roomId, event)
+ }
+ }
+
+ override fun setDeviceName(deviceId: String, deviceName: String, callback: MatrixCallback) {
+ setDeviceNameTask
+ .configureWith(SetDeviceNameTask.Params(deviceId, deviceName))
+ .dispatchTo(callback)
+ .executeBy(taskExecutor)
+ }
+
+ override fun deleteDevice(deviceId: String, callback: MatrixCallback) {
+ deleteDeviceTask
+ .configureWith(DeleteDeviceTask.Params(deviceId))
+ .dispatchTo(callback)
+ .executeBy(taskExecutor)
+ }
+
+ override fun deleteDeviceWithUserPassword(deviceId: String, authSession: String?, password: String, callback: MatrixCallback) {
+ deleteDeviceWithUserPasswordTask
+ .configureWith(DeleteDeviceWithUserPasswordTask.Params(deviceId, authSession, password))
+ .dispatchTo(callback)
+ .executeBy(taskExecutor)
+ }
+
+ override fun getCryptoVersion(context: Context, longFormat: Boolean): String {
+ return if (longFormat) olmManager.getDetailedVersion(context) else olmManager.version
+ }
+
+ override fun getMyDevice(): MXDeviceInfo {
+ return myDeviceInfoHolder.get().myDevice
+ }
+
+ override fun getDevicesList(callback: MatrixCallback) {
+ getDevicesTask
+ .toConfigurableTask()
+ .dispatchTo(callback)
+ .executeBy(taskExecutor)
+ }
+
+ override fun inboundGroupSessionsCount(onlyBackedUp: Boolean): Int {
+ return cryptoStore.inboundGroupSessionsCount(onlyBackedUp)
+ }
+
+ /**
+ * Provides the tracking status
+ *
+ * @param userId the user id
+ * @return the tracking status
+ */
+ override fun getDeviceTrackingStatus(userId: String): Int {
+ return cryptoStore.getDeviceTrackingStatus(userId, DeviceListManager.TRACKING_STATUS_NOT_TRACKED)
+ }
+
+ /**
+ * Tell if the MXCrypto is started
+ *
+ * @return true if the crypto is started
+ */
+ fun isStarted(): Boolean {
+ return isStarted.get()
+ }
+
+ /**
+ * Tells if the MXCrypto is starting.
+ *
+ * @return true if the crypto is starting
+ */
+ fun isStarting(): Boolean {
+ return isStarting.get()
+ }
+
+ /**
+ * Start the crypto module.
+ * Device keys will be uploaded, then one time keys if there are not enough on the homeserver
+ * and, then, if this is the first time, this new device will be announced to all other users
+ * devices.
+ *
+ * @param isInitialSync true if it starts from an initial sync
+ */
+ fun start(isInitialSync: Boolean) {
+ if (isStarted.get() || isStarting.get()) {
+ return
+ }
+ isStarting.set(true)
+ CoroutineScope(coroutineDispatchers.crypto).launch {
+ internalStart(isInitialSync)
+ }
+ }
+
+ private suspend fun internalStart(isInitialSync: Boolean) {
+ // Open the store
+ cryptoStore.open()
+ uploadDeviceKeys()
+ .flatMap { oneTimeKeysUploader.maybeUploadOneTimeKeys() }
+ .fold(
+ {
+ Timber.e("Start failed: $it")
+ delay(1000)
+ isStarting.set(false)
+ internalStart(isInitialSync)
+ },
+ {
+ outgoingRoomKeyRequestManager.start()
+ keysBackup.checkAndStartKeysBackup()
+ if (isInitialSync) {
+ // refresh the devices list for each known room members
+ deviceListManager.invalidateAllDeviceLists()
+ deviceListManager.refreshOutdatedDeviceLists()
+ } else {
+ incomingRoomKeyRequestManager.processReceivedRoomKeyRequests()
+ }
+ isStarting.set(false)
+ isStarted.set(true)
+ }
+ )
+ }
+
+ /**
+ * Close the crypto
+ */
+ fun close() {
+ olmDevice.release()
+ cryptoStore.close()
+ outgoingRoomKeyRequestManager.stop()
+ }
+
+ override fun isCryptoEnabled(): Boolean {
+ // TODO Check that this test is correct
+ return olmDevice != null
+ }
+
+ /**
+ * @return the Keys backup Service
+ */
+ override fun getKeysBackupService(): KeysBackupService {
+ return keysBackup
+ }
+
+ /**
+ * @return the SasVerificationService
+ */
+ override fun getSasVerificationService(): SasVerificationService {
+ return sasVerificationService
+ }
+
+ /**
+ * A sync response has been received
+ *
+ * @param syncResponse the syncResponse
+ */
+ fun onSyncCompleted(syncResponse: SyncResponse) {
+ CoroutineScope(coroutineDispatchers.crypto).launch {
+ if (syncResponse.deviceLists != null) {
+ deviceListManager.handleDeviceListsChanges(syncResponse.deviceLists.changed, syncResponse.deviceLists.left)
+ }
+ if (syncResponse.deviceOneTimeKeysCount != null) {
+ val currentCount = syncResponse.deviceOneTimeKeysCount.signedCurve25519 ?: 0
+ oneTimeKeysUploader.updateOneTimeKeyCount(currentCount)
+ }
+ if (isStarted()) {
+ // Make sure we process to-device messages before generating new one-time-keys #2782
+ deviceListManager.refreshOutdatedDeviceLists()
+ oneTimeKeysUploader.maybeUploadOneTimeKeys()
+ incomingRoomKeyRequestManager.processReceivedRoomKeyRequests()
+ }
+ }
+ }
+
+ /**
+ * Find a device by curve25519 identity key
+ *
+ * @param senderKey the curve25519 key to match.
+ * @param algorithm the encryption algorithm.
+ * @return the device info, or null if not found / unsupported algorithm / crypto released
+ */
+ override fun deviceWithIdentityKey(senderKey: String, algorithm: String): MXDeviceInfo? {
+ return if (!TextUtils.equals(algorithm, MXCRYPTO_ALGORITHM_MEGOLM) && !TextUtils.equals(algorithm, MXCRYPTO_ALGORITHM_OLM)) {
+ // We only deal in olm keys
+ null
+ } else cryptoStore.deviceWithIdentityKey(senderKey)
+ }
+
+ /**
+ * Provides the device information for a device id and a user Id
+ *
+ * @param userId the user id
+ * @param deviceId the device id
+ */
+ override fun getDeviceInfo(userId: String, deviceId: String?): MXDeviceInfo? {
+ return if (!TextUtils.isEmpty(userId) && !TextUtils.isEmpty(deviceId)) {
+ cryptoStore.getUserDevice(deviceId!!, userId)
+ } else {
+ null
+ }
+ }
+
+ /**
+ * Set the devices as known
+ *
+ * @param devices the devices. Note that the verified member of the devices in this list will not be updated by this method.
+ * @param callback the asynchronous callback
+ */
+ override fun setDevicesKnown(devices: List, callback: MatrixCallback?) {
+ // build a devices map
+ val devicesIdListByUserId = HashMap>()
+
+ for (di in devices) {
+ var deviceIdsList: MutableList? = devicesIdListByUserId[di.userId]?.toMutableList()
+
+ if (null == deviceIdsList) {
+ deviceIdsList = ArrayList()
+ devicesIdListByUserId[di.userId] = deviceIdsList
+ }
+ deviceIdsList.add(di.deviceId)
+ }
+
+ val userIds = devicesIdListByUserId.keys
+
+ for (userId in userIds) {
+ val storedDeviceIDs = cryptoStore.getUserDevices(userId)
+
+ // sanity checks
+ if (null != storedDeviceIDs) {
+ var isUpdated = false
+ val deviceIds = devicesIdListByUserId[userId]
+
+ deviceIds?.forEach { deviceId ->
+ val device = storedDeviceIDs[deviceId]
+
+ // assume if the device is either verified or blocked
+ // it means that the device is known
+ if (device?.isUnknown == true) {
+ device.verified = MXDeviceInfo.DEVICE_VERIFICATION_UNVERIFIED
+ isUpdated = true
+ }
+ }
+
+ if (isUpdated) {
+ cryptoStore.storeUserDevices(userId, storedDeviceIDs)
+ }
+ }
+ }
+
+
+ callback?.onSuccess(Unit)
+ }
+
+ /**
+ * Update the blocked/verified state of the given device.
+ *
+ * @param verificationStatus the new verification status
+ * @param deviceId the unique identifier for the device.
+ * @param userId the owner of the device
+ */
+ override fun setDeviceVerification(verificationStatus: Int, deviceId: String, userId: String) {
+ setDeviceVerificationAction.handle(verificationStatus, deviceId, userId)
+ }
+
+ /**
+ * Configure a room to use encryption.
+ *
+ * @param roomId the room id to enable encryption in.
+ * @param algorithm the encryption config for the room.
+ * @param inhibitDeviceQuery true to suppress device list query for users in the room (for now)
+ * @param membersId list of members to start tracking their devices
+ * @return true if the operation succeeds.
+ */
+ private suspend fun setEncryptionInRoom(roomId: String,
+ algorithm: String?,
+ inhibitDeviceQuery: Boolean,
+ membersId: List): Boolean {
+ // If we already have encryption in this room, we should ignore this event
+ // (for now at least. Maybe we should alert the user somehow?)
+ val existingAlgorithm = cryptoStore.getRoomAlgorithm(roomId)
+
+ if (!TextUtils.isEmpty(existingAlgorithm) && !TextUtils.equals(existingAlgorithm, algorithm)) {
+ Timber.e("## setEncryptionInRoom() : Ignoring m.room.encryption event which requests a change of config in $roomId")
+ return false
+ }
+
+ val encryptingClass = MXCryptoAlgorithms.hasEncryptorClassForAlgorithm(algorithm)
+
+ if (!encryptingClass) {
+ Timber.e("## setEncryptionInRoom() : Unable to encrypt room ${roomId} with $algorithm")
+ return false
+ }
+
+ cryptoStore.storeRoomAlgorithm(roomId, algorithm!!)
+
+ val alg: IMXEncrypting = when (algorithm) {
+ MXCRYPTO_ALGORITHM_MEGOLM -> megolmEncryptionFactory.create(roomId)
+ else -> olmEncryptionFactory.create(roomId)
+ }
+
+ synchronized(roomEncryptors) {
+ roomEncryptors.put(roomId, alg)
+ }
+
+ // if encryption was not previously enabled in this room, we will have been
+ // ignoring new device events for these users so far. We may well have
+ // up-to-date lists for some users, for instance if we were sharing other
+ // e2e rooms with them, so there is room for optimisation here, but for now
+ // we just invalidate everyone in the room.
+ if (null == existingAlgorithm) {
+ Timber.v("Enabling encryption in $roomId for the first time; invalidating device lists for all users therein")
+
+ val userIds = ArrayList(membersId)
+
+ deviceListManager.startTrackingDeviceList(userIds)
+
+ if (!inhibitDeviceQuery) {
+ deviceListManager.refreshOutdatedDeviceLists()
+ }
+ }
+
+ return true
+ }
+
+ /**
+ * Tells if a room is encrypted
+ *
+ * @param roomId the room id
+ * @return true if the room is encrypted
+ */
+ override fun isRoomEncrypted(roomId: String): Boolean {
+ val encryptionEvent = monarchy.fetchCopied {
+ EventEntity.where(it, roomId = roomId, type = EventType.ENCRYPTION).findFirst()
+ }
+ return encryptionEvent != null
+ }
+
+ /**
+ * @return the stored device keys for a user.
+ */
+ override fun getUserDevices(userId: String): MutableList {
+ val map = cryptoStore.getUserDevices(userId)
+ return if (null != map) ArrayList(map.values) else ArrayList()
+ }
+
+ fun isEncryptionEnabledForInvitedUser(): Boolean {
+ return cryptoConfig.enableEncryptionForInvitedMembers
+ }
+
+ override fun getEncryptionAlgorithm(roomId: String): String? {
+ return cryptoStore.getRoomAlgorithm(roomId)
+ }
+
+ /**
+ * Determine whether we should encrypt messages for invited users in this room.
+ *
+ * Check here whether the invited members are allowed to read messages in the room history
+ * from the point they were invited onwards.
+ *
+ * @return true if we should encrypt messages for invited users.
+ */
+ override fun shouldEncryptForInvitedMembers(roomId: String): Boolean {
+ return cryptoStore.shouldEncryptForInvitedMembers(roomId)
+ }
+
+ /**
+ * Encrypt an event content according to the configuration of the room.
+ *
+ * @param eventContent the content of the event.
+ * @param eventType the type of the event.
+ * @param roomId the room identifier the event will be sent.
+ * @param callback the asynchronous callback
+ */
+ override fun encryptEventContent(eventContent: Content,
+ eventType: String,
+ roomId: String,
+ callback: MatrixCallback) {
+ CoroutineScope(coroutineDispatchers.crypto).launch {
+ if (!isStarted()) {
+ Timber.v("## encryptEventContent() : wait after e2e init")
+ internalStart(false)
+ }
+ val userIds = getRoomUserIds(roomId)
+ var alg = synchronized(roomEncryptors) {
+ roomEncryptors[roomId]
+ }
+ if (alg == null) {
+ val algorithm = getEncryptionAlgorithm(roomId)
+ if (algorithm != null) {
+ if (setEncryptionInRoom(roomId, algorithm, false, userIds)) {
+ synchronized(roomEncryptors) {
+ alg = roomEncryptors[roomId]
+ }
+ }
+ }
+ }
+ val safeAlgorithm = alg
+ if (safeAlgorithm != null) {
+ val t0 = System.currentTimeMillis()
+ Timber.v("## encryptEventContent() starts")
+ safeAlgorithm.encryptEventContent(eventContent, eventType, userIds)
+ .fold(
+ { callback.onFailure(it) },
+ {
+ Timber.v("## encryptEventContent() : succeeds after ${System.currentTimeMillis() - t0} ms")
+ callback.onSuccess(MXEncryptEventContentResult(it, EventType.ENCRYPTED))
+ }
+ )
+ } else {
+ val algorithm = getEncryptionAlgorithm(roomId)
+ val reason = String.format(MXCryptoError.UNABLE_TO_ENCRYPT_REASON,
+ algorithm ?: MXCryptoError.NO_MORE_ALGORITHM_REASON)
+ Timber.e("## encryptEventContent() : $reason")
+ callback.onFailure(Failure.CryptoError(MXCryptoError.Base(MXCryptoError.ErrorType.UNABLE_TO_ENCRYPT, reason)))
+ }
+ }
+ }
+
+ /**
+ * Decrypt an event
+ *
+ * @param event the raw event.
+ * @param timeline the id of the timeline where the event is decrypted. It is used to prevent replay attack.
+ * @return the MXEventDecryptionResult data, or throw in case of error
+ */
+ @Throws(MXCryptoError::class)
+ override fun decryptEvent(event: Event, timeline: String): MXEventDecryptionResult {
+ return runBlocking {
+ internalDecryptEvent(event, timeline).fold(
+ { throw it },
+ { it }
+ )
+ }
+ }
+
+ /**
+ * Decrypt an event asynchronously
+ *
+ * @param event the raw event.
+ * @param timeline the id of the timeline where the event is decrypted. It is used to prevent replay attack.
+ * @param callback the callback to return data or null
+ */
+ override fun decryptEventAsync(event: Event, timeline: String, callback: MatrixCallback) {
+ GlobalScope.launch(EmptyCoroutineContext) {
+ val result = withContext(coroutineDispatchers.crypto) {
+ internalDecryptEvent(event, timeline)
+ }
+ result.foldToCallback(callback)
+ }
+ }
+
+ /**
+ * Decrypt an event
+ *
+ * @param event the raw event.
+ * @param timeline the id of the timeline where the event is decrypted. It is used to prevent replay attack.
+ * @return the MXEventDecryptionResult data, or null in case of error wrapped into [Try]
+ */
+ private suspend fun internalDecryptEvent(event: Event, timeline: String): Try {
+ val eventContent = event.content
+ return if (eventContent == null) {
+ Timber.e("## decryptEvent : empty event content")
+ Try.Failure(MXCryptoError.Base(MXCryptoError.ErrorType.BAD_ENCRYPTED_MESSAGE, MXCryptoError.BAD_ENCRYPTED_MESSAGE_REASON))
+ } else {
+ val algorithm = eventContent["algorithm"]?.toString()
+ val alg = roomDecryptorProvider.getOrCreateRoomDecryptor(event.roomId, algorithm)
+ if (alg == null) {
+ val reason = String.format(MXCryptoError.UNABLE_TO_DECRYPT_REASON, event.eventId, algorithm)
+ Timber.e("## decryptEvent() : $reason")
+ Try.Failure(MXCryptoError.Base(MXCryptoError.ErrorType.UNABLE_TO_DECRYPT, reason))
+ } else {
+ alg.decryptEvent(event, timeline)
+ }
+ }
+ }
+
+ /**
+ * Reset replay attack data for the given timeline.
+ *
+ * @param timelineId the timeline id
+ */
+ fun resetReplayAttackCheckInTimeline(timelineId: String) {
+ olmDevice.resetReplayAttackCheckInTimeline(timelineId)
+ }
+
+ /**
+ * Handle the 'toDevice' event
+ *
+ * @param event the event
+ */
+ fun onToDeviceEvent(event: Event) {
+ CoroutineScope(coroutineDispatchers.crypto).launch {
+ when (event.getClearType()) {
+ EventType.ROOM_KEY, EventType.FORWARDED_ROOM_KEY -> {
+ onRoomKeyEvent(event)
+ }
+ EventType.ROOM_KEY_REQUEST -> {
+ incomingRoomKeyRequestManager.onRoomKeyRequestEvent(event)
+ }
+ else -> {
+ //ignore
+ }
+ }
+ }
+ }
+
+ /**
+ * Handle a key event.
+ *
+ * @param event the key event.
+ */
+ private fun onRoomKeyEvent(event: Event) {
+ val roomKeyContent = event.getClearContent().toModel() ?: return
+ if (TextUtils.isEmpty(roomKeyContent.roomId) || TextUtils.isEmpty(roomKeyContent.algorithm)) {
+ Timber.e("## onRoomKeyEvent() : missing fields")
+ return
+ }
+ val alg = roomDecryptorProvider.getOrCreateRoomDecryptor(roomKeyContent.roomId, roomKeyContent.algorithm)
+ if (alg == null) {
+ Timber.e("## onRoomKeyEvent() : Unable to handle keys for ${roomKeyContent.algorithm}")
+ return
+ }
+ alg.onRoomKeyEvent(event, keysBackup)
+ }
+
+ /**
+ * Handle an m.room.encryption event.
+ *
+ * @param event the encryption event.
+ */
+ private fun onRoomEncryptionEvent(roomId: String, event: Event) {
+ CoroutineScope(coroutineDispatchers.crypto).launch {
+ val params = LoadRoomMembersTask.Params(roomId)
+ loadRoomMembersTask
+ .execute(params)
+ .map { _ ->
+ val userIds = getRoomUserIds(roomId)
+ setEncryptionInRoom(roomId, event.content?.get("algorithm")?.toString(), true, userIds)
+ }
+ }
+ }
+
+ private fun getRoomUserIds(roomId: String): List {
+ var userIds: List = emptyList()
+ monarchy.doWithRealm { realm ->
+ // Check whether the event content must be encrypted for the invited members.
+ val encryptForInvitedMembers = isEncryptionEnabledForInvitedUser()
+ && shouldEncryptForInvitedMembers(roomId)
+
+ userIds = if (encryptForInvitedMembers) {
+ RoomMembers(realm, roomId).getActiveRoomMemberIds()
+ } else {
+ RoomMembers(realm, roomId).getJoinedRoomMemberIds()
+ }
+
+ }
+ return userIds
+ }
+
+ /**
+ * Handle a change in the membership state of a member of a room.
+ *
+ * @param event the membership event causing the change
+ */
+ private fun onRoomMembershipEvent(roomId: String, event: Event) {
+ val alg: IMXEncrypting?
+
+ synchronized(roomEncryptors) {
+ alg = roomEncryptors[roomId]
+ }
+
+ if (null == alg) {
+ // No encrypting in this room
+ return
+ }
+ event.stateKey?.let { userId ->
+ val roomMember: RoomMember? = event.content.toModel()
+ val membership = roomMember?.membership
+ if (membership == Membership.JOIN) {
+ // make sure we are tracking the deviceList for this user.
+ deviceListManager.startTrackingDeviceList(Arrays.asList(userId))
+ } else if (membership == Membership.INVITE
+ && shouldEncryptForInvitedMembers(roomId)
+ && cryptoConfig.enableEncryptionForInvitedMembers) {
+ // track the deviceList for this invited user.
+ // Caution: there's a big edge case here in that federated servers do not
+ // know what other servers are in the room at the time they've been invited.
+ // They therefore will not send device updates if a user logs in whilst
+ // their state is invite.
+ deviceListManager.startTrackingDeviceList(Arrays.asList(userId))
+ }
+ }
+ }
+
+ private fun onRoomHistoryVisibilityEvent(roomId: String, event: Event) {
+ val eventContent = event.content.toModel()
+ eventContent?.historyVisibility?.let {
+ cryptoStore.setShouldEncryptForInvitedMembers(roomId, it != RoomHistoryVisibility.JOINED)
+ }
+ }
+
+
+ /**
+ * Upload my user's device keys.
+ */
+ private suspend fun uploadDeviceKeys(): Try {
+ // Prepare the device keys data to send
+ // Sign it
+ val canonicalJson = JsonCanonicalizer.getCanonicalJson(Map::class.java, getMyDevice().signalableJSONDictionary())
+ getMyDevice().signatures = objectSigner.signObject(canonicalJson)
+
+ // For now, we set the device id explicitly, as we may not be using the
+ // same one as used in login.
+ val uploadDeviceKeysParams = UploadKeysTask.Params(getMyDevice().toDeviceKeys(), null, getMyDevice().deviceId)
+ return uploadKeysTask.execute(uploadDeviceKeysParams)
+ }
+
+ /**
+ * Export the crypto keys
+ *
+ * @param password the password
+ * @param callback the exported keys
+ */
+ override fun exportRoomKeys(password: String, callback: MatrixCallback) {
+ exportRoomKeys(password, MXMegolmExportEncryption.DEFAULT_ITERATION_COUNT, callback)
+ }
+
+ /**
+ * Export the crypto keys
+ *
+ * @param password the password
+ * @param anIterationCount the encryption iteration count (0 means no encryption)
+ * @param callback the exported keys
+ */
+ private fun exportRoomKeys(password: String, anIterationCount: Int, callback: MatrixCallback) {
+ GlobalScope.launch(coroutineDispatchers.main) {
+ withContext(coroutineDispatchers.crypto) {
+ Try {
+ val iterationCount = Math.max(0, anIterationCount)
+
+ val exportedSessions = ArrayList()
+
+ val inboundGroupSessions = cryptoStore.getInboundGroupSessions()
+
+ for (session in inboundGroupSessions) {
+ val megolmSessionData = session.exportKeys()
+
+ if (null != megolmSessionData) {
+ exportedSessions.add(megolmSessionData)
+ }
+ }
+
+ val adapter = MoshiProvider.providesMoshi()
+ .adapter(List::class.java)
+
+ MXMegolmExportEncryption.encryptMegolmKeyFile(adapter.toJson(exportedSessions), password, iterationCount)
+ }
+ }.foldToCallback(callback)
+ }
+ }
+
+ /**
+ * Import the room keys
+ *
+ * @param roomKeysAsArray the room keys as array.
+ * @param password the password
+ * @param progressListener the progress listener
+ * @param callback the asynchronous callback.
+ */
+ override fun importRoomKeys(roomKeysAsArray: ByteArray,
+ password: String,
+ progressListener: ProgressListener?,
+ callback: MatrixCallback) {
+ GlobalScope.launch(coroutineDispatchers.main) {
+ withContext(coroutineDispatchers.crypto) {
+ Try {
+ Timber.v("## importRoomKeys starts")
+
+ val t0 = System.currentTimeMillis()
+ val roomKeys = MXMegolmExportEncryption.decryptMegolmKeyFile(roomKeysAsArray, password)
+ val t1 = System.currentTimeMillis()
+
+ Timber.v("## importRoomKeys : decryptMegolmKeyFile done in ${t1 - t0} ms")
+
+ val importedSessions = MoshiProvider.providesMoshi()
+ .adapter