Merge tag 'v1.0.12' into sc

Conflicts:
	matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/database/RealmSessionStoreMigration.kt
	vector/src/main/java/im/vector/app/features/home/HomeActivity.kt
	vector/src/main/java/im/vector/app/features/home/room/detail/RoomDetailViewModel.kt
	vector/src/main/java/im/vector/app/features/home/room/detail/timeline/item/MessageTextItem.kt
	vector/src/main/java/im/vector/app/features/roomdirectory/createroom/CreateRoomController.kt
	vector/src/main/java/im/vector/app/features/roomprofile/settings/RoomSettingsController.kt
	vector/src/main/java/im/vector/app/features/themes/ActivityOtherThemes.kt
	vector/src/main/java/im/vector/app/features/themes/ThemeUtils.kt
	vector/src/main/res/drawable/ic_attachment.xml
	vector/src/main/res/layout/item_bottom_sheet_action.xml
	vector/src/main/res/layout/item_timeline_event_base.xml
	vector/src/main/res/layout/item_timeline_event_text_message_stub.xml
	vector/src/main/res/values-v23/theme_status.xml
	vector/src/main/res/values/array.xml
	vector/src/main/res/values/theme_status.xml

Note to self: need to check if URL preview works with wrap_content

Change-Id: I028b2873a33bb1a770f2da96d576b97202b5bcf9

.idea/dictionaries/bmarty.xml

@@ -24,6 +24,8 @@
       <w>pbkdf</w>
       <w>pids</w>
       <w>pkcs</w>
+      <w>previewable</w>
+      <w>previewables</w>
       <w>riotx</w>
       <w>signin</w>
       <w>signout</w>
@@ -31,6 +33,7 @@
       <w>ssss</w>
       <w>sygnal</w>
       <w>threepid</w>
+      <w>unpublish</w>
       <w>unwedging</w>
     </words>
   </dictionary>

CHANGES.md

@@ -1,3 +1,44 @@
+Changes in Element 1.0.12 (2020-12-15)
+===================================================
+
+Features ✨:
+ - Add room aliases management, and room directory visibility management in a dedicated screen (#1579, #2428)
+ - Room setting: update join rules and guest access (#2442)
+ - Url preview (#481)
+ - Store encrypted file in cache and cleanup decrypted file at each app start (#2512)
+ - Emoji Keyboard (#2520)
+ - Social login (#2452)
+ - Support for chat effects in timeline (confetti, snow) (#2535)
+
+Improvements 🙌:
+ - Add Setting Item to Change PIN (#2462)
+ - Improve room history visibility setting UX (#1579)
+ - Matrix.to deeplink custom scheme support
+ - Homeserver history (#1933)
+
+Bugfix 🐛:
+ - Fix cancellation of sending event (#2438)
+ - Double bottomsheet effect after verify with passphrase
+ - EditText cursor jumps to the start while typing fast (#2469)
+ - UTD for events before invitation if member state events are hidden (#2486)
+ - No known servers error is given when joining rooms on new Gitter bridge (#2516)
+ - Show preview when sending attachment from the keyboard (#2440)
+ - Do not compress GIFs (#1616, #1254)
+
+SDK API changes ⚠️:
+ - StateService now exposes suspendable function instead of using MatrixCallback.
+ - RawCacheStrategy has been moved and renamed to CacheStrategy
+ - FileService: remove useless FileService.DownloadMode
+
+Build 🧱:
+ - Upgrade some dependencies and Kotlin version
+ - Use fragment-ktx and preference-ktx dependencies (fix lint issue KtxExtensionAvailable)
+ - Upgrade Realm dependency to 10.1.2
+
+Other changes:
+ - Remove "Status.im" theme #2424
+ - Log HTTP requests and responses in production (level BASIC, i.e. without any private data)
+
 Changes in Element 1.0.11 (2020-11-27)
 ===================================================
 

attachment-viewer/build.gradle

@@ -66,7 +66,6 @@ dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
     implementation 'androidx.core:core-ktx:1.3.2'
     implementation 'androidx.appcompat:appcompat:1.2.0'
-    implementation "androidx.fragment:fragment:1.3.0-beta01"
     implementation "androidx.recyclerview:recyclerview:1.1.0"
 
     implementation 'com.google.android.material:material:1.2.1'

build.gradle

@@ -2,8 +2,8 @@
 
 buildscript {
     // Ref: https://kotlinlang.org/releases.html
-    ext.kotlin_version = '1.4.10'
+    ext.kotlin_version = '1.4.20'
-    ext.kotlin_coroutines_version = "1.3.9"
+    ext.kotlin_coroutines_version = "1.4.1"
     repositories {
         google()
         jcenter()
@@ -12,7 +12,7 @@ buildscript {
         }
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.1.0'
+        classpath 'com.android.tools.build:gradle:4.1.1'
         classpath 'com.google.gms:google-services:4.3.4'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
         classpath 'org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:2.7.1'
@@ -43,6 +43,10 @@ allprojects {
                 includeGroupByRegex 'com\\.github\\.chrisbanes'
                 // PFLockScreen-Android
                 includeGroupByRegex 'com\\.github\\.vector-im'
+
+                //Chat effects
+                includeGroupByRegex 'com\\.github\\.jetradarmobile'
+                includeGroupByRegex 'nl\\.dionsegijn'
             }
         }
         maven {

fastlane/metadata/android/en-US/changelogs/40100120.txt

@@ -0,0 +1,2 @@
+Main changes in this version: URL Preview, new Emoji keyboard, new room settings capabilities, and snow for Christmas!
+Full changelog: https://github.com/vector-im/element-android/releases/tag/v1.0.12

fastlane/metadata/android/fi/changelogs/40100100.txt

@@ -0,0 +1,2 @@
+Tämä versio sisältää virheenkorjauksia ja muita parannuksia. Viestien lähettäminen on nyt paljon nopeampaa.
+Täysi muutosloki: https://github.com/vector-im/element-android/releases/tag/v1.0.10

fastlane/metadata/android/fi/full_description.txt

@@ -0,0 +1,30 @@
+Element on uudenlainen viestinsovellus, joka:
+
+1. Antaa sinun päättää yksityisyydestäsi.
+2. Antaa sinun kommunikoida kenen tahansa kanssa Matrix-verkossa ja jopa sen ulkopuolella siltaamalla sovelluksiin, kuten Slack
+3. Suojaa sinua mainonnalta, tietojen keräämiseltä ja suljetuilta alustoilta
+4. Suojaa sinut päästä päähän -salauksella sekä ristiin varmentamisella muiden todentamiseksi
+
+Element eroaa täysin muista viestintäsovelluksista, koska se on hajautettu ja avointa lähdekoodia.
+
+Element antaa sinun isännöidä itse - valita isännän - jotta sinulla on yksityisyys ja voit hallita tietojasi sekä keskustelujasi. Se antaa sinulle pääsyn avoimeen verkkoon; joten et ole jumissa Elementin käyttäjissä.
+
+Element pystyy tekemään kaiken tämän, koska se toimii Matrixilla - avoimella, hajautetun viestinnän standardilla.
+
+Element antaa sinulle hallinnan antamalla sinun valita, kuka isännöi keskustelujasi. Element-sovelluksessa voit valita isännän eri tavoin:
+
+1. Hanki ilmainen tili Matrix-kehittäjien ylläpitämällä matrix.org-palvelimella tai valitse tuhansista vapaaehtoisten ylläpitämistä julkisista palvelimista.
+2. Isännöi tiliäsi itse suorittamalla palvelinta omalla laitteellasi
+3. Luo tili mukautetulla palvelimella yksinkertaisesti tilaamalla Element Matrix Services -palvelu
+
+<b>Miksi valita Element?</b>
+
+<b>OMAT TIEDOT</b>: Sinä päätät, missä tietosi ja viestisi säilytetään. Hallitset sitä itse, eikä jokin MEGAYHTIÖ, joka tutkii tietojasi tai antaa niitä kolmansille osapuolille.
+
+<b>AVOIN KOMMUNIKOINYI JA YHTEISTYÖ</b>: Voit keskustella kaikkien muiden Matrix-verkon käyttäjien kanssa, riippumatta siitä käyttävätkö he Elementiä tai muuta Matrix-sovellusta, ja vaikka he käyttäisivät eri viestijärjestelmiä, kuten Slack, IRC tai XMPP.
+
+<b>ERITTÄIN TURVALLINEN</b>: Vahva päästä päähän -salaus (vain keskustelussa olevat voivat purkaa viestien salauksen), ja ristiin varmentaminen keskustelun osallistujien laitteiden tarkistamiseksi.
+
+<b>TÄYDELLISTÄ VIESTINTÄÄ</b>: Viestit, ääni- ja videopuhelut, tiedostojen jakaminen, näytön jakaminen ja koko joukko integraatioita, botteja ja widgettejä. Rakenna huoneita, yhteisöjä, pidä yhteyttä ja tee asioita.
+
+<b>MISSÄ TAHANSA OLETKIN</b>: Pidä yhteyttä missä tahansa, täysin synkronoidun viestihistorian kautta kaikilla laitteillasi ja verkossa osoitteessa https://app.element.io.

fastlane/metadata/android/fi/short_description.txt

@@ -1 +1 @@
-Turvallista, hajautettua keskustelua ja VoIP-puheluita. Pidä tietosi turvassa.
+Turvallista, hajautettua, keskusteluja ja VoIP-puheluita. Pidä tietosi turvassa.

fastlane/metadata/android/it/changelogs/40100100.txt

@@ -1 +1,2 @@
-// DA FARE
+Questa nuova versione contiene soprattutto correzioni di errori e miglioramenti. L'invio di messaggi ora è molto più veloce.
+Cronologia completa: https://github.com/vector-im/element-android/releases/tag/v1.0.10

fastlane/metadata/android/pt_BR/changelogs/40100100.txt

@@ -1 +1,2 @@
-// A FAZER
+Esta nova versão contém principalmente correções de erros e melhorias. Enviar mensagens agora é muito mais rápido.
+Registro de todas as alterações: https://github.com/vector-im/element-android/releases/tag/v1.0.10

fastlane/metadata/android/sv/changelogs/40100100.txt

@@ -1 +1,2 @@
-// ATT GÖRA
+Den här nya versionen innehåller mest buggfixar och förbättringar. Det går nu mycket snabbare att skicka meddelanden.
+Full ändringslogg: https://github.com/vector-im/element-android/releases/tag/v1.0.10

fastlane/metadata/android/uk/changelogs/40100100.txt

@@ -0,0 +1,2 @@
+Ця версія містить переважно виправлення помилок та деякі покращення. Відправлення повідомлень стало тепер ще швидшим.
+Повний перелік змін: https://github.com/vector-im/element-android/releases/tag/v1.0.10

fastlane/metadata/android/uk/full_description.txt

@@ -7,7 +7,7 @@ Element — це застосунок для спілкування та спі
 
 Element ґрунтовно відрізняється від інших застосунків для спілкування та співпраці тому що він є децентралізованим та відкритоджерельним.
 
-Element дозволяє вам розміщувати сервер в себе або обирати будь-якого з надавачів послуг, таким чином забезпечуючи вам конфіденційність і  можливість володіти власними даними й бесідами та контролювати їх. Він надає вам доступ до відкритої мережі, тож ви не є обмеженими спілкуванням виключно з користувачами Element. І він є дуже надійним та безпечним.
+Element дозволяє вам розміщувати сервер в себе або обирати будь-якого з надавачів послуг, таким чином забезпечуючи вам конфіденційність і можливість володіти власними даними й бесідами та контролювати їх. Він надає вам доступ до відкритої мережі, тож ви не є обмеженими спілкуванням виключно з користувачами Element. І він є дуже надійним та безпечним.
 
 Element здатен забезпечити усе це завдяки тому, що він заснований на протоколі Matrix — стандарті для відкритого та децентралізованого спілкування.
 

fastlane/metadata/android/zh_Hant/changelogs/40100100.txt

@@ -1 +1,2 @@
-// 待辦事項
+這個新版本主要包含錯誤修復與改善。傳送訊息更快了。
+完整的變更紀錄請見：https://github.com/vector-im/element-android/releases/tag/v1.0.10

gradle.properties

@@ -18,7 +18,7 @@ org.gradle.jvmargs=-Xmx2048m
 org.gradle.vfs.watch=true
 
 vector.debugPrivateData=false
-vector.httpLogLevel=NONE
+vector.httpLogLevel=BASIC
 
 # Note: to debug, you can put and uncomment the following lines in the file ~/.gradle/gradle.properties to override the value above
 #vector.debugPrivateData=true

matrix-sdk-android-rx/build.gradle

@@ -36,9 +36,10 @@ android {
 dependencies {
     implementation project(":matrix-sdk-android")
     implementation 'androidx.appcompat:appcompat:1.2.0'
-    implementation "androidx.fragment:fragment:1.3.0-beta01"
     implementation 'io.reactivex.rxjava2:rxkotlin:2.3.0'
     implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-rx2:$kotlin_coroutines_version"
+
     // Paging
     implementation "androidx.paging:paging-runtime-ktx:2.1.2"
 

matrix-sdk-android-rx/src/main/java/org/matrix/android/sdk/rx/RxCallbackBuilders.kt

@@ -21,34 +21,36 @@ import org.matrix.android.sdk.api.util.Cancelable
 import io.reactivex.Completable
 import io.reactivex.Single
 
-fun <T> singleBuilder(builder: (callback: MatrixCallback<T>) -> Cancelable): Single<T> = Single.create {
+fun <T> singleBuilder(builder: (MatrixCallback<T>) -> Cancelable): Single<T> = Single.create { emitter ->
-    val callback: MatrixCallback<T> = object : MatrixCallback<T> {
+    val callback = object : MatrixCallback<T> {
         override fun onSuccess(data: T) {
-            it.onSuccess(data)
+            // Add `!!` to fix the warning:
+            // "Type mismatch: type parameter with nullable bounds is used T is used where T was expected. This warning will become an error soon"
+            emitter.onSuccess(data!!)
         }
 
         override fun onFailure(failure: Throwable) {
-            it.tryOnError(failure)
+            emitter.tryOnError(failure)
         }
     }
     val cancelable = builder(callback)
-    it.setCancellable {
+    emitter.setCancellable {
         cancelable.cancel()
     }
 }
 
-fun <T> completableBuilder(builder: (callback: MatrixCallback<T>) -> Cancelable): Completable = Completable.create {
+fun <T> completableBuilder(builder: (MatrixCallback<T>) -> Cancelable): Completable = Completable.create { emitter ->
-    val callback: MatrixCallback<T> = object : MatrixCallback<T> {
+    val callback = object : MatrixCallback<T> {
         override fun onSuccess(data: T) {
-            it.onComplete()
+            emitter.onComplete()
         }
 
         override fun onFailure(failure: Throwable) {
-            it.tryOnError(failure)
+            emitter.tryOnError(failure)
         }
     }
     val cancelable = builder(callback)
-    it.setCancellable {
+    emitter.setCancellable {
         cancelable.cancel()
     }
 }

matrix-sdk-android-rx/src/main/java/org/matrix/android/sdk/rx/RxRoom.kt

@@ -17,14 +17,20 @@
 package org.matrix.android.sdk.rx
 
 import android.net.Uri
+import io.reactivex.Completable
+import io.reactivex.Observable
+import io.reactivex.Single
+import kotlinx.coroutines.rx2.rxCompletable
 import org.matrix.android.sdk.api.query.QueryStringValue
 import org.matrix.android.sdk.api.session.events.model.Event
 import org.matrix.android.sdk.api.session.identity.ThreePid
 import org.matrix.android.sdk.api.session.room.Room
 import org.matrix.android.sdk.api.session.room.members.RoomMemberQueryParams
 import org.matrix.android.sdk.api.session.room.model.EventAnnotationsSummary
+import org.matrix.android.sdk.api.session.room.model.GuestAccess
 import org.matrix.android.sdk.api.session.room.model.ReadReceipt
 import org.matrix.android.sdk.api.session.room.model.RoomHistoryVisibility
+import org.matrix.android.sdk.api.session.room.model.RoomJoinRules
 import org.matrix.android.sdk.api.session.room.model.RoomMemberSummary
 import org.matrix.android.sdk.api.session.room.model.RoomSummary
 import org.matrix.android.sdk.api.session.room.notification.RoomNotificationState
@@ -32,9 +38,6 @@ import org.matrix.android.sdk.api.session.room.send.UserDraft
 import org.matrix.android.sdk.api.session.room.timeline.TimelineEvent
 import org.matrix.android.sdk.api.util.Optional
 import org.matrix.android.sdk.api.util.toOptional
-import io.reactivex.Completable
-import io.reactivex.Observable
-import io.reactivex.Single
 
 class RxRoom(private val room: Room) {
 
@@ -119,32 +122,28 @@ class RxRoom(private val room: Room) {
         room.invite3pid(threePid, it)
     }
 
-    fun updateTopic(topic: String): Completable = completableBuilder<Unit> {
+    fun updateTopic(topic: String): Completable = rxCompletable {
-        room.updateTopic(topic, it)
+        room.updateTopic(topic)
     }
 
-    fun updateName(name: String): Completable = completableBuilder<Unit> {
+    fun updateName(name: String): Completable = rxCompletable {
-        room.updateName(name, it)
+        room.updateName(name)
     }
 
-    fun addRoomAlias(alias: String): Completable = completableBuilder<Unit> {
+    fun updateHistoryReadability(readability: RoomHistoryVisibility): Completable = rxCompletable {
-        room.addRoomAlias(alias, it)
+        room.updateHistoryReadability(readability)
     }
 
-    fun updateCanonicalAlias(alias: String): Completable = completableBuilder<Unit> {
+    fun updateJoinRule(joinRules: RoomJoinRules?, guestAccess: GuestAccess?): Completable = rxCompletable {
-        room.updateCanonicalAlias(alias, it)
+        room.updateJoinRule(joinRules, guestAccess)
     }
 
-    fun updateHistoryReadability(readability: RoomHistoryVisibility): Completable = completableBuilder<Unit> {
+    fun updateAvatar(avatarUri: Uri, fileName: String): Completable = rxCompletable {
-        room.updateHistoryReadability(readability, it)
+        room.updateAvatar(avatarUri, fileName)
     }
 
-    fun updateAvatar(avatarUri: Uri, fileName: String): Completable = completableBuilder<Unit> {
+    fun deleteAvatar(): Completable = rxCompletable {
-        room.updateAvatar(avatarUri, fileName, it)
+        room.deleteAvatar()
-    }
-
-    fun deleteAvatar(): Completable = completableBuilder<Unit> {
-        room.deleteAvatar(it)
     }
 }
 

matrix-sdk-android-rx/src/main/java/org/matrix/android/sdk/rx/RxSession.kt

@@ -47,6 +47,7 @@ import org.matrix.android.sdk.api.util.toOptional
 import org.matrix.android.sdk.internal.crypto.model.CryptoDeviceInfo
 import org.matrix.android.sdk.internal.crypto.model.rest.DeviceInfo
 import org.matrix.android.sdk.internal.crypto.store.PrivateKeysInfo
+import org.matrix.android.sdk.internal.session.room.alias.RoomAliasDescription
 
 class RxSession(private val session: Session) {
 
@@ -139,7 +140,7 @@ class RxSession(private val session: Session) {
     }
 
     fun getRoomIdByAlias(roomAlias: String,
-                         searchOnServer: Boolean): Single<Optional<String>> = singleBuilder {
+                         searchOnServer: Boolean): Single<Optional<RoomAliasDescription>> = singleBuilder {
         session.getRoomIdByAlias(roomAlias, searchOnServer, it)
     }
 

matrix-sdk-android/build.gradle

@@ -9,7 +9,7 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath "io.realm:realm-gradle-plugin:10.0.0"
+        classpath "io.realm:realm-gradle-plugin:10.1.2"
     }
 }
 
@@ -63,7 +63,7 @@ android {
 
         release {
             buildConfigField "boolean", "LOG_PRIVATE_DATA", "false"
-            buildConfigField "okhttp3.logging.HttpLoggingInterceptor.Level", "OKHTTP_LOGGING_LEVEL", "okhttp3.logging.HttpLoggingInterceptor.Level.NONE"
+            buildConfigField "okhttp3.logging.HttpLoggingInterceptor.Level", "OKHTTP_LOGGING_LEVEL", "okhttp3.logging.HttpLoggingInterceptor.Level.BASIC"
         }
     }
 
@@ -125,7 +125,6 @@ dependencies {
     implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$kotlin_coroutines_version"
 
     implementation "androidx.appcompat:appcompat:1.2.0"
-    implementation "androidx.fragment:fragment:1.3.0-beta01"
     implementation "androidx.core:core-ktx:1.3.2"
 
     implementation "androidx.lifecycle:lifecycle-extensions:$lifecycle_version"
@@ -146,7 +145,7 @@ dependencies {
     implementation "ru.noties.markwon:core:$markwon_version"
 
     // Image
-    implementation 'androidx.exifinterface:exifinterface:1.3.0'
+    implementation 'androidx.exifinterface:exifinterface:1.3.1'
 
     // Database
     implementation 'com.github.Zhuinden:realm-monarchy:0.7.1'

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/api/Matrix.kt

@@ -25,6 +25,7 @@ import androidx.work.WorkManager
 import com.zhuinden.monarchy.Monarchy
 import org.matrix.android.sdk.BuildConfig
 import org.matrix.android.sdk.api.auth.AuthenticationService
+import org.matrix.android.sdk.api.auth.HomeServerHistoryService
 import org.matrix.android.sdk.api.legacy.LegacySessionImporter
 import org.matrix.android.sdk.api.raw.RawService
 import org.matrix.android.sdk.common.DaggerTestMatrixComponent
@@ -49,6 +50,7 @@ class Matrix private constructor(context: Context, matrixConfiguration: MatrixCo
     @Inject internal lateinit var backgroundDetectionObserver: BackgroundDetectionObserver
     @Inject internal lateinit var olmManager: OlmManager
     @Inject internal lateinit var sessionManager: SessionManager
+    @Inject internal lateinit var homeServerHistoryService: HomeServerHistoryService
 
     private val uiHandler = Handler(Looper.getMainLooper())
 
@@ -71,6 +73,8 @@ class Matrix private constructor(context: Context, matrixConfiguration: MatrixCo
 
     fun rawService() = rawService
 
+    fun homeServerHistoryService() = homeServerHistoryService
+
     fun legacySessionImporter(): LegacySessionImporter {
         return legacySessionImporter
     }

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/internal/crypto/encryption/EncryptionTest.kt

@@ -17,13 +17,13 @@
 package org.matrix.android.sdk.internal.crypto.encryption
 
 import androidx.test.ext.junit.runners.AndroidJUnit4
+import kotlinx.coroutines.runBlocking
 import org.amshove.kluent.shouldBe
 import org.junit.FixMethodOrder
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.junit.runners.MethodSorters
 import org.matrix.android.sdk.InstrumentedTest
-import org.matrix.android.sdk.api.NoOpMatrixCallback
 import org.matrix.android.sdk.api.session.events.model.EventType
 import org.matrix.android.sdk.api.session.events.model.toContent
 import org.matrix.android.sdk.api.session.room.Room
@@ -57,13 +57,14 @@ class EncryptionTest : InstrumentedTest {
     @Test
     fun test_EncryptionStateEvent() {
         performTest(roomShouldBeEncrypted = true) { room ->
-            // Send an encryption Event as a State Event
+            runBlocking {
-            room.sendStateEvent(
+                // Send an encryption Event as a State Event
-                    eventType = EventType.STATE_ROOM_ENCRYPTION,
+                room.sendStateEvent(
-                    stateKey = null,
+                        eventType = EventType.STATE_ROOM_ENCRYPTION,
-                    body = EncryptionEventContent(algorithm = MXCRYPTO_ALGORITHM_MEGOLM).toContent(),
+                        stateKey = null,
-                    callback = NoOpMatrixCallback()
+                        body = EncryptionEventContent(algorithm = MXCRYPTO_ALGORITHM_MEGOLM).toContent()
-            )
+                )
+            }
         }
     }
 

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/internal/crypto/keysbackup/KeysBackupTest.kt

@@ -264,7 +264,7 @@ class KeysBackupTest : InstrumentedTest {
         assertNotNull(decryption)
         // - Check decryptKeyBackupData() returns stg
         val sessionData = keysBackup
-                .decryptKeyBackupData(keyBackupData!!,
+                .decryptKeyBackupData(keyBackupData,
                         session.olmInboundGroupSession!!.sessionIdentifier(),
                         cryptoTestData.roomId,
                         decryption!!)

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/internal/crypto/keysbackup/KeysBackupTestHelper.kt

@@ -111,7 +111,7 @@ class KeysBackupTestHelper(
         Assert.assertTrue(keysBackup.isEnabled)
 
         stateObserver.stopAndCheckStates(null)
-        return PrepareKeysBackupDataResult(megolmBackupCreationInfo, keysVersion.version!!)
+        return PrepareKeysBackupDataResult(megolmBackupCreationInfo, keysVersion.version)
     }
 
     /**

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/internal/session/media/UrlsExtractorTest.kt

@@ -0,0 +1,108 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.session.media
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import org.amshove.kluent.shouldBeEqualTo
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.matrix.android.sdk.InstrumentedTest
+import org.matrix.android.sdk.api.session.events.model.Event
+import org.matrix.android.sdk.api.session.events.model.EventType
+import org.matrix.android.sdk.api.session.events.model.toContent
+import org.matrix.android.sdk.api.session.room.model.message.MessageTextContent
+import org.matrix.android.sdk.api.session.room.model.message.MessageType
+
+@RunWith(AndroidJUnit4::class)
+internal class UrlsExtractorTest : InstrumentedTest {
+
+    private val urlsExtractor = UrlsExtractor()
+
+    @Test
+    fun wrongEventTypeTest() {
+        createEvent(body = "https://matrix.org")
+                .copy(type = EventType.STATE_ROOM_GUEST_ACCESS)
+                .let { urlsExtractor.extract(it) }
+                .size shouldBeEqualTo 0
+    }
+
+    @Test
+    fun oneUrlTest() {
+        createEvent(body = "https://matrix.org")
+                .let { urlsExtractor.extract(it) }
+                .let { result ->
+                    result.size shouldBeEqualTo 1
+                    result[0] shouldBeEqualTo "https://matrix.org"
+                }
+    }
+
+    @Test
+    fun withoutProtocolTest() {
+        createEvent(body = "www.matrix.org")
+                .let { urlsExtractor.extract(it) }
+                .size shouldBeEqualTo 0
+    }
+
+    @Test
+    fun oneUrlWithParamTest() {
+        createEvent(body = "https://matrix.org?foo=bar")
+                .let { urlsExtractor.extract(it) }
+                .let { result ->
+                    result.size shouldBeEqualTo 1
+                    result[0] shouldBeEqualTo "https://matrix.org?foo=bar"
+                }
+    }
+
+    @Test
+    fun oneUrlWithParamsTest() {
+        createEvent(body = "https://matrix.org?foo=bar&bar=foo")
+                .let { urlsExtractor.extract(it) }
+                .let { result ->
+                    result.size shouldBeEqualTo 1
+                    result[0] shouldBeEqualTo "https://matrix.org?foo=bar&bar=foo"
+                }
+    }
+
+    @Test
+    fun oneUrlInlinedTest() {
+        createEvent(body = "Hello https://matrix.org, how are you?")
+                .let { urlsExtractor.extract(it) }
+                .let { result ->
+                    result.size shouldBeEqualTo 1
+                    result[0] shouldBeEqualTo  "https://matrix.org"
+                }
+    }
+
+    @Test
+    fun twoUrlsTest() {
+        createEvent(body = "https://matrix.org https://example.org")
+                .let { urlsExtractor.extract(it) }
+                .let { result ->
+                    result.size shouldBeEqualTo 2
+                    result[0] shouldBeEqualTo "https://matrix.org"
+                    result[1] shouldBeEqualTo "https://example.org"
+                }
+    }
+
+    private fun createEvent(body: String): Event = Event(
+            type = EventType.MESSAGE,
+            content = MessageTextContent(
+                    msgType = MessageType.MSGTYPE_TEXT,
+                    body = body
+            ).toContent()
+    )
+}

matrix-sdk-android/src/debug/java/org/matrix/android/sdk/internal/network/interceptors/FormattedJsonHttpLogger.kt

@@ -17,7 +17,6 @@
 package org.matrix.android.sdk.internal.network.interceptors
 
 import androidx.annotation.NonNull
-import org.matrix.android.sdk.BuildConfig
 import okhttp3.logging.HttpLoggingInterceptor
 import org.json.JSONArray
 import org.json.JSONException
@@ -38,31 +37,28 @@ class FormattedJsonHttpLogger : HttpLoggingInterceptor.Logger {
      */
     @Synchronized
     override fun log(@NonNull message: String) {
-        // In RELEASE there is no log, but for sure, test again BuildConfig.DEBUG
+        Timber.v(message)
-        if (BuildConfig.DEBUG) {
-            Timber.v(message)
 
-            if (message.startsWith("{")) {
+        if (message.startsWith("{")) {
-                // JSON Detected
+            // JSON Detected
-                try {
+            try {
-                    val o = JSONObject(message)
+                val o = JSONObject(message)
-                    logJson(o.toString(INDENT_SPACE))
+                logJson(o.toString(INDENT_SPACE))
-                } catch (e: JSONException) {
+            } catch (e: JSONException) {
-                    // Finally this is not a JSON string...
+                // Finally this is not a JSON string...
-                    Timber.e(e)
+                Timber.e(e)
-                }
+            }
-            } else if (message.startsWith("[")) {
+        } else if (message.startsWith("[")) {
-                // JSON Array detected
+            // JSON Array detected
-                try {
+            try {
-                    val o = JSONArray(message)
+                val o = JSONArray(message)
-                    logJson(o.toString(INDENT_SPACE))
+                logJson(o.toString(INDENT_SPACE))
-                } catch (e: JSONException) {
+            } catch (e: JSONException) {
-                    // Finally not JSON...
+                // Finally not JSON...
-                    Timber.e(e)
+                Timber.e(e)
-                }
             }
-            // Else not a json string to log
         }
+        // Else not a json string to log
     }
 
     private fun logJson(formattedJson: String) {

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/Matrix.kt

@@ -23,6 +23,7 @@ import androidx.work.WorkManager
 import com.zhuinden.monarchy.Monarchy
 import org.matrix.android.sdk.BuildConfig
 import org.matrix.android.sdk.api.auth.AuthenticationService
+import org.matrix.android.sdk.api.auth.HomeServerHistoryService
 import org.matrix.android.sdk.api.legacy.LegacySessionImporter
 import org.matrix.android.sdk.api.raw.RawService
 import org.matrix.android.sdk.internal.SessionManager
@@ -47,6 +48,7 @@ class Matrix private constructor(context: Context, matrixConfiguration: MatrixCo
     @Inject internal lateinit var backgroundDetectionObserver: BackgroundDetectionObserver
     @Inject internal lateinit var olmManager: OlmManager
     @Inject internal lateinit var sessionManager: SessionManager
+    @Inject internal lateinit var homeServerHistoryService: HomeServerHistoryService
 
     init {
         Monarchy.init(context)
@@ -65,6 +67,8 @@ class Matrix private constructor(context: Context, matrixConfiguration: MatrixCo
 
     fun rawService() = rawService
 
+    fun homeServerHistoryService() = homeServerHistoryService
+
     fun legacySessionImporter(): LegacySessionImporter {
         return legacySessionImporter
     }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/auth/Constants.kt

@@ -19,7 +19,7 @@ package org.matrix.android.sdk.api.auth
 /**
  * Path to use when the client does not supported any or all login flows
  * Ref: https://matrix.org/docs/spec/client_server/latest#login-fallback
- * */
+ */
 const val LOGIN_FALLBACK_PATH = "/_matrix/static/client/login/"
 
 /**

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/auth/HomeServerHistoryService.kt

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.api.auth
+
+/**
+ * A simple service to remember homeservers you already connected to.
+ */
+interface HomeServerHistoryService {
+
+    fun getKnownServersUrls(): List<String>
+
+    fun addHomeServerToHistory(url: String)
+
+    fun clearHistory()
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/auth/data/LoginFlowResult.kt

@@ -19,6 +19,7 @@ package org.matrix.android.sdk.api.auth.data
 sealed class LoginFlowResult {
     data class Success(
             val supportedLoginTypes: List<String>,
+            val ssoIdentityProviders: List<SsoIdentityProvider>?,
             val isLoginAndRegistrationSupported: Boolean,
             val homeServerUrl: String,
             val isOutdatedHomeserver: Boolean

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/auth/data/SsoIdentityProvider.kt

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.api.auth.data
+
+import android.os.Parcelable
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import kotlinx.android.parcel.Parcelize
+
+@JsonClass(generateAdapter = true)
+@Parcelize
+data class SsoIdentityProvider(
+        /**
+         * The id field would be opaque with the accepted characters matching unreserved URI characters as defined in RFC3986
+         * - this was chosen to avoid having to encode special characters in the URL. Max length 128.
+         */
+        @Json(name = "id") val id: String,
+        /**
+         * The name field should be the human readable string intended for printing by the client.
+         */
+        @Json(name = "name") val name: String?,
+        /**
+         * The icon field is the only optional field and should point to an icon representing the IdP.
+         * If present then it must be an HTTPS URL to an image resource.
+         * This should be hosted by the homeserver service provider to not leak the client's IP address unnecessarily.
+         */
+        @Json(name = "icon") val iconUrl: String?
+) : Parcelable {
+
+    companion object {
+        // Not really defined by the spec, but we may define some ids here
+        const val ID_GOOGLE = "google"
+        const val ID_GITHUB = "github"
+        const val ID_APPLE = "apple"
+        const val ID_FACEBOOK = "facebook"
+        const val ID_TWITTER = "twitter"
+    }
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/cache/CacheStrategy.kt

@@ -14,16 +14,16 @@
  * limitations under the License.
  */
 
-package org.matrix.android.sdk.api.raw
+package org.matrix.android.sdk.api.cache
 
-sealed class RawCacheStrategy {
+sealed class CacheStrategy {
     // Data is always fetched from the server
-    object NoCache : RawCacheStrategy()
+    object NoCache : CacheStrategy()
 
     // Once data is retrieved, it is stored for the provided amount of time.
     // In case of error, and if strict is set to false, the cache can be returned if available
-    data class TtlCache(val validityDurationInMillis: Long, val strict: Boolean) : RawCacheStrategy()
+    data class TtlCache(val validityDurationInMillis: Long, val strict: Boolean) : CacheStrategy()
 
     // Once retrieved, the data is stored in cache and will be always get from the cache
-    object InfiniteCache : RawCacheStrategy()
+    object InfiniteCache : CacheStrategy()
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/raw/RawService.kt

@@ -16,6 +16,8 @@
 
 package org.matrix.android.sdk.api.raw
 
+import org.matrix.android.sdk.api.cache.CacheStrategy
+
 /**
  * Useful methods to fetch raw data from the server. The access token will not be used to fetched the data
  */
@@ -23,7 +25,7 @@ interface RawService {
     /**
      * Get a URL, either from cache or from the remote server, depending on the cache strategy
      */
-    suspend fun getUrl(url: String, rawCacheStrategy: RawCacheStrategy): String
+    suspend fun getUrl(url: String, cacheStrategy: CacheStrategy): String
 
     /**
      * Specific case for the well-known file. Cache validity is 8 hours

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

@@ -35,6 +35,7 @@ import org.matrix.android.sdk.api.session.group.GroupService
 import org.matrix.android.sdk.api.session.homeserver.HomeServerCapabilitiesService
 import org.matrix.android.sdk.api.session.identity.IdentityService
 import org.matrix.android.sdk.api.session.integrationmanager.IntegrationManagerService
+import org.matrix.android.sdk.api.session.media.MediaService
 import org.matrix.android.sdk.api.session.permalinks.PermalinkService
 import org.matrix.android.sdk.api.session.profile.ProfileService
 import org.matrix.android.sdk.api.session.pushers.PushersService
@@ -181,6 +182,11 @@ interface Session :
      */
     fun widgetService(): WidgetService
 
+    /**
+     * Returns the media service associated with the session
+     */
+    fun mediaService(): MediaService
+
     /**
      * Returns the integration manager service associated with the session
      */

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/call/CallState.kt

@@ -36,7 +36,7 @@ sealed class CallState {
      * Connected. Incoming/Outgoing call, ice layer connecting or connected
      * Notice that the PeerState failed is not always final, if you switch network, new ice candidtates
      * could be exchanged, and the connection could go back to connected
-     * */
+     */
     data class Connected(val iceConnectionState: PeerConnection.PeerConnectionState) : CallState()
 
     /** Terminated.  Incoming/Outgoing call, the call is terminated */

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/content/ContentAttachmentData.kt

@@ -21,6 +21,7 @@ import android.os.Parcelable
 import androidx.exifinterface.media.ExifInterface
 import com.squareup.moshi.JsonClass
 import kotlinx.android.parcel.Parcelize
+import org.matrix.android.sdk.api.util.MimeTypes.normalizeMimeType
 
 @Parcelize
 @JsonClass(generateAdapter = true)
@@ -45,5 +46,5 @@ data class ContentAttachmentData(
         VIDEO
     }
 
-    fun getSafeMimeType() = if (mimeType == "image/jpg") "image/jpeg" else mimeType
+    fun getSafeMimeType() = mimeType?.normalizeMimeType()
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/events/model/EventType.kt

@@ -50,6 +50,12 @@ object EventType {
     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"
+
+    /**
+     * Note that this Event has been deprecated, see
+     * - https://matrix.org/docs/spec/client_server/r0.6.1#historical-events
+     * - https://github.com/matrix-org/matrix-doc/pull/2432
+     */
     const val STATE_ROOM_ALIASES = "m.room.aliases"
     const val STATE_ROOM_TOMBSTONE = "m.room.tombstone"
     const val STATE_ROOM_CANONICAL_ALIAS = "m.room.canonical_alias"

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/file/FileService.kt

@@ -18,8 +18,12 @@ package org.matrix.android.sdk.api.session.file
 
 import android.net.Uri
 import org.matrix.android.sdk.api.MatrixCallback
+import org.matrix.android.sdk.api.session.room.model.message.MessageWithAttachmentContent
+import org.matrix.android.sdk.api.session.room.model.message.getFileName
+import org.matrix.android.sdk.api.session.room.model.message.getFileUrl
 import org.matrix.android.sdk.api.util.Cancelable
 import org.matrix.android.sdk.internal.crypto.attachments.ElementToDecrypt
+import org.matrix.android.sdk.internal.crypto.attachments.toElementToDecrypt
 import java.io.File
 
 /**
@@ -27,23 +31,6 @@ import java.io.File
  */
 interface FileService {
 
-    enum class DownloadMode {
-        /**
-         * Download file in external storage
-         */
-        TO_EXPORT,
-
-        /**
-         * Download file in cache
-         */
-        FOR_INTERNAL_USE,
-
-        /**
-         * Download file in file provider path
-         */
-        FOR_EXTERNAL_SHARE
-    }
-
     enum class FileState {
         IN_CACHE,
         DOWNLOADING,
@@ -54,34 +41,79 @@ interface FileService {
      * Download a file.
      * Result will be a decrypted file, stored in the cache folder. url parameter will be used to create unique filename to avoid name collision.
      */
-    fun downloadFile(
+    fun downloadFile(fileName: String,
-            downloadMode: DownloadMode,
+                     mimeType: String?,
-            id: String,
+                     url: String?,
-            fileName: String,
+                     elementToDecrypt: ElementToDecrypt?,
-            mimeType: String?,
+                     callback: MatrixCallback<File>): Cancelable
-            url: String?,
-            elementToDecrypt: ElementToDecrypt?,
-            callback: MatrixCallback<File>): Cancelable
 
-    fun isFileInCache(mxcUrl: String, mimeType: String?): Boolean
+    fun downloadFile(messageContent: MessageWithAttachmentContent,
+                     callback: MatrixCallback<File>): Cancelable =
+            downloadFile(
+                    fileName = messageContent.getFileName(),
+                    mimeType = messageContent.mimeType,
+                    url = messageContent.getFileUrl(),
+                    elementToDecrypt = messageContent.encryptedFileInfo?.toElementToDecrypt(),
+                    callback = callback
+            )
+
+    fun isFileInCache(mxcUrl: String?,
+                      fileName: String,
+                      mimeType: String?,
+                      elementToDecrypt: ElementToDecrypt?
+    ): Boolean
+
+    fun isFileInCache(messageContent: MessageWithAttachmentContent) =
+            isFileInCache(
+                    mxcUrl = messageContent.getFileUrl(),
+                    fileName = messageContent.getFileName(),
+                    mimeType = messageContent.mimeType,
+                    elementToDecrypt = messageContent.encryptedFileInfo?.toElementToDecrypt())
 
     /**
      * Use this URI and pass it to intent using flag Intent.FLAG_GRANT_READ_URI_PERMISSION
      * (if not other app won't be able to access it)
      */
-    fun getTemporarySharableURI(mxcUrl: String, mimeType: String?): Uri?
+    fun getTemporarySharableURI(mxcUrl: String?,
+                                fileName: String,
+                                mimeType: String?,
+                                elementToDecrypt: ElementToDecrypt?): Uri?
+
+    fun getTemporarySharableURI(messageContent: MessageWithAttachmentContent): Uri? =
+            getTemporarySharableURI(
+                    mxcUrl = messageContent.getFileUrl(),
+                    fileName = messageContent.getFileName(),
+                    mimeType = messageContent.mimeType,
+                    elementToDecrypt = messageContent.encryptedFileInfo?.toElementToDecrypt()
+            )
 
     /**
      * Get information on the given file.
      * Mimetype should be the same one as passed to downloadFile (limitation for now)
      */
-    fun fileState(mxcUrl: String, mimeType: String?): FileState
+    fun fileState(mxcUrl: String?,
+                  fileName: String,
+                  mimeType: String?,
+                  elementToDecrypt: ElementToDecrypt?): FileState
+
+    fun fileState(messageContent: MessageWithAttachmentContent): FileState =
+            fileState(
+                    mxcUrl = messageContent.getFileUrl(),
+                    fileName = messageContent.getFileName(),
+                    mimeType = messageContent.mimeType,
+                    elementToDecrypt = messageContent.encryptedFileInfo?.toElementToDecrypt()
+            )
 
     /**
-     * Clears all the files downloaded by the service
+     * Clears all the files downloaded by the service, including decrypted files
      */
     fun clearCache()
 
+    /**
+     * Clears all the decrypted files by the service
+     */
+    fun clearDecryptedCache()
+
     /**
      * Get size of cached files
      */

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/integrationmanager/IntegrationManagerService.kt

@@ -16,9 +16,6 @@
 
 package org.matrix.android.sdk.api.session.integrationmanager
 
-import org.matrix.android.sdk.api.MatrixCallback
-import org.matrix.android.sdk.api.util.Cancelable
-
 /**
  * This is the entry point to manage integration. You can grab an instance of this service through an active session.
  */
@@ -80,19 +77,17 @@ interface IntegrationManagerService {
     /**
      * Offers to enable or disable the integration.
      * @param enable the param to change
-     * @param callback the matrix callback to listen for result.
      * @return Cancelable
      */
-    fun setIntegrationEnabled(enable: Boolean, callback: MatrixCallback<Unit>): Cancelable
+    suspend fun setIntegrationEnabled(enable: Boolean)
 
     /**
      * Offers to allow or disallow a widget.
      * @param stateEventId the eventId of the state event defining the widget.
      * @param allowed the param to change
-     * @param callback the matrix callback to listen for result.
      * @return Cancelable
      */
-    fun setWidgetAllowed(stateEventId: String, allowed: Boolean, callback: MatrixCallback<Unit>): Cancelable
+    suspend fun setWidgetAllowed(stateEventId: String, allowed: Boolean)
 
     /**
      * Returns true if the widget is allowed, false otherwise.
@@ -105,7 +100,7 @@ interface IntegrationManagerService {
      * @param widgetType the widget type to check for
      * @param domain the domain to check for
      */
-    fun setNativeWidgetDomainAllowed(widgetType: String, domain: String, allowed: Boolean, callback: MatrixCallback<Unit>): Cancelable
+    suspend fun setNativeWidgetDomainAllowed(widgetType: String, domain: String, allowed: Boolean)
 
     /**
      * Returns true if the widget domain is allowed, false otherwise.

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/media/MediaService.kt

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.api.session.media
+
+import org.matrix.android.sdk.api.cache.CacheStrategy
+import org.matrix.android.sdk.api.session.events.model.Event
+import org.matrix.android.sdk.api.util.JsonDict
+
+interface MediaService {
+    /**
+     * Extract URLs from an Event.
+     * @return the list of URLs contains in the body of the Event. It does not mean that URLs in this list have UrlPreview data
+     */
+    fun extractUrls(event: Event): List<String>
+
+    /**
+     * Get Raw Url Preview data from the homeserver. There is no cache management for this request
+     * @param url The url to get the preview data from
+     * @param timestamp The optional timestamp
+     */
+    suspend fun getRawPreviewUrl(url: String, timestamp: Long?): JsonDict
+
+    /**
+     * Get Url Preview data from the homeserver, or from cache, depending on the cache strategy
+     * @param url The url to get the preview data from
+     * @param timestamp The optional timestamp. Note that this parameter is not taken into account
+     * if the data is already in cache and the cache strategy allow to use it
+     * @param cacheStrategy the cache strategy, see the type for more details
+     */
+    suspend fun getPreviewUrl(url: String, timestamp: Long?, cacheStrategy: CacheStrategy): PreviewUrlData
+
+    /**
+     * Clear the cache of all retrieved UrlPreview data
+     */
+    suspend fun clearCache()
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/media/PreviewUrlData.kt

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.api.session.media
+
+/**
+ * Facility data class to get the common field of a PreviewUrl response form the server
+ *
+ * Example of return data for the url `https://matrix.org`:
+ * <pre>
+ * {
+ *     "matrix:image:size": 112805,
+ *     "og:description": "Matrix is an open standard for interoperable, decentralised, real-time communication",
+ *     "og:image": "mxc://matrix.org/2020-12-03_uFqjagCCTJbaaJxb",
+ *     "og:image:alt": "Matrix is an open standard for interoperable, decentralised, real-time communication",
+ *     "og:image:height": 467,
+ *     "og:image:type": "image/jpeg",
+ *     "og:image:width": 911,
+ *     "og:locale": "en_US",
+ *     "og:site_name": "Matrix.org",
+ *     "og:title": "Matrix.org",
+ *     "og:type": "website",
+ *     "og:url": "https://matrix.org"
+ * }
+ * </pre>
+ */
+data class PreviewUrlData(
+        // Value of field "og:url". If not provided, this is the value passed in parameter
+        val url: String,
+        // Value of field "og:site_name"
+        val siteName: String?,
+        // Value of field "og:title"
+        val title: String?,
+        // Value of field "og:description"
+        val description: String?,
+        // Value of field "og:image"
+        val mxcUrl: String?
+)

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/permalinks/PermalinkService.kt

@@ -25,6 +25,7 @@ interface PermalinkService {
 
     companion object {
         const val MATRIX_TO_URL_BASE = "https://matrix.to/#/"
+        const val MATRIX_TO_CUSTOM_SCHEME_URL_BASE = "element://"
     }
 
     /**

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

@@ -18,6 +18,7 @@ package org.matrix.android.sdk.api.session.room
 
 import androidx.lifecycle.LiveData
 import org.matrix.android.sdk.api.MatrixCallback
+import org.matrix.android.sdk.api.session.room.alias.AliasService
 import org.matrix.android.sdk.api.session.room.call.RoomCallService
 import org.matrix.android.sdk.api.session.room.crypto.RoomCryptoService
 import org.matrix.android.sdk.api.session.room.members.MembershipService
@@ -46,6 +47,7 @@ interface Room :
         DraftService,
         ReadService,
         TypingService,
+        AliasService,
         TagsService,
         MembershipService,
         StateService,

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

@@ -17,6 +17,7 @@
 package org.matrix.android.sdk.api.session.room
 
 import org.matrix.android.sdk.api.MatrixCallback
+import org.matrix.android.sdk.api.session.room.model.RoomDirectoryVisibility
 import org.matrix.android.sdk.api.session.room.model.roomdirectory.PublicRoomsParams
 import org.matrix.android.sdk.api.session.room.model.roomdirectory.PublicRoomsResponse
 import org.matrix.android.sdk.api.session.room.model.thirdparty.ThirdPartyProtocol
@@ -39,4 +40,14 @@ interface RoomDirectoryService {
      * Includes both the available protocols and all fields required for queries against each protocol.
      */
     fun getThirdPartyProtocol(callback: MatrixCallback<Map<String, ThirdPartyProtocol>>): Cancelable
+
+    /**
+     * Get the visibility of a room in the directory
+     */
+    suspend fun getRoomDirectoryVisibility(roomId: String): RoomDirectoryVisibility
+
+    /**
+     * Set the visibility of a room in the directory
+     */
+    suspend fun setRoomDirectoryVisibility(roomId: String, roomDirectoryVisibility: RoomDirectoryVisibility)
 }

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

@@ -18,12 +18,15 @@ package org.matrix.android.sdk.api.session.room
 
 import androidx.lifecycle.LiveData
 import org.matrix.android.sdk.api.MatrixCallback
+import org.matrix.android.sdk.api.session.events.model.Event
 import org.matrix.android.sdk.api.session.room.members.ChangeMembershipState
 import org.matrix.android.sdk.api.session.room.model.RoomMemberSummary
 import org.matrix.android.sdk.api.session.room.model.RoomSummary
 import org.matrix.android.sdk.api.session.room.model.create.CreateRoomParams
+import org.matrix.android.sdk.api.session.room.peeking.PeekResult
 import org.matrix.android.sdk.api.util.Cancelable
 import org.matrix.android.sdk.api.util.Optional
+import org.matrix.android.sdk.internal.session.room.alias.RoomAliasDescription
 
 /**
  * This interface defines methods to get rooms. It's implemented at the session level.
@@ -120,7 +123,12 @@ interface RoomService {
      */
     fun getRoomIdByAlias(roomAlias: String,
                          searchOnServer: Boolean,
-                         callback: MatrixCallback<Optional<String>>): Cancelable
+                         callback: MatrixCallback<Optional<RoomAliasDescription>>): Cancelable
+
+    /**
+     * Delete a room alias
+     */
+    suspend fun deleteRoomAlias(roomAlias: String)
 
     /**
      * Return a live data of all local changes membership that happened since the session has been opened.
@@ -158,4 +166,16 @@ interface RoomService {
      * @return a LiveData of the optional found room member
      */
     fun getRoomMemberLive(userId: String, roomId: String): LiveData<Optional<RoomMemberSummary>>
+
+    /**
+     * Get some state events about a room
+     */
+    fun getRoomState(roomId: String, callback: MatrixCallback<List<Event>>)
+
+    /**
+     * Use this if you want to get information from a room that you are not yet in (or invited)
+     * It might be possible to get some information on this room if it is public or if guest access is allowed
+     * This call will try to gather some information on this room, but it could fail and get nothing more
+     */
+    fun peekRoom(roomIdOrAlias: String, callback: MatrixCallback<PeekResult>)
 }

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

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.api.session.room.alias
+
+interface AliasService {
+    /**
+     * Get list of local alias of the room
+     * @return the list of the aliases (full aliases, not only the local part)
+     */
+    suspend fun getRoomAliases(): List<String>
+
+    /**
+     * Add local alias to the room
+     * @param aliasLocalPart the local part of the alias.
+     * Ex: for the alias "#my_alias:example.org", the local part is "my_alias"
+     */
+    suspend fun addAlias(aliasLocalPart: String)
+}

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

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.api.session.room.alias
+
+sealed class RoomAliasError : Throwable() {
+    object AliasEmpty : RoomAliasError()
+    object AliasNotAvailable : RoomAliasError()
+    object AliasInvalid : RoomAliasError()
+}

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

@@ -18,13 +18,10 @@ package org.matrix.android.sdk.api.session.room.failure
 
 import org.matrix.android.sdk.api.failure.Failure
 import org.matrix.android.sdk.api.failure.MatrixError
+import org.matrix.android.sdk.api.session.room.alias.RoomAliasError
 
 sealed class CreateRoomFailure : Failure.FeatureFailure() {
     object CreatedWithTimeout : CreateRoomFailure()
     data class CreatedWithFederationFailure(val matrixError: MatrixError) : CreateRoomFailure()
-    sealed class RoomAliasError : CreateRoomFailure() {
+    data class AliasError(val aliasError: RoomAliasError) : CreateRoomFailure()
-        object AliasEmpty : RoomAliasError()
-        object AliasNotAvailable : RoomAliasError()
-        object AliasInvalid : RoomAliasError()
-    }
 }

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

@@ -21,6 +21,9 @@ import com.squareup.moshi.JsonClass
 
 /**
  * Class representing the EventType.STATE_ROOM_ALIASES state event content
+ * Note that this Event has been deprecated, see
+ * - https://matrix.org/docs/spec/client_server/r0.6.1#historical-events
+ * - https://github.com/matrix-org/matrix-doc/pull/2432
  */
 @JsonClass(generateAdapter = true)
 data class RoomAliasesContent(

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

@@ -24,5 +24,14 @@ import com.squareup.moshi.JsonClass
  */
 @JsonClass(generateAdapter = true)
 data class RoomCanonicalAliasContent(
-        @Json(name = "alias") val canonicalAlias: String? = null
+        /**
+         * The canonical alias for the room. If not present, null, or empty the room should be considered to have no canonical alias.
+         */
+        @Json(name = "alias") val canonicalAlias: String? = null,
+
+        /**
+         * Alternative aliases the room advertises.
+         * This list can have aliases despite the alias field being null, empty, or otherwise not present.
+         */
+        @Json(name = "alt_aliases") val alternativeAliases: List<String>? = null
 )

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/MessageImageContent.kt

@@ -20,6 +20,7 @@ import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
 import org.matrix.android.sdk.api.session.events.model.Content
 import org.matrix.android.sdk.api.session.room.model.relation.RelationDefaultContent
+import org.matrix.android.sdk.api.util.MimeTypes
 import org.matrix.android.sdk.internal.crypto.model.rest.EncryptedFileInfo
 
 @JsonClass(generateAdapter = true)
@@ -54,5 +55,5 @@ data class MessageImageContent(
         @Json(name = "file") override val encryptedFileInfo: EncryptedFileInfo? = null
 ) : MessageImageInfoContent {
     override val mimeType: String?
-        get() = encryptedFileInfo?.mimetype ?: info?.mimeType ?: "image/*"
+        get() = encryptedFileInfo?.mimetype ?: info?.mimeType ?: MimeTypes.Images
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/MessageType.kt

@@ -33,4 +33,7 @@ object MessageType {
     // 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"
+
+    const val MSGTYPE_CONFETTI = "nic.custom.confetti"
+    const val MSGTYPE_SNOW = "nic.custom.snow"
 }

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

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.api.session.room.peeking
+
+sealed class PeekResult {
+    data class Success(
+            val roomId: String,
+            val alias: String?,
+            val name: String?,
+            val topic: String?,
+            val avatarUrl: String?,
+            val numJoinedMembers: Int?,
+            val viaServers: List<String>
+    ) : PeekResult()
+
+    data class PeekingNotAllowed(
+            val roomId: String,
+            val alias: String?,
+            val viaServers: List<String>
+    ) : PeekResult()
+
+    object UnknownAlias : PeekResult()
+}

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

@@ -18,11 +18,11 @@ package org.matrix.android.sdk.api.session.room.state
 
 import android.net.Uri
 import androidx.lifecycle.LiveData
-import org.matrix.android.sdk.api.MatrixCallback
 import org.matrix.android.sdk.api.query.QueryStringValue
 import org.matrix.android.sdk.api.session.events.model.Event
+import org.matrix.android.sdk.api.session.room.model.GuestAccess
 import org.matrix.android.sdk.api.session.room.model.RoomHistoryVisibility
-import org.matrix.android.sdk.api.util.Cancelable
+import org.matrix.android.sdk.api.session.room.model.RoomJoinRules
 import org.matrix.android.sdk.api.util.JsonDict
 import org.matrix.android.sdk.api.util.Optional
 
@@ -31,39 +31,41 @@ interface StateService {
     /**
      * Update the topic of the room
      */
-    fun updateTopic(topic: String, callback: MatrixCallback<Unit>): Cancelable
+    suspend fun updateTopic(topic: String)
 
     /**
      * Update the name of the room
      */
-    fun updateName(name: String, callback: MatrixCallback<Unit>): Cancelable
+    suspend fun updateName(name: String)
-
-    /**
-     * Add new alias to the room.
-     */
-    fun addRoomAlias(roomAlias: String, callback: MatrixCallback<Unit>): Cancelable
 
     /**
      * Update the canonical alias of the room
+     * @param alias the canonical alias, or null to reset the canonical alias of this room
+     * @param altAliases the alternative aliases for this room. It should include the canonical alias if any.
      */
-    fun updateCanonicalAlias(alias: String, callback: MatrixCallback<Unit>): Cancelable
+    suspend fun updateCanonicalAlias(alias: String?, altAliases: List<String>)
 
     /**
      * Update the history readability of the room
      */
-    fun updateHistoryReadability(readability: RoomHistoryVisibility, callback: MatrixCallback<Unit>): Cancelable
+    suspend fun updateHistoryReadability(readability: RoomHistoryVisibility)
+
+    /**
+     * Update the join rule and/or the guest access
+     */
+    suspend fun updateJoinRule(joinRules: RoomJoinRules?, guestAccess: GuestAccess?)
 
     /**
      * Update the avatar of the room
      */
-    fun updateAvatar(avatarUri: Uri, fileName: String, callback: MatrixCallback<Unit>): Cancelable
+    suspend fun updateAvatar(avatarUri: Uri, fileName: String)
 
     /**
      * Delete the avatar of the room
      */
-    fun deleteAvatar(callback: MatrixCallback<Unit>): Cancelable
+    suspend fun deleteAvatar()
 
-    fun sendStateEvent(eventType: String, stateKey: String?, body: JsonDict, callback: MatrixCallback<Unit>): Cancelable
+    suspend fun sendStateEvent(eventType: String, stateKey: String?, body: JsonDict)
 
     fun getStateEvent(eventType: String, stateKey: QueryStringValue = QueryStringValue.NoCondition): Event?
 

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

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.api.session.room.timeline
+
+data class EventTypeFilter(
+        /**
+         * Allowed event type.
+         */
+        val eventType: String,
+        /**
+         * Allowed state key. Set null if you want to allow all events,
+         * otherwise allowed events will be filtered according to the given stateKey.
+         */
+        val stateKey: String?
+)

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

@@ -36,5 +36,5 @@ data class TimelineEventFilters(
         /**
          * If [filterTypes] is true, the list of types allowed by the list.
          */
-        val allowedTypes: List<String> = emptyList()
+        val allowedTypes: List<EventTypeFilter> = emptyList()
 )

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

@@ -16,9 +16,6 @@
 
 package org.matrix.android.sdk.api.session.room.uploads
 
-import org.matrix.android.sdk.api.MatrixCallback
-import org.matrix.android.sdk.api.util.Cancelable
-
 /**
  * This interface defines methods to get event with uploads (= attachments) sent to a room. It's implemented at the room level.
  */
@@ -29,7 +26,5 @@ interface UploadsService {
      * @param numberOfEvents the expected number of events to retrieve. The result can contain less events.
      * @param since token to get next page, or null to get the first page
      */
-    fun getUploads(numberOfEvents: Int,
+    suspend fun getUploads(numberOfEvents: Int, since: String?): GetUploadsResult
-                   since: String?,
-                   callback: MatrixCallback<GetUploadsResult>): Cancelable
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/terms/TermsService.kt

@@ -16,22 +16,16 @@
 
 package org.matrix.android.sdk.api.session.terms
 
-import org.matrix.android.sdk.api.MatrixCallback
-import org.matrix.android.sdk.api.util.Cancelable
-
 interface TermsService {
     enum class ServiceType {
         IntegrationManager,
         IdentityService
     }
 
-    fun getTerms(serviceType: ServiceType,
+    suspend fun getTerms(serviceType: ServiceType, baseUrl: String): GetTermsResponse
-                 baseUrl: String,
-                 callback: MatrixCallback<GetTermsResponse>): Cancelable
 
-    fun agreeToTerms(serviceType: ServiceType,
+    suspend fun agreeToTerms(serviceType: ServiceType,
-                     baseUrl: String,
+                             baseUrl: String,
-                     agreedUrls: List<String>,
+                             agreedUrls: List<String>,
-                     token: String?,
+                             token: String?)
-                     callback: MatrixCallback<Unit>): Cancelable
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/util/MimeTypes.kt

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.api.util
+
+import org.matrix.android.sdk.api.extensions.orFalse
+
+// The Android SDK does not provide constant for mime type, add some of them here
+object MimeTypes {
+    const val Any: String = "*/*"
+    const val OctetStream = "application/octet-stream"
+
+    const val Images = "image/*"
+
+    const val Png = "image/png"
+    const val BadJpg = "image/jpg"
+    const val Jpeg = "image/jpeg"
+    const val Gif = "image/gif"
+
+    fun String?.normalizeMimeType() = if (this == BadJpg) Jpeg else this
+
+    fun String?.isMimeTypeImage() = this?.startsWith("image/").orFalse()
+    fun String?.isMimeTypeVideo() = this?.startsWith("video/").orFalse()
+    fun String?.isMimeTypeAudio() = this?.startsWith("audio/").orFalse()
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/auth/AuthModule.kt

@@ -33,6 +33,7 @@ import org.matrix.android.sdk.internal.di.AuthDatabase
 import org.matrix.android.sdk.internal.legacy.DefaultLegacySessionImporter
 import org.matrix.android.sdk.internal.wellknown.WellknownModule
 import io.realm.RealmConfiguration
+import org.matrix.android.sdk.api.auth.HomeServerHistoryService
 import java.io.File
 
 @Module(includes = [WellknownModule::class])
@@ -80,4 +81,7 @@ internal abstract class AuthModule {
 
     @Binds
     abstract fun bindDirectLoginTask(task: DefaultDirectLoginTask): DirectLoginTask
+
+    @Binds
+    abstract fun bindHomeServerHistoryService(service: DefaultHomeServerHistoryService): HomeServerHistoryService
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/auth/DefaultAuthenticationService.kt

@@ -26,6 +26,7 @@ import org.matrix.android.sdk.api.auth.AuthenticationService
 import org.matrix.android.sdk.api.auth.data.Credentials
 import org.matrix.android.sdk.api.auth.data.HomeServerConnectionConfig
 import org.matrix.android.sdk.api.auth.data.LoginFlowResult
+import org.matrix.android.sdk.api.auth.data.LoginFlowTypes
 import org.matrix.android.sdk.api.auth.login.LoginWizard
 import org.matrix.android.sdk.api.auth.registration.RegistrationWizard
 import org.matrix.android.sdk.api.auth.wellknown.WellknownResult
@@ -278,6 +279,7 @@ internal class DefaultAuthenticationService @Inject constructor(
         }
         return LoginFlowResult.Success(
                 loginFlowResponse.flows.orEmpty().mapNotNull { it.type },
+                loginFlowResponse.flows.orEmpty().firstOrNull { it.type == LoginFlowTypes.SSO }?.ssoIdentityProvider,
                 versions.isLoginAndRegistrationSupportedBySdk(),
                 homeServerUrl,
                 !versions.isSupportedBySdk()

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/auth/DefaultHomeServerHistoryService.kt

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.auth
+
+import com.zhuinden.monarchy.Monarchy
+import io.realm.kotlin.where
+import org.matrix.android.sdk.api.auth.HomeServerHistoryService
+import org.matrix.android.sdk.internal.database.model.KnownServerUrlEntity
+import org.matrix.android.sdk.internal.di.GlobalDatabase
+import javax.inject.Inject
+
+class DefaultHomeServerHistoryService @Inject constructor(
+        @GlobalDatabase private val monarchy: Monarchy
+) : HomeServerHistoryService {
+
+    override fun getKnownServersUrls(): List<String> {
+        return monarchy.fetchAllMappedSync(
+                { realm ->
+                    realm.where<KnownServerUrlEntity>()
+                },
+                { it.url }
+        )
+    }
+
+    override fun addHomeServerToHistory(url: String) {
+        monarchy.writeAsync { realm ->
+            KnownServerUrlEntity(url).let {
+                realm.insertOrUpdate(it)
+            }
+        }
+    }
+
+    override fun clearHistory() {
+        monarchy.runTransactionSync { it.where<KnownServerUrlEntity>().findAll().deleteAllFromRealm() }
+    }
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/auth/data/LoginFlowResponse.kt

@@ -18,6 +18,7 @@ package org.matrix.android.sdk.internal.auth.data
 
 import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
+import org.matrix.android.sdk.api.auth.data.SsoIdentityProvider
 
 @JsonClass(generateAdapter = true)
 internal data class LoginFlowResponse(
@@ -34,5 +35,13 @@ internal data class LoginFlow(
          * The login type. This is supplied as the type when logging in.
          */
         @Json(name = "type")
-        val type: String?
+        val type: String?,
+
+        /**
+         * Augments m.login.sso flow discovery definition to include metadata on the supported IDPs
+         * the client can show a button for each of the supported providers
+         * See MSC #2858
+         */
+        @Json(name = "identity_providers")
+        val ssoIdentityProvider: List<SsoIdentityProvider>?
 )

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/auth/registration/RegistrationFlowResponse.kt

@@ -51,6 +51,18 @@ data class RegistrationFlowResponse(
          * 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.
+         * other example
+         *  "params": {
+         *       "m.login.sso": {
+         *          "identity_providers": [
+         *              {
+         *                  "id": "google",
+         *                  "name": "Google",
+         *                  "icon": "https://..."
+         *              }
+         *          ]
+         *      }
+         *  }
          */
         @Json(name = "params")
         val params: JsonDict? = null

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/verification/SASDefaultVerificationTransaction.kt

@@ -31,6 +31,7 @@ import org.matrix.android.sdk.internal.extensions.toUnsignedInt
 import org.matrix.olm.OlmSAS
 import org.matrix.olm.OlmUtility
 import timber.log.Timber
+import java.util.Locale
 
 /**
  * Represents an ongoing short code interactive key verification between two devices.
@@ -344,7 +345,7 @@ internal abstract class SASDefaultVerificationTransaction(
     }
 
     protected fun hashUsingAgreedHashMethod(toHash: String): String? {
-        if ("sha256".toLowerCase() == accepted?.hash?.toLowerCase()) {
+        if ("sha256" == accepted?.hash?.toLowerCase(Locale.ROOT)) {
             val olmUtil = OlmUtility()
             val hashBytes = olmUtil.sha256(toHash)
             olmUtil.releaseUtility()
@@ -354,12 +355,11 @@ internal abstract class SASDefaultVerificationTransaction(
     }
 
     private fun macUsingAgreedMethod(message: String, info: String): String? {
-        if (SAS_MAC_SHA256_LONGKDF.toLowerCase() == accepted?.messageAuthenticationCode?.toLowerCase()) {
+        return when (accepted?.messageAuthenticationCode?.toLowerCase(Locale.ROOT)) {
-            return getSAS().calculateMacLongKdf(message, info)
+            SAS_MAC_SHA256_LONGKDF -> getSAS().calculateMacLongKdf(message, info)
-        } else if (SAS_MAC_SHA256.toLowerCase() == accepted?.messageAuthenticationCode?.toLowerCase()) {
+            SAS_MAC_SHA256         -> getSAS().calculateMac(message, info)
-            return getSAS().calculateMac(message, info)
+            else                   -> null
         }
-        return null
     }
 
     override fun getDecimalCodeRepresentation(): String {

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

@@ -20,6 +20,7 @@ import io.realm.DynamicRealm
 import io.realm.RealmMigration
 import org.matrix.android.sdk.internal.database.model.HomeServerCapabilitiesEntityFields
 import org.matrix.android.sdk.internal.database.model.PendingThreePidEntityFields
+import org.matrix.android.sdk.internal.database.model.PreviewUrlCacheEntityFields
 import org.matrix.android.sdk.internal.database.model.RoomSummaryEntityFields
 import timber.log.Timber
 import javax.inject.Inject
@@ -32,9 +33,8 @@ class RealmSessionStoreMigration @Inject constructor() : RealmMigration {
         const val SESSION_STORE_SCHEMA_SC_VERSION = 1L
         const val SESSION_STORE_SCHEMA_SC_VERSION_OFFSET = (1L shl 12)
 
-        const val SESSION_STORE_SCHEMA_VERSION = 5L +
+        const val SESSION_STORE_SCHEMA_VERSION = 6L +
                 SESSION_STORE_SCHEMA_SC_VERSION * SESSION_STORE_SCHEMA_SC_VERSION_OFFSET
-
     }
 
     override fun migrate(realm: DynamicRealm, combinedOldVersion: Long, newVersion: Long) {
@@ -48,6 +48,7 @@ class RealmSessionStoreMigration @Inject constructor() : RealmMigration {
         if (oldVersion <= 2) migrateTo3(realm)
         if (oldVersion <= 3) migrateTo4(realm)
         if (oldVersion <= 4) migrateTo5(realm)
+        if (oldVersion <= 5) migrateTo6(realm)
 
         if (oldScVersion <= 0) migrateToSc1(realm)
     }
@@ -110,4 +111,18 @@ class RealmSessionStoreMigration @Inject constructor() : RealmMigration {
                 ?.removeField("adminE2EByDefault")
                 ?.removeField("preferredJitsiDomain")
     }
+
+    private fun migrateTo6(realm: DynamicRealm) {
+        Timber.d("Step 5 -> 6")
+        realm.schema.create("PreviewUrlCacheEntity")
+                .addField(PreviewUrlCacheEntityFields.URL, String::class.java)
+                .setRequired(PreviewUrlCacheEntityFields.URL, true)
+                .addPrimaryKey(PreviewUrlCacheEntityFields.URL)
+                .addField(PreviewUrlCacheEntityFields.URL_FROM_SERVER, String::class.java)
+                .addField(PreviewUrlCacheEntityFields.SITE_NAME, String::class.java)
+                .addField(PreviewUrlCacheEntityFields.TITLE, String::class.java)
+                .addField(PreviewUrlCacheEntityFields.DESCRIPTION, String::class.java)
+                .addField(PreviewUrlCacheEntityFields.MXC_URL, String::class.java)
+                .addField(PreviewUrlCacheEntityFields.LAST_UPDATED_TIMESTAMP, Long::class.java)
+    }
 }

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

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.database.model
+
+import io.realm.RealmObject
+import io.realm.annotations.PrimaryKey
+
+internal open class KnownServerUrlEntity(
+        @PrimaryKey
+        var url: String = ""
+) : RealmObject() {
+    companion object
+}

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

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.database.model
+
+import io.realm.RealmObject
+import io.realm.annotations.PrimaryKey
+
+internal open class PreviewUrlCacheEntity(
+        @PrimaryKey
+        var url: String = "",
+
+        var urlFromServer: String? = null,
+        var siteName: String? = null,
+        var title: String? = null,
+        var description: String? = null,
+        var mxcUrl: String? = null,
+
+        var lastUpdatedTimestamp: Long = 0L
+) : RealmObject() {
+
+    companion object
+}

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

@@ -48,6 +48,7 @@ import io.realm.annotations.RealmModule
             PushRulesEntity::class,
             PushRuleEntity::class,
             PushConditionEntity::class,
+            PreviewUrlCacheEntity::class,
             PusherEntity::class,
             PusherDataEntity::class,
             ReadReceiptsSummaryEntity::class,

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

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.database.query
+
+import io.realm.Realm
+import io.realm.kotlin.createObject
+import io.realm.kotlin.where
+import org.matrix.android.sdk.internal.database.model.PreviewUrlCacheEntity
+import org.matrix.android.sdk.internal.database.model.PreviewUrlCacheEntityFields
+
+/**
+ * Get the current PreviewUrlCacheEntity, return null if it does not exist
+ */
+internal fun PreviewUrlCacheEntity.Companion.get(realm: Realm, url: String): PreviewUrlCacheEntity? {
+    return realm.where<PreviewUrlCacheEntity>()
+            .equalTo(PreviewUrlCacheEntityFields.URL, url)
+            .findFirst()
+}
+
+/**
+ * Get the current PreviewUrlCacheEntity, create one if it does not exist
+ */
+internal fun PreviewUrlCacheEntity.Companion.getOrCreate(realm: Realm, url: String): PreviewUrlCacheEntity {
+    return get(realm, url) ?: realm.createObject(url)
+}

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

@@ -71,8 +71,23 @@ internal fun TimelineEventEntity.Companion.latestEvent(realm: Realm,
 }
 
 internal fun RealmQuery<TimelineEventEntity>.filterEvents(filters: TimelineEventFilters): RealmQuery<TimelineEventEntity> {
-    if (filters.filterTypes) {
+    if (filters.filterTypes && filters.allowedTypes.isNotEmpty()) {
-        `in`(TimelineEventEntityFields.ROOT.TYPE, filters.allowedTypes.toTypedArray())
+        beginGroup()
+        filters.allowedTypes.forEachIndexed { index, filter ->
+            if (filter.stateKey == null) {
+                equalTo(TimelineEventEntityFields.ROOT.TYPE, filter.eventType)
+            } else {
+                beginGroup()
+                equalTo(TimelineEventEntityFields.ROOT.TYPE, filter.eventType)
+                and()
+                equalTo(TimelineEventEntityFields.ROOT.STATE_KEY, filter.stateKey)
+                endGroup()
+            }
+            if (index != filters.allowedTypes.size - 1) {
+                or()
+            }
+        }
+        endGroup()
     }
     if (filters.filterUseless) {
         not()

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/di/MatrixComponent.kt

@@ -25,6 +25,7 @@ import okhttp3.OkHttpClient
 import org.matrix.android.sdk.api.Matrix
 import org.matrix.android.sdk.api.MatrixConfiguration
 import org.matrix.android.sdk.api.auth.AuthenticationService
+import org.matrix.android.sdk.api.auth.HomeServerHistoryService
 import org.matrix.android.sdk.api.raw.RawService
 import org.matrix.android.sdk.internal.SessionManager
 import org.matrix.android.sdk.internal.auth.AuthModule
@@ -62,6 +63,8 @@ internal interface MatrixComponent {
 
     fun rawService(): RawService
 
+    fun homeServerHistoryService(): HomeServerHistoryService
+
     fun context(): Context
 
     fun matrixConfiguration(): MatrixConfiguration
@@ -71,9 +74,6 @@ internal interface MatrixComponent {
     @CacheDirectory
     fun cacheDir(): File
 
-    @ExternalFilesDirectory
-    fun externalFilesDir(): File?
-
     fun olmManager(): OlmManager
 
     fun taskExecutor(): TaskExecutor

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/di/MatrixModule.kt

@@ -57,13 +57,6 @@ internal object MatrixModule {
         return context.cacheDir
     }
 
-    @JvmStatic
-    @Provides
-    @ExternalFilesDirectory
-    fun providesExternalFilesDir(context: Context): File? {
-        return context.getExternalFilesDir(null)
-    }
-
     @JvmStatic
     @Provides
     @MatrixScope

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/network/Request.kt

@@ -16,14 +16,15 @@
 
 package org.matrix.android.sdk.internal.network
 
-import org.matrix.android.sdk.api.failure.Failure
-import org.matrix.android.sdk.api.failure.shouldBeRetried
-import org.matrix.android.sdk.internal.network.ssl.CertUtil
 import kotlinx.coroutines.CancellationException
 import kotlinx.coroutines.delay
 import org.greenrobot.eventbus.EventBus
+import org.matrix.android.sdk.api.failure.Failure
+import org.matrix.android.sdk.api.failure.shouldBeRetried
+import org.matrix.android.sdk.internal.network.ssl.CertUtil
 import retrofit2.Call
 import retrofit2.awaitResponse
+import timber.log.Timber
 import java.io.IOException
 
 internal suspend inline fun <DATA : Any> executeRequest(eventBus: EventBus?,
@@ -49,6 +50,9 @@ internal class Request<DATA : Any>(private val eventBus: EventBus?) {
                 throw response.toFailure(eventBus)
             }
         } catch (exception: Throwable) {
+            // Log some details about the request which has failed
+            Timber.e("Exception when executing request ${apiCall.request().method} ${apiCall.request().url.toString().substringBefore("?")}")
+
             // Check if this is a certificateException
             CertUtil.getCertificateException(exception)
                     // TODO Support certificate error once logged

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/raw/DefaultRawService.kt

@@ -16,7 +16,7 @@
 
 package org.matrix.android.sdk.internal.raw
 
-import org.matrix.android.sdk.api.raw.RawCacheStrategy
+import org.matrix.android.sdk.api.cache.CacheStrategy
 import org.matrix.android.sdk.api.raw.RawService
 import java.util.concurrent.TimeUnit
 import javax.inject.Inject
@@ -25,15 +25,15 @@ internal class DefaultRawService @Inject constructor(
         private val getUrlTask: GetUrlTask,
         private val cleanRawCacheTask: CleanRawCacheTask
 ) : RawService {
-    override suspend fun getUrl(url: String, rawCacheStrategy: RawCacheStrategy): String {
+    override suspend fun getUrl(url: String, cacheStrategy: CacheStrategy): String {
-        return getUrlTask.execute(GetUrlTask.Params(url, rawCacheStrategy))
+        return getUrlTask.execute(GetUrlTask.Params(url, cacheStrategy))
     }
 
     override suspend fun getWellknown(userId: String): String {
         val homeServerDomain = userId.substringAfter(":")
         return getUrl(
                 "https://$homeServerDomain/.well-known/matrix/client",
-                RawCacheStrategy.TtlCache(TimeUnit.HOURS.toMillis(8), false)
+                CacheStrategy.TtlCache(TimeUnit.HOURS.toMillis(8), false)
         )
     }
 

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/raw/GetUrlTask.kt

@@ -18,7 +18,7 @@ package org.matrix.android.sdk.internal.raw
 
 import com.zhuinden.monarchy.Monarchy
 import okhttp3.ResponseBody
-import org.matrix.android.sdk.api.raw.RawCacheStrategy
+import org.matrix.android.sdk.api.cache.CacheStrategy
 import org.matrix.android.sdk.internal.database.model.RawCacheEntity
 import org.matrix.android.sdk.internal.database.query.get
 import org.matrix.android.sdk.internal.database.query.getOrCreate
@@ -32,7 +32,7 @@ import javax.inject.Inject
 internal interface GetUrlTask : Task<GetUrlTask.Params, String> {
     data class Params(
             val url: String,
-            val rawCacheStrategy: RawCacheStrategy
+            val cacheStrategy: CacheStrategy
     )
 }
 
@@ -42,14 +42,14 @@ internal class DefaultGetUrlTask @Inject constructor(
 ) : GetUrlTask {
 
     override suspend fun execute(params: GetUrlTask.Params): String {
-        return when (params.rawCacheStrategy) {
+        return when (params.cacheStrategy) {
-            RawCacheStrategy.NoCache       -> doRequest(params.url)
+            CacheStrategy.NoCache       -> doRequest(params.url)
-            is RawCacheStrategy.TtlCache   -> doRequestWithCache(
+            is CacheStrategy.TtlCache   -> doRequestWithCache(
                     params.url,
-                    params.rawCacheStrategy.validityDurationInMillis,
+                    params.cacheStrategy.validityDurationInMillis,
-                    params.rawCacheStrategy.strict
+                    params.cacheStrategy.strict
             )
-            RawCacheStrategy.InfiniteCache -> doRequestWithCache(
+            CacheStrategy.InfiniteCache -> doRequestWithCache(
                     params.url,
                     Long.MAX_VALUE,
                     true

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/raw/GlobalRealmMigration.kt

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.raw
+
+import io.realm.DynamicRealm
+import io.realm.RealmMigration
+import org.matrix.android.sdk.internal.database.model.KnownServerUrlEntityFields
+import timber.log.Timber
+
+internal object GlobalRealmMigration : RealmMigration {
+
+    // Current schema version
+    const val SCHEMA_VERSION = 1L
+
+    override fun migrate(realm: DynamicRealm, oldVersion: Long, newVersion: Long) {
+        Timber.d("Migrating Auth Realm from $oldVersion to $newVersion")
+
+        if (oldVersion <= 0) migrateTo1(realm)
+    }
+
+    private fun migrateTo1(realm: DynamicRealm) {
+        realm.schema.create("KnownServerUrlEntity")
+                .addField(KnownServerUrlEntityFields.URL, String::class.java)
+                .addPrimaryKey(KnownServerUrlEntityFields.URL)
+                .setRequired(KnownServerUrlEntityFields.URL, true)
+    }
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/raw/GlobalRealmModule.kt

@@ -17,6 +17,7 @@
 package org.matrix.android.sdk.internal.raw
 
 import io.realm.annotations.RealmModule
+import org.matrix.android.sdk.internal.database.model.KnownServerUrlEntity
 import org.matrix.android.sdk.internal.database.model.RawCacheEntity
 
 /**
@@ -24,6 +25,7 @@ import org.matrix.android.sdk.internal.database.model.RawCacheEntity
  */
 @RealmModule(library = true,
         classes = [
-            RawCacheEntity::class
+            RawCacheEntity::class,
+            KnownServerUrlEntity::class
         ])
 internal class GlobalRealmModule

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/raw/RawModule.kt

@@ -57,6 +57,9 @@ internal abstract class RawModule {
                         realmKeysUtils.configureEncryption(this, DB_ALIAS)
                     }
                     .name("matrix-sdk-global.realm")
+                    .schemaVersion(GlobalRealmMigration.SCHEMA_VERSION)
+                    .migration(GlobalRealmMigration)
+                    .allowWritesOnUiThread(true)
                     .modules(GlobalRealmModule())
                     .build()
         }

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

@@ -21,6 +21,10 @@ import android.net.Uri
 import android.webkit.MimeTypeMap
 import androidx.core.content.FileProvider
 import arrow.core.Try
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
+import okhttp3.OkHttpClient
+import okhttp3.Request
 import org.matrix.android.sdk.api.MatrixCallback
 import org.matrix.android.sdk.api.extensions.tryOrNull
 import org.matrix.android.sdk.api.session.content.ContentUrlResolver
@@ -29,35 +33,21 @@ import org.matrix.android.sdk.api.util.Cancelable
 import org.matrix.android.sdk.api.util.NoOpCancellable
 import org.matrix.android.sdk.internal.crypto.attachments.ElementToDecrypt
 import org.matrix.android.sdk.internal.crypto.attachments.MXEncryptedAttachments
-import org.matrix.android.sdk.internal.di.CacheDirectory
-import org.matrix.android.sdk.internal.di.ExternalFilesDirectory
 import org.matrix.android.sdk.internal.di.SessionDownloadsDirectory
 import org.matrix.android.sdk.internal.di.UnauthenticatedWithCertificateWithProgress
 import org.matrix.android.sdk.internal.session.download.DownloadProgressInterceptor.Companion.DOWNLOAD_PROGRESS_INTERCEPTOR_HEADER
 import org.matrix.android.sdk.internal.task.TaskExecutor
 import org.matrix.android.sdk.internal.util.MatrixCoroutineDispatchers
+import org.matrix.android.sdk.internal.util.md5
 import org.matrix.android.sdk.internal.util.toCancelable
 import org.matrix.android.sdk.internal.util.writeToFile
-import kotlinx.coroutines.launch
-import kotlinx.coroutines.withContext
-import okhttp3.OkHttpClient
-import okhttp3.Request
-import okio.buffer
-import okio.sink
-import okio.source
 import timber.log.Timber
 import java.io.File
 import java.io.IOException
-import java.io.InputStream
-import java.net.URLEncoder
 import javax.inject.Inject
 
 internal class DefaultFileService @Inject constructor(
         private val context: Context,
-        @CacheDirectory
-        private val cacheDirectory: File,
-        @ExternalFilesDirectory
-        private val externalFilesDirectory: File?,
         @SessionDownloadsDirectory
         private val sessionCacheDirectory: File,
         private val contentUrlResolver: ContentUrlResolver,
@@ -67,9 +57,17 @@ internal class DefaultFileService @Inject constructor(
         private val taskExecutor: TaskExecutor
 ) : FileService {
 
-    private fun String.safeFileName() = URLEncoder.encode(this, Charsets.US_ASCII.displayName())
+    // Legacy folder, will be deleted
+    private val legacyFolder = File(sessionCacheDirectory, "MF")
+    // Folder to store downloaded files (not decrypted)
+    private val downloadFolder = File(sessionCacheDirectory, "F")
+    // Folder to store decrypted files
+    private val decryptedFolder = File(downloadFolder, "D")
 
-    private val downloadFolder = File(sessionCacheDirectory, "MF")
+    init {
+        // Clear the legacy downloaded files
+        legacyFolder.deleteRecursively()
+    }
 
     /**
      * Retain ongoing downloads to avoid re-downloading and already downloading file
@@ -81,28 +79,26 @@ internal class DefaultFileService @Inject constructor(
      * Download file in the cache folder, and eventually decrypt it
      * TODO looks like files are copied 3 times
      */
-    override fun downloadFile(downloadMode: FileService.DownloadMode,
+    override fun downloadFile(fileName: String,
-                              id: String,
-                              fileName: String,
                               mimeType: String?,
                               url: String?,
                               elementToDecrypt: ElementToDecrypt?,
                               callback: MatrixCallback<File>): Cancelable {
-        val unwrappedUrl = url ?: return NoOpCancellable.also {
+        url ?: return NoOpCancellable.also {
             callback.onFailure(IllegalArgumentException("url is null"))
         }
 
-        Timber.v("## FileService downloadFile $unwrappedUrl")
+        Timber.v("## FileService downloadFile $url")
 
         synchronized(ongoing) {
-            val existing = ongoing[unwrappedUrl]
+            val existing = ongoing[url]
             if (existing != null) {
                 Timber.v("## FileService downloadFile is already downloading.. ")
                 existing.add(callback)
                 return NoOpCancellable
             } else {
                 // mark as tracked
-                ongoing[unwrappedUrl] = ArrayList()
+                ongoing[url] = ArrayList()
                 // and proceed to download
             }
         }
@@ -110,15 +106,15 @@ internal class DefaultFileService @Inject constructor(
         return taskExecutor.executorScope.launch(coroutineDispatchers.main) {
             withContext(coroutineDispatchers.io) {
                 Try {
-                    if (!downloadFolder.exists()) {
+                    if (!decryptedFolder.exists()) {
-                        downloadFolder.mkdirs()
+                        decryptedFolder.mkdirs()
                     }
                     // ensure we use unique file name by using URL (mapped to suitable file name)
                     // Also we need to add extension for the FileProvider, if not it lot's of app that it's
                     // shared with will not function well (even if mime type is passed in the intent)
-                    File(downloadFolder, fileForUrl(unwrappedUrl, mimeType))
+                    getFiles(url, fileName, mimeType, elementToDecrypt != null)
-                }.flatMap { destFile ->
+                }.flatMap { cachedFiles ->
-                    if (!destFile.exists()) {
+                    if (!cachedFiles.file.exists()) {
                         val resolvedUrl = contentUrlResolver.resolveFullSize(url) ?: return@flatMap Try.Failure(IllegalArgumentException("url is null"))
 
                         val request = Request.Builder()
@@ -141,79 +137,153 @@ internal class DefaultFileService @Inject constructor(
 
                         Timber.v("Response size ${response.body?.contentLength()} - Stream available: ${!source.exhausted()}")
 
-                        if (elementToDecrypt != null) {
+                        // Write the file to cache (encrypted version if the file is encrypted)
-                            Timber.v("## FileService: decrypt file")
+                        writeToFile(source.inputStream(), cachedFiles.file)
-                            val decryptSuccess = destFile.outputStream().buffered().use {
+                        response.close()
-                                MXEncryptedAttachments.decryptAttachment(
-                                        source.inputStream(),
-                                        elementToDecrypt,
-                                        it
-                                )
-                            }
-                            response.close()
-                            if (!decryptSuccess) {
-                                return@flatMap Try.Failure(IllegalStateException("Decryption error"))
-                            }
-                        } else {
-                            writeToFile(source.inputStream(), destFile)
-                            response.close()
-                        }
                     } else {
                         Timber.v("## FileService: cache hit for $url")
                     }
 
-                    Try.just(copyFile(destFile, downloadMode))
+                    Try.just(cachedFiles)
                 }
-            }.fold({
+            }.flatMap { cachedFiles ->
-                callback.onFailure(it)
+                // Decrypt if necessary
-                // notify concurrent requests
+                if (cachedFiles.decryptedFile != null) {
-                val toNotify = synchronized(ongoing) {
+                    if (!cachedFiles.decryptedFile.exists()) {
-                    ongoing[unwrappedUrl]?.also {
+                        Timber.v("## FileService: decrypt file")
-                        ongoing.remove(unwrappedUrl)
+                        // Ensure the parent folder exists
+                        cachedFiles.decryptedFile.parentFile?.mkdirs()
+                        val decryptSuccess = cachedFiles.file.inputStream().use { inputStream ->
+                            cachedFiles.decryptedFile.outputStream().buffered().use { outputStream ->
+                                MXEncryptedAttachments.decryptAttachment(
+                                        inputStream,
+                                        elementToDecrypt,
+                                        outputStream
+                                )
+                            }
+                        }
+                        if (!decryptSuccess) {
+                            return@flatMap Try.Failure(IllegalStateException("Decryption error"))
+                        }
+                    } else {
+                        Timber.v("## FileService: cache hit for decrypted file")
                     }
+                    Try.just(cachedFiles.decryptedFile)
+                } else {
+                    // Clear file
+                    Try.just(cachedFiles.file)
                 }
-                toNotify?.forEach { otherCallbacks ->
+            }.fold(
-                    tryOrNull { otherCallbacks.onFailure(it) }
+                    { throwable ->
-                }
+                        callback.onFailure(throwable)
-            }, { file ->
+                        // notify concurrent requests
-                callback.onSuccess(file)
+                        val toNotify = synchronized(ongoing) {
-                // notify concurrent requests
+                            ongoing[url]?.also {
-                val toNotify = synchronized(ongoing) {
+                                ongoing.remove(url)
-                    ongoing[unwrappedUrl]?.also {
+                            }
-                        ongoing.remove(unwrappedUrl)
+                        }
+                        toNotify?.forEach { otherCallbacks ->
+                            tryOrNull { otherCallbacks.onFailure(throwable) }
+                        }
+                    },
+                    { file ->
+                        callback.onSuccess(file)
+                        // notify concurrent requests
+                        val toNotify = synchronized(ongoing) {
+                            ongoing[url]?.also {
+                                ongoing.remove(url)
+                            }
+                        }
+                        Timber.v("## FileService additional to notify ${toNotify?.size ?: 0} ")
+                        toNotify?.forEach { otherCallbacks ->
+                            tryOrNull { otherCallbacks.onSuccess(file) }
+                        }
                     }
-                }
+            )
-                Timber.v("## FileService additional to notify ${toNotify?.size ?: 0} ")
-                toNotify?.forEach { otherCallbacks ->
-                    tryOrNull { otherCallbacks.onSuccess(file) }
-                }
-            })
         }.toCancelable()
     }
 
-    fun storeDataFor(url: String, mimeType: String?, inputStream: InputStream) {
+    fun storeDataFor(mxcUrl: String,
-        val file = File(downloadFolder, fileForUrl(url, mimeType))
+                     filename: String?,
-        val source = inputStream.source().buffer()
+                     mimeType: String?,
-        file.sink().buffer().let { sink ->
+                     originalFile: File,
-            source.use { input ->
+                     encryptedFile: File?) {
-                sink.use { output ->
+        val files = getFiles(mxcUrl, filename, mimeType, encryptedFile != null)
-                    output.writeAll(input)
+        if (encryptedFile != null) {
+            // We switch the two files here, original file it the decrypted file
+            files.decryptedFile?.let { originalFile.copyTo(it) }
+            encryptedFile.copyTo(files.file)
+        } else {
+            // Just copy the original file
+            originalFile.copyTo(files.file)
+        }
+    }
+
+    private fun safeFileName(fileName: String?, mimeType: String?): String {
+        return buildString {
+            // filename has to be safe for the Android System
+            val result = fileName
+                    ?.replace("[^a-z A-Z0-9\\\\.\\-]".toRegex(), "_")
+                    ?.takeIf { it.isNotEmpty() }
+                    ?: DEFAULT_FILENAME
+            append(result)
+            // Check that the extension is correct regarding the mimeType
+            val extensionFromMime = mimeType?.let { MimeTypeMap.getSingleton().getExtensionFromMimeType(mimeType) }
+            if (extensionFromMime != null) {
+                // Compare
+                val fileExtension = result.substringAfterLast(delimiter = ".", missingDelimiterValue = "")
+                if (fileExtension.isEmpty() || fileExtension != extensionFromMime) {
+                    // Missing extension, or diff in extension, add the one provided by the mimetype
+                    append(".")
+                    append(extensionFromMime)
                 }
             }
         }
     }
 
-    private fun fileForUrl(url: String, mimeType: String?): String {
+    override fun isFileInCache(mxcUrl: String?,
-        val extension = mimeType?.let { MimeTypeMap.getSingleton().getExtensionFromMimeType(mimeType) }
+                               fileName: String,
-        return if (extension != null) "${url.safeFileName()}.$extension" else url.safeFileName()
+                               mimeType: String?,
+                               elementToDecrypt: ElementToDecrypt?): Boolean {
+        return fileState(mxcUrl, fileName, mimeType, elementToDecrypt) == FileService.FileState.IN_CACHE
     }
 
-    override fun isFileInCache(mxcUrl: String, mimeType: String?): Boolean {
+    internal data class CachedFiles(
-        return File(downloadFolder, fileForUrl(mxcUrl, mimeType)).exists()
+            // This is the downloaded file. Can be clear or encrypted
+            val file: File,
+            // This is the decrypted file. Null if the original file is not encrypted
+            val decryptedFile: File?
+    ) {
+        fun getClearFile(): File = decryptedFile ?: file
     }
 
-    override fun fileState(mxcUrl: String, mimeType: String?): FileService.FileState {
+    private fun getFiles(mxcUrl: String,
-        if (isFileInCache(mxcUrl, mimeType)) return FileService.FileState.IN_CACHE
+                         fileName: String?,
+                         mimeType: String?,
+                         isEncrypted: Boolean): CachedFiles {
+        val hashFolder = mxcUrl.md5()
+        val safeFileName = safeFileName(fileName, mimeType)
+        return if (isEncrypted) {
+            // Encrypted file
+            CachedFiles(
+                    File(downloadFolder, "$hashFolder/$ENCRYPTED_FILENAME"),
+                    File(decryptedFolder, "$hashFolder/$safeFileName")
+            )
+        } else {
+            // Clear file
+            CachedFiles(
+                    File(downloadFolder, "$hashFolder/$safeFileName"),
+                    null
+            )
+        }
+    }
+
+    override fun fileState(mxcUrl: String?,
+                           fileName: String,
+                           mimeType: String?,
+                           elementToDecrypt: ElementToDecrypt?): FileService.FileState {
+        mxcUrl ?: return FileService.FileState.UNKNOWN
+        if (getFiles(mxcUrl, fileName, mimeType, elementToDecrypt != null).file.exists()) return FileService.FileState.IN_CACHE
         val isDownloading = synchronized(ongoing) {
             ongoing[mxcUrl] != null
         }
@@ -224,26 +294,18 @@ internal class DefaultFileService @Inject constructor(
      * Use this URI and pass it to intent using flag Intent.FLAG_GRANT_READ_URI_PERMISSION
      * (if not other app won't be able to access it)
      */
-    override fun getTemporarySharableURI(mxcUrl: String, mimeType: String?): Uri? {
+    override fun getTemporarySharableURI(mxcUrl: String?,
+                                         fileName: String,
+                                         mimeType: String?,
+                                         elementToDecrypt: ElementToDecrypt?): Uri? {
+        mxcUrl ?: return null
         // this string could be extracted no?
         val authority = "${context.packageName}.mx-sdk.fileprovider"
-        val targetFile = File(downloadFolder, fileForUrl(mxcUrl, mimeType))
+        val targetFile = getFiles(mxcUrl, fileName, mimeType, elementToDecrypt != null).getClearFile()
         if (!targetFile.exists()) return null
         return FileProvider.getUriForFile(context, authority, targetFile)
     }
 
-    private fun copyFile(file: File, downloadMode: FileService.DownloadMode): File {
-        // TODO some of this seems outdated, will need to be re-worked
-        return when (downloadMode) {
-            FileService.DownloadMode.TO_EXPORT          ->
-                file.copyTo(File(externalFilesDirectory, file.name), true)
-            FileService.DownloadMode.FOR_EXTERNAL_SHARE ->
-                file.copyTo(File(File(cacheDirectory, "ext_share"), file.name), true)
-            FileService.DownloadMode.FOR_INTERNAL_USE   ->
-                file
-        }
-    }
-
     override fun getCacheSize(): Int {
         return downloadFolder.walkTopDown()
                 .onEnter {
@@ -256,4 +318,14 @@ internal class DefaultFileService @Inject constructor(
     override fun clearCache() {
         downloadFolder.deleteRecursively()
     }
+
+    override fun clearDecryptedCache() {
+        decryptedFolder.deleteRecursively()
+    }
+
+    companion object {
+        private const val ENCRYPTED_FILENAME = "encrypted.bin"
+        // The extension would be added from the mimetype
+        private const val DEFAULT_FILENAME = "file"
+    }
 }

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

@@ -43,6 +43,7 @@ import org.matrix.android.sdk.api.session.file.FileService
 import org.matrix.android.sdk.api.session.group.GroupService
 import org.matrix.android.sdk.api.session.homeserver.HomeServerCapabilitiesService
 import org.matrix.android.sdk.api.session.integrationmanager.IntegrationManagerService
+import org.matrix.android.sdk.api.session.media.MediaService
 import org.matrix.android.sdk.api.session.permalinks.PermalinkService
 import org.matrix.android.sdk.api.session.profile.ProfileService
 import org.matrix.android.sdk.api.session.pushers.PushersService
@@ -102,6 +103,7 @@ internal class DefaultSession @Inject constructor(
         private val permalinkService: Lazy<PermalinkService>,
         private val secureStorageService: Lazy<SecureStorageService>,
         private val profileService: Lazy<ProfileService>,
+        private val mediaService: Lazy<MediaService>,
         private val widgetService: Lazy<WidgetService>,
         private val syncThreadProvider: Provider<SyncThread>,
         private val contentUrlResolver: ContentUrlResolver,
@@ -263,6 +265,8 @@ internal class DefaultSession @Inject constructor(
 
     override fun widgetService(): WidgetService = widgetService.get()
 
+    override fun mediaService(): MediaService = mediaService.get()
+
     override fun integrationManagerService() = integrationManagerService
 
     override fun callSignalingService(): CallSignalingService = callSignalingService.get()

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

@@ -40,6 +40,7 @@ import org.matrix.android.sdk.internal.session.group.GroupModule
 import org.matrix.android.sdk.internal.session.homeserver.HomeServerCapabilitiesModule
 import org.matrix.android.sdk.internal.session.identity.IdentityModule
 import org.matrix.android.sdk.internal.session.integrationmanager.IntegrationManagerModule
+import org.matrix.android.sdk.internal.session.media.MediaModule
 import org.matrix.android.sdk.internal.session.openid.OpenIdModule
 import org.matrix.android.sdk.internal.session.profile.ProfileModule
 import org.matrix.android.sdk.internal.session.pushers.AddHttpPusherWorker
@@ -75,6 +76,7 @@ import org.matrix.android.sdk.internal.util.MatrixCoroutineDispatchers
             GroupModule::class,
             ContentModule::class,
             CacheModule::class,
+            MediaModule::class,
             CryptoModule::class,
             PushersModule::class,
             OpenIdModule::class,

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

@@ -50,6 +50,7 @@ import org.matrix.android.sdk.internal.database.EventInsertLiveObserver
 import org.matrix.android.sdk.internal.database.RealmSessionProvider
 import org.matrix.android.sdk.internal.database.SessionRealmConfigurationFactory
 import org.matrix.android.sdk.internal.di.Authenticated
+import org.matrix.android.sdk.internal.di.CacheDirectory
 import org.matrix.android.sdk.internal.di.DeviceId
 import org.matrix.android.sdk.internal.di.SessionDatabase
 import org.matrix.android.sdk.internal.di.SessionDownloadsDirectory
@@ -169,9 +170,9 @@ internal abstract class SessionModule {
         @JvmStatic
         @Provides
         @SessionDownloadsDirectory
-        fun providesCacheDir(@SessionId sessionId: String,
+        fun providesDownloadsCacheDir(@SessionId sessionId: String,
-                             context: Context): File {
+                                      @CacheDirectory cacheFile: File): File {
-            return File(context.cacheDir, "downloads/$sessionId")
+            return File(cacheFile, "downloads/$sessionId")
         }
 
         @JvmStatic

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/content/ContentUploadResponse.kt

@@ -20,6 +20,9 @@ import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
 
 @JsonClass(generateAdapter = true)
-data class ContentUploadResponse(
+internal data class ContentUploadResponse(
+        /**
+         * Required. The MXC URI to the uploaded content.
+         */
         @Json(name = "content_uri") val contentUri: String
 )

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/content/ThumbnailExtractor.kt

@@ -20,6 +20,7 @@ import android.content.Context
 import android.graphics.Bitmap
 import android.media.MediaMetadataRetriever
 import org.matrix.android.sdk.api.session.content.ContentAttachmentData
+import org.matrix.android.sdk.api.util.MimeTypes
 import timber.log.Timber
 import java.io.ByteArrayOutputStream
 
@@ -58,7 +59,7 @@ internal object ThumbnailExtractor {
                     height = thumbnailHeight,
                     size = thumbnailSize.toLong(),
                     bytes = outputStream.toByteArray(),
-                    mimeType = "image/jpeg"
+                    mimeType = MimeTypes.Jpeg
             )
             thumbnail.recycle()
             outputStream.reset()

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/content/UploadContentWorker.kt

@@ -29,6 +29,7 @@ import org.matrix.android.sdk.api.session.room.model.message.MessageContent
 import org.matrix.android.sdk.api.session.room.model.message.MessageFileContent
 import org.matrix.android.sdk.api.session.room.model.message.MessageImageContent
 import org.matrix.android.sdk.api.session.room.model.message.MessageVideoContent
+import org.matrix.android.sdk.api.util.MimeTypes
 import org.matrix.android.sdk.internal.crypto.attachments.MXEncryptedAttachments
 import org.matrix.android.sdk.internal.crypto.model.rest.EncryptedFileInfo
 import org.matrix.android.sdk.internal.database.mapper.ContentMapper
@@ -151,7 +152,10 @@ internal class UploadContentWorker(val context: Context, params: WorkerParameter
                         params.attachment.size
                 )
 
-                if (attachment.type == ContentAttachmentData.Type.IMAGE && params.compressBeforeSending) {
+                if (attachment.type == ContentAttachmentData.Type.IMAGE
+                        // Do not compress gif
+                        && attachment.mimeType != MimeTypes.Gif
+                        && params.compressBeforeSending) {
                     fileToUpload = imageCompressor.compress(context, workingFile, MAX_IMAGE_SIZE, MAX_IMAGE_SIZE)
                             .also { compressedFile ->
                                 // Get new Bitmap size
@@ -174,14 +178,15 @@ internal class UploadContentWorker(val context: Context, params: WorkerParameter
                     }
                 }
 
+                val encryptedFile: File?
                 val contentUploadResponse = if (params.isEncrypted) {
                     Timber.v("## FileService: Encrypt file")
 
-                    val tmpEncrypted = File.createTempFile(UUID.randomUUID().toString(), null, context.cacheDir)
+                    encryptedFile = File.createTempFile(UUID.randomUUID().toString(), null, context.cacheDir)
                             .also { filesToDelete.add(it) }
 
                     uploadedFileEncryptedFileInfo =
-                            MXEncryptedAttachments.encrypt(fileToUpload.inputStream(), attachment.getSafeMimeType(), tmpEncrypted) { read, total ->
+                            MXEncryptedAttachments.encrypt(fileToUpload.inputStream(), attachment.getSafeMimeType(), encryptedFile) { read, total ->
                                 notifyTracker(params) {
                                     contentUploadStateTracker.setEncrypting(it, read.toLong(), total.toLong())
                                 }
@@ -190,18 +195,23 @@ internal class UploadContentWorker(val context: Context, params: WorkerParameter
                     Timber.v("## FileService: Uploading file")
 
                     fileUploader
-                            .uploadFile(tmpEncrypted, attachment.name, "application/octet-stream", progressListener)
+                            .uploadFile(encryptedFile, attachment.name, MimeTypes.OctetStream, progressListener)
                 } else {
                     Timber.v("## FileService: Clear file")
+                    encryptedFile = null
                     fileUploader
                             .uploadFile(fileToUpload, attachment.name, attachment.getSafeMimeType(), progressListener)
                 }
 
                 Timber.v("## FileService: Update cache storage for ${contentUploadResponse.contentUri}")
                 try {
-                    context.contentResolver.openInputStream(attachment.queryUri)?.let {
+                    fileService.storeDataFor(
-                        fileService.storeDataFor(contentUploadResponse.contentUri, params.attachment.getSafeMimeType(), it)
+                            mxcUrl = contentUploadResponse.contentUri,
-                    }
+                            filename = params.attachment.name,
+                            mimeType = params.attachment.getSafeMimeType(),
+                            originalFile = workingFile,
+                            encryptedFile = encryptedFile
+                    )
                     Timber.v("## FileService: cache storage updated")
                 } catch (failure: Throwable) {
                     Timber.e(failure, "## FileService: Failed to update file cache")
@@ -252,7 +262,7 @@ internal class UploadContentWorker(val context: Context, params: WorkerParameter
                             val encryptionResult = MXEncryptedAttachments.encryptAttachment(thumbnailData.bytes.inputStream(), thumbnailData.mimeType)
                             val contentUploadResponse = fileUploader.uploadByteArray(encryptionResult.encryptedByteArray,
                                     "thumb_${params.attachment.name}",
-                                    "application/octet-stream",
+                                    MimeTypes.OctetStream,
                                     thumbnailProgressListener)
                             UploadThumbnailResult(
                                     contentUploadResponse.contentUri,

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/directory/DirectoryAPI.kt

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.session.directory
+
+import org.matrix.android.sdk.internal.network.NetworkConstants
+import org.matrix.android.sdk.internal.session.room.alias.AddRoomAliasBody
+import org.matrix.android.sdk.internal.session.room.alias.RoomAliasDescription
+import retrofit2.Call
+import retrofit2.http.Body
+import retrofit2.http.DELETE
+import retrofit2.http.GET
+import retrofit2.http.PUT
+import retrofit2.http.Path
+
+internal interface DirectoryAPI {
+    /**
+     * Get the room ID associated to the room alias.
+     *
+     * @param roomAlias the room alias.
+     */
+    @GET(NetworkConstants.URI_API_PREFIX_PATH_R0 + "directory/room/{roomAlias}")
+    fun getRoomIdByAlias(@Path("roomAlias") roomAlias: String): Call<RoomAliasDescription>
+
+    /**
+     * Get the room directory visibility.
+     *
+     * @param roomId the room id.
+     */
+    @GET(NetworkConstants.URI_API_PREFIX_PATH_R0 + "directory/list/room/{roomId}")
+    fun getRoomDirectoryVisibility(@Path("roomId") roomId: String): Call<RoomDirectoryVisibilityJson>
+
+    /**
+     * Set the room directory visibility.
+     *
+     * @param roomId the room id.
+     * @param body the body containing the new directory visibility
+     */
+    @PUT(NetworkConstants.URI_API_PREFIX_PATH_R0 + "directory/list/room/{roomId}")
+    fun setRoomDirectoryVisibility(@Path("roomId") roomId: String,
+                                   @Body body: RoomDirectoryVisibilityJson): Call<Unit>
+
+    /**
+     * Add alias to the room.
+     * @param roomAlias the room alias.
+     */
+    @PUT(NetworkConstants.URI_API_PREFIX_PATH_R0 + "directory/room/{roomAlias}")
+    fun addRoomAlias(@Path("roomAlias") roomAlias: String,
+                     @Body body: AddRoomAliasBody): Call<Unit>
+
+    /**
+     * Delete a room alias
+     * @param roomAlias the room alias.
+     */
+    @DELETE(NetworkConstants.URI_API_PREFIX_PATH_R0 + "directory/room/{roomAlias}")
+    fun deleteRoomAlias(@Path("roomAlias") roomAlias: String): Call<Unit>
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/directory/RoomDirectoryVisibilityJson.kt

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.session.directory
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import org.matrix.android.sdk.api.session.room.model.RoomDirectoryVisibility
+
+@JsonClass(generateAdapter = true)
+internal data class RoomDirectoryVisibilityJson(
+        /**
+         * The visibility of the room in the directory. One of: ["private", "public"]
+         */
+        @Json(name = "visibility") val visibility: RoomDirectoryVisibility
+)

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

@@ -22,19 +22,12 @@ import retrofit2.Call
 import retrofit2.http.GET
 
 internal interface CapabilitiesAPI {
-
     /**
      * Request the homeserver capabilities
      */
     @GET(NetworkConstants.URI_API_PREFIX_PATH_R0 + "capabilities")
     fun getCapabilities(): Call<GetCapabilitiesResult>
 
-    /**
-     * Request the upload capabilities
-     */
-    @GET(NetworkConstants.URI_API_MEDIA_PREFIX_PATH_R0 + "config")
-    fun getUploadCapabilities(): Call<GetUploadCapabilitiesResult>
-
     /**
      * Request the versions
      */

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

@@ -29,6 +29,8 @@ import org.matrix.android.sdk.internal.di.SessionDatabase
 import org.matrix.android.sdk.internal.di.UserId
 import org.matrix.android.sdk.internal.network.executeRequest
 import org.matrix.android.sdk.internal.session.integrationmanager.IntegrationManagerConfigExtractor
+import org.matrix.android.sdk.internal.session.media.GetMediaConfigResult
+import org.matrix.android.sdk.internal.session.media.MediaAPI
 import org.matrix.android.sdk.internal.task.Task
 import org.matrix.android.sdk.internal.util.awaitTransaction
 import org.matrix.android.sdk.internal.wellknown.GetWellknownTask
@@ -40,6 +42,7 @@ internal interface GetHomeServerCapabilitiesTask : Task<Unit, Unit>
 
 internal class DefaultGetHomeServerCapabilitiesTask @Inject constructor(
         private val capabilitiesAPI: CapabilitiesAPI,
+        private val mediaAPI: MediaAPI,
         @SessionDatabase private val monarchy: Monarchy,
         private val eventBus: EventBus,
         private val getWellknownTask: GetWellknownTask,
@@ -67,9 +70,9 @@ internal class DefaultGetHomeServerCapabilitiesTask @Inject constructor(
             }
         }.getOrNull()
 
-        val uploadCapabilities = runCatching {
+        val mediaConfig = runCatching {
-            executeRequest<GetUploadCapabilitiesResult>(eventBus) {
+            executeRequest<GetMediaConfigResult>(eventBus) {
-                apiCall = capabilitiesAPI.getUploadCapabilities()
+                apiCall = mediaAPI.getMediaConfig()
             }
         }.getOrNull()
 
@@ -83,11 +86,11 @@ internal class DefaultGetHomeServerCapabilitiesTask @Inject constructor(
             getWellknownTask.execute(GetWellknownTask.Params(userId, homeServerConnectionConfig))
         }.getOrNull()
 
-        insertInDb(capabilities, uploadCapabilities, versions, wellknownResult)
+        insertInDb(capabilities, mediaConfig, versions, wellknownResult)
     }
 
     private suspend fun insertInDb(getCapabilitiesResult: GetCapabilitiesResult?,
-                                   getUploadCapabilitiesResult: GetUploadCapabilitiesResult?,
+                                   getMediaConfigResult: GetMediaConfigResult?,
                                    getVersionResult: Versions?,
                                    getWellknownResult: WellknownResult?) {
         monarchy.awaitTransaction { realm ->
@@ -97,8 +100,8 @@ internal class DefaultGetHomeServerCapabilitiesTask @Inject constructor(
                 homeServerCapabilitiesEntity.canChangePassword = getCapabilitiesResult.canChangePassword()
             }
 
-            if (getUploadCapabilitiesResult != null) {
+            if (getMediaConfigResult != null) {
-                homeServerCapabilitiesEntity.maxUploadFileSize = getUploadCapabilitiesResult.maxUploadSize
+                homeServerCapabilitiesEntity.maxUploadFileSize = getMediaConfigResult.maxUploadSize
                         ?: HomeServerCapabilities.MAX_UPLOAD_FILE_SIZE_UNKNOWN
             }
 

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/integrationmanager/DefaultIntegrationManagerService.kt

@@ -16,10 +16,8 @@
 
 package org.matrix.android.sdk.internal.session.integrationmanager
 
-import org.matrix.android.sdk.api.MatrixCallback
 import org.matrix.android.sdk.api.session.integrationmanager.IntegrationManagerConfig
 import org.matrix.android.sdk.api.session.integrationmanager.IntegrationManagerService
-import org.matrix.android.sdk.api.util.Cancelable
 import javax.inject.Inject
 
 internal class DefaultIntegrationManagerService @Inject constructor(private val integrationManager: IntegrationManager) : IntegrationManagerService {
@@ -44,20 +42,20 @@ internal class DefaultIntegrationManagerService @Inject constructor(private val
         return integrationManager.isIntegrationEnabled()
     }
 
-    override fun setIntegrationEnabled(enable: Boolean, callback: MatrixCallback<Unit>): Cancelable {
+    override suspend fun setIntegrationEnabled(enable: Boolean) {
-        return integrationManager.setIntegrationEnabled(enable, callback)
+        integrationManager.setIntegrationEnabled(enable)
     }
 
-    override fun setWidgetAllowed(stateEventId: String, allowed: Boolean, callback: MatrixCallback<Unit>): Cancelable {
+    override suspend fun setWidgetAllowed(stateEventId: String, allowed: Boolean) {
-        return integrationManager.setWidgetAllowed(stateEventId, allowed, callback)
+        integrationManager.setWidgetAllowed(stateEventId, allowed)
     }
 
     override fun isWidgetAllowed(stateEventId: String): Boolean {
         return integrationManager.isWidgetAllowed(stateEventId)
     }
 
-    override fun setNativeWidgetDomainAllowed(widgetType: String, domain: String, allowed: Boolean, callback: MatrixCallback<Unit>): Cancelable {
+    override suspend fun setNativeWidgetDomainAllowed(widgetType: String, domain: String, allowed: Boolean) {
-        return integrationManager.setNativeWidgetDomainAllowed(widgetType, domain, allowed, callback)
+        integrationManager.setNativeWidgetDomainAllowed(widgetType, domain, allowed)
     }
 
     override fun isNativeWidgetDomainAllowed(widgetType: String, domain: String): Boolean {

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/integrationmanager/IntegrationManager.kt

@@ -20,15 +20,12 @@ import androidx.lifecycle.Lifecycle
 import androidx.lifecycle.LifecycleOwner
 import androidx.lifecycle.LifecycleRegistry
 import com.zhuinden.monarchy.Monarchy
-import org.matrix.android.sdk.api.MatrixCallback
 import org.matrix.android.sdk.api.MatrixConfiguration
 import org.matrix.android.sdk.api.session.events.model.toModel
 import org.matrix.android.sdk.api.session.integrationmanager.IntegrationManagerConfig
 import org.matrix.android.sdk.api.session.integrationmanager.IntegrationManagerService
 import org.matrix.android.sdk.api.session.widgets.model.WidgetContent
 import org.matrix.android.sdk.api.session.widgets.model.WidgetType
-import org.matrix.android.sdk.api.util.Cancelable
-import org.matrix.android.sdk.api.util.NoOpCancellable
 import org.matrix.android.sdk.internal.database.model.WellknownIntegrationManagerConfigEntity
 import org.matrix.android.sdk.internal.di.SessionDatabase
 import org.matrix.android.sdk.internal.extensions.observeNotNull
@@ -41,7 +38,6 @@ import org.matrix.android.sdk.internal.session.user.accountdata.UpdateUserAccoun
 import org.matrix.android.sdk.internal.session.widgets.helper.WidgetFactory
 import org.matrix.android.sdk.internal.session.widgets.helper.extractWidgetSequence
 import org.matrix.android.sdk.internal.task.TaskExecutor
-import org.matrix.android.sdk.internal.task.configureWith
 import timber.log.Timber
 import javax.inject.Inject
 
@@ -137,22 +133,17 @@ internal class IntegrationManager @Inject constructor(matrixConfiguration: Matri
         return integrationProvisioningContent?.enabled ?: false
     }
 
-    fun setIntegrationEnabled(enable: Boolean, callback: MatrixCallback<Unit>): Cancelable {
+    suspend fun setIntegrationEnabled(enable: Boolean) {
         val isIntegrationEnabled = isIntegrationEnabled()
         if (enable == isIntegrationEnabled) {
-            callback.onSuccess(Unit)
+            return
-            return NoOpCancellable
         }
         val integrationProvisioningContent = IntegrationProvisioningContent(enabled = enable)
         val params = UpdateUserAccountDataTask.IntegrationProvisioning(integrationProvisioningContent = integrationProvisioningContent)
-        return updateUserAccountDataTask
+        return updateUserAccountDataTask.execute(params)
-                .configureWith(params) {
-                    this.callback = callback
-                }
-                .executeBy(taskExecutor)
     }
 
-    fun setWidgetAllowed(stateEventId: String, allowed: Boolean, callback: MatrixCallback<Unit>): Cancelable {
+    suspend fun setWidgetAllowed(stateEventId: String, allowed: Boolean) {
         val currentAllowedWidgets = accountDataDataSource.getAccountDataEvent(UserAccountDataTypes.TYPE_ALLOWED_WIDGETS)
         val currentContent = currentAllowedWidgets?.content?.toModel<AllowedWidgetsContent>()
         val newContent = if (currentContent == null) {
@@ -165,11 +156,7 @@ internal class IntegrationManager @Inject constructor(matrixConfiguration: Matri
             currentContent.copy(widgets = allowedWidgets)
         }
         val params = UpdateUserAccountDataTask.AllowedWidgets(allowedWidgetsContent = newContent)
-        return updateUserAccountDataTask
+        return updateUserAccountDataTask.execute(params)
-                .configureWith(params) {
-                    this.callback = callback
-                }
-                .executeBy(taskExecutor)
     }
 
     fun isWidgetAllowed(stateEventId: String): Boolean {
@@ -178,7 +165,7 @@ internal class IntegrationManager @Inject constructor(matrixConfiguration: Matri
         return currentContent?.widgets?.get(stateEventId) ?: false
     }
 
-    fun setNativeWidgetDomainAllowed(widgetType: String, domain: String, allowed: Boolean, callback: MatrixCallback<Unit>): Cancelable {
+    suspend fun setNativeWidgetDomainAllowed(widgetType: String, domain: String, allowed: Boolean) {
         val currentAllowedWidgets = accountDataDataSource.getAccountDataEvent(UserAccountDataTypes.TYPE_ALLOWED_WIDGETS)
         val currentContent = currentAllowedWidgets?.content?.toModel<AllowedWidgetsContent>()
         val newContent = if (currentContent == null) {
@@ -195,11 +182,7 @@ internal class IntegrationManager @Inject constructor(matrixConfiguration: Matri
             currentContent.copy(native = nativeAllowedWidgets)
         }
         val params = UpdateUserAccountDataTask.AllowedWidgets(allowedWidgetsContent = newContent)
-        return updateUserAccountDataTask
+        return updateUserAccountDataTask.execute(params)
-                .configureWith(params) {
-                    this.callback = callback
-                }
-                .executeBy(taskExecutor)
     }
 
     fun isNativeWidgetDomainAllowed(widgetType: String, domain: String?): Boolean {

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/media/ClearPreviewUrlCacheTask.kt

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.session.media
+
+import com.zhuinden.monarchy.Monarchy
+import io.realm.kotlin.where
+import org.matrix.android.sdk.internal.database.model.PreviewUrlCacheEntity
+import org.matrix.android.sdk.internal.di.SessionDatabase
+import org.matrix.android.sdk.internal.task.Task
+import org.matrix.android.sdk.internal.util.awaitTransaction
+import javax.inject.Inject
+
+internal interface ClearPreviewUrlCacheTask : Task<Unit, Unit>
+
+internal class DefaultClearPreviewUrlCacheTask @Inject constructor(
+        @SessionDatabase private val monarchy: Monarchy
+) : ClearPreviewUrlCacheTask {
+
+    override suspend fun execute(params: Unit) {
+        monarchy.awaitTransaction { realm ->
+            realm.where<PreviewUrlCacheEntity>()
+                    .findAll()
+                    .deleteAllFromRealm()
+        }
+    }
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/media/DefaultMediaService.kt

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.session.media
+
+import androidx.collection.LruCache
+import org.matrix.android.sdk.api.cache.CacheStrategy
+import org.matrix.android.sdk.api.session.events.model.Event
+import org.matrix.android.sdk.api.session.media.MediaService
+import org.matrix.android.sdk.api.session.media.PreviewUrlData
+import org.matrix.android.sdk.api.util.JsonDict
+import org.matrix.android.sdk.internal.util.getOrPut
+import javax.inject.Inject
+
+internal class DefaultMediaService @Inject constructor(
+        private val clearPreviewUrlCacheTask: ClearPreviewUrlCacheTask,
+        private val getPreviewUrlTask: GetPreviewUrlTask,
+        private val getRawPreviewUrlTask: GetRawPreviewUrlTask,
+        private val urlsExtractor: UrlsExtractor
+) : MediaService {
+    // Cache of extracted URLs
+    private val extractedUrlsCache = LruCache<String, List<String>>(1_000)
+
+    override fun extractUrls(event: Event): List<String> {
+        return extractedUrlsCache.getOrPut(event.cacheKey()) { urlsExtractor.extract(event) }
+    }
+
+    private fun Event.cacheKey() = "${eventId ?: ""}-${roomId ?: ""}"
+
+    override suspend fun getRawPreviewUrl(url: String, timestamp: Long?): JsonDict {
+        return getRawPreviewUrlTask.execute(GetRawPreviewUrlTask.Params(url, timestamp))
+    }
+
+    override suspend fun getPreviewUrl(url: String, timestamp: Long?, cacheStrategy: CacheStrategy): PreviewUrlData {
+        return getPreviewUrlTask.execute(GetPreviewUrlTask.Params(url, timestamp, cacheStrategy))
+    }
+
+    override suspend fun clearCache() {
+        extractedUrlsCache.evictAll()
+        clearPreviewUrlCacheTask.execute(Unit)
+    }
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/media/GetMediaConfigResult.kt

@@ -5,7 +5,7 @@
  * 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
+ *     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,
@@ -14,13 +14,13 @@
  * limitations under the License.
  */
 
-package org.matrix.android.sdk.internal.session.homeserver
+package org.matrix.android.sdk.internal.session.media
 
 import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
 
 @JsonClass(generateAdapter = true)
-internal data class GetUploadCapabilitiesResult(
+internal data class GetMediaConfigResult(
         /**
          * The maximum size an upload can be in bytes. Clients SHOULD use this as a guide when uploading content.
          * If not listed or null, the size limit should be treated as unknown.

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/media/GetPreviewUrlTask.kt

@@ -0,0 +1,122 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.session.media
+
+import com.zhuinden.monarchy.Monarchy
+import org.greenrobot.eventbus.EventBus
+import org.matrix.android.sdk.api.cache.CacheStrategy
+import org.matrix.android.sdk.api.session.media.PreviewUrlData
+import org.matrix.android.sdk.api.util.JsonDict
+import org.matrix.android.sdk.internal.database.model.PreviewUrlCacheEntity
+import org.matrix.android.sdk.internal.database.query.get
+import org.matrix.android.sdk.internal.database.query.getOrCreate
+import org.matrix.android.sdk.internal.di.SessionDatabase
+import org.matrix.android.sdk.internal.network.executeRequest
+import org.matrix.android.sdk.internal.task.Task
+import org.matrix.android.sdk.internal.util.awaitTransaction
+import java.util.Date
+import javax.inject.Inject
+
+internal interface GetPreviewUrlTask : Task<GetPreviewUrlTask.Params, PreviewUrlData> {
+    data class Params(
+            val url: String,
+            val timestamp: Long?,
+            val cacheStrategy: CacheStrategy
+    )
+}
+
+internal class DefaultGetPreviewUrlTask @Inject constructor(
+        private val mediaAPI: MediaAPI,
+        private val eventBus: EventBus,
+        @SessionDatabase private val monarchy: Monarchy
+) : GetPreviewUrlTask {
+
+    override suspend fun execute(params: GetPreviewUrlTask.Params): PreviewUrlData {
+        return when (params.cacheStrategy) {
+            CacheStrategy.NoCache -> doRequest(params.url, params.timestamp)
+            is CacheStrategy.TtlCache -> doRequestWithCache(
+                    params.url,
+                    params.timestamp,
+                    params.cacheStrategy.validityDurationInMillis,
+                    params.cacheStrategy.strict
+            )
+            CacheStrategy.InfiniteCache -> doRequestWithCache(
+                    params.url,
+                    params.timestamp,
+                    Long.MAX_VALUE,
+                    true
+            )
+        }
+    }
+
+    private suspend fun doRequest(url: String, timestamp: Long?): PreviewUrlData {
+        return executeRequest<JsonDict>(eventBus) {
+            apiCall = mediaAPI.getPreviewUrlData(url, timestamp)
+        }
+                .toPreviewUrlData(url)
+    }
+
+    private fun JsonDict.toPreviewUrlData(url: String): PreviewUrlData {
+        return PreviewUrlData(
+                url = (get("og:url") as? String) ?: url,
+                siteName = get("og:site_name") as? String,
+                title = get("og:title") as? String,
+                description = get("og:description") as? String,
+                mxcUrl = get("og:image") as? String
+        )
+    }
+
+    private suspend fun doRequestWithCache(url: String, timestamp: Long?, validityDurationInMillis: Long, strict: Boolean): PreviewUrlData {
+        // Get data from cache
+        var dataFromCache: PreviewUrlData? = null
+        var isCacheValid = false
+        monarchy.doWithRealm { realm ->
+            val entity = PreviewUrlCacheEntity.get(realm, url)
+            dataFromCache = entity?.toDomain()
+            isCacheValid = entity != null && Date().time < entity.lastUpdatedTimestamp + validityDurationInMillis
+        }
+
+        val finalDataFromCache = dataFromCache
+        if (finalDataFromCache != null && isCacheValid) {
+            return finalDataFromCache
+        }
+
+        // No cache or outdated cache
+        val data = try {
+            doRequest(url, timestamp)
+        } catch (throwable: Throwable) {
+            // In case of error, we can return value from cache even if outdated
+            return finalDataFromCache
+                    ?.takeIf { !strict }
+                    ?: throw throwable
+        }
+
+        // Store cache
+        monarchy.awaitTransaction { realm ->
+            val previewUrlCacheEntity = PreviewUrlCacheEntity.getOrCreate(realm, url)
+            previewUrlCacheEntity.urlFromServer = data.url
+            previewUrlCacheEntity.siteName = data.siteName
+            previewUrlCacheEntity.title = data.title
+            previewUrlCacheEntity.description = data.description
+            previewUrlCacheEntity.mxcUrl = data.mxcUrl
+
+            previewUrlCacheEntity.lastUpdatedTimestamp = Date().time
+        }
+
+        return data
+    }
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/media/GetRawPreviewUrlTask.kt

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2020 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.internal.session.media
+
+import org.greenrobot.eventbus.EventBus
+import org.matrix.android.sdk.api.util.JsonDict
+import org.matrix.android.sdk.internal.network.executeRequest
+import org.matrix.android.sdk.internal.task.Task
+import javax.inject.Inject
+
+internal interface GetRawPreviewUrlTask : Task<GetRawPreviewUrlTask.Params, JsonDict> {
+    data class Params(
+            val url: String,
+            val timestamp: Long?
+    )
+}
+
+internal class DefaultGetRawPreviewUrlTask @Inject constructor(
+        private val mediaAPI: MediaAPI,
+        private val eventBus: EventBus
+) : GetRawPreviewUrlTask {
+
+    override suspend fun execute(params: GetRawPreviewUrlTask.Params): JsonDict {
+        return executeRequest(eventBus) {
+            apiCall = mediaAPI.getPreviewUrlData(params.url, params.timestamp)
+        }
+    }
+}