Merge branch 'release/0.9.1'

Feature/hot fix filter

.buildkite/pipeline.yml

@@ -1,31 +1,68 @@
 # Use Docker file from https://hub.docker.com/r/runmymind/docker-android-sdk
 # Last docker plugin version can be found here:
 # https://github.com/buildkite-plugins/docker-buildkite-plugin/releases
-
-# Build debug version of the RiotX application, from the develop branch and the features branches
+# We propagate the environment to the container (sse https://github.com/buildkite-plugins/docker-buildkite-plugin#propagate-environment-optional-boolean)
 
 steps:
-  - label: "Assemble Debug version"
+  - label: "Compile and run Unit tests"
     agents:
       # We use a medium sized instance instead of the normal small ones because
-      # gradle build is long
+      # gradle build can be memory hungry
       queue: "medium"
     commands:
-      - "./gradlew clean lintGplayRelease assembleGplayDebug --stacktrace"
-      - "./gradlew lintFdroidRelease assembleFdroidDebug --stacktrace"
-    artifact_paths:
-      - "vector/build/outputs/apk/gplay/debug/*.apk"
-      - "vector/build/outputs/apk/fdroid/debug/*.apk"
-    branches: "develop feature/*"
+      - "./gradlew clean test --stacktrace"
     plugins:
       - docker#v3.1.0:
           image: "runmymind/docker-android-sdk"
+          propagate-environment: true
+
+  - label: "Compile Android tests"
+    agents:
+      # We use a medium sized instance instead of the normal small ones because
+      # gradle build can be memory hungry
+      queue: "medium"
+    commands:
+      - "./gradlew clean assembleAndroidTest --stacktrace"
+    plugins:
+      - docker#v3.1.0:
+          image: "runmymind/docker-android-sdk"
+          propagate-environment: true
+
+  - label: "Assemble GPlay Debug version"
+    agents:
+      # We use a xlarge sized instance instead of the normal small ones because
+      # gradle build can be memory hungry
+      queue: "xlarge"
+    commands:
+      - "./gradlew clean lintGplayRelease assembleGplayDebug --stacktrace"
+    artifact_paths:
+      - "vector/build/outputs/apk/gplay/debug/*.apk"
+    branches: "!master"
+    plugins:
+      - docker#v3.1.0:
+          image: "runmymind/docker-android-sdk"
+          propagate-environment: true
+
+  - label: "Assemble FDroid Debug version"
+    agents:
+      # We use a xlarge sized instance instead of the normal small ones because
+      # gradle build can be memory hungry
+      queue: "xlarge"
+    commands:
+      - "./gradlew clean lintFdroidRelease assembleFdroidDebug --stacktrace"
+    artifact_paths:
+      - "vector/build/outputs/apk/fdroid/debug/*.apk"
+    branches: "!master"
+    plugins:
+      - docker#v3.1.0:
+          image: "runmymind/docker-android-sdk"
+          propagate-environment: true
 
   - label: "Build Google Play unsigned APK"
     agents:
-      # We use a medium sized instance instead of the normal small ones because
-      # gradle build is long
-      queue: "medium"
+      # We use a xlarge sized instance instead of the normal small ones because
+      # gradle build can be memory hungry
+      queue: "xlarge"
     commands:
       - "./gradlew clean assembleGplayRelease --stacktrace"
     artifact_paths:
@@ -33,9 +70,19 @@ steps:
     branches: "master"
     plugins:
       - docker#v3.1.0:
-        image: "runmymind/docker-android-sdk"
+          image: "runmymind/docker-android-sdk"
+          propagate-environment: true
 
   # Code quality
 
   - label: "Code quality"
-    command: "./tools/check/check_code_quality.sh"
+    command:
+      - "./tools/check/check_code_quality.sh"
+
+  - label: "ktlint"
+    command:
+      - "curl -sSLO https://github.com/pinterest/ktlint/releases/download/0.34.2/ktlint && chmod a+x ktlint"
+      - "./ktlint --android --experimental -v"
+    plugins:
+      - docker#v3.1.0:
+          image: "openjdk"

.editorconfig

@@ -0,0 +1,32 @@
+# For ktlint configuration. Ref: https://ktlint.github.io/
+
+[*.{kt,kts}]
+# possible values: number (e.g. 2), "unset" (makes ktlint ignore indentation completely)
+indent_size=unset
+# true (recommended) / false
+insert_final_newline=true
+# possible values: number (e.g. 120) (package name, imports & comments are ignored), "off"
+# it's automatically set to 100 on `ktlint --android ...` (per Android Kotlin Style Guide)
+max_line_length=off
+
+# Comma-separated list of rules to disable (Since 0.34.0)
+# Note that rules in any ruleset other than the standard ruleset will need to be prefixed
+# by the ruleset identifier.
+disabled_rules=no-wildcard-imports,no-multi-spaces,colon-spacing,chain-wrapping,import-ordering,experimental:annotation
+
+# The following (so far identified) rules are kept:
+# no-blank-line-before-rbrace
+# final-newline
+# no-consecutive-blank-lines
+# comment-spacing
+# filename
+# comma-spacing
+# paren-spacing
+# op-spacing
+# string-template
+# no-unused-imports
+# curly-spacing
+# no-semi
+# no-empty-class-body
+# experimental:multiline-if-else
+# experimental:no-empty-first-line-in-method-block

.gitignore

@@ -1,14 +1,18 @@
 *.iml
 .gradle
 /local.properties
-.idea/*
-/.idea/*
-/.idea/libraries
-/.idea/modules.xml
-/.idea/workspace.xml
+# idea files: exclude everything except dictionnaries
+.idea/caches
+.idea/codeStyles
+.idea/libraries
+.idea/*.xml
 .DS_Store
 /build
 /captures
 .externalNativeBuild
 
 /tmp
+
+ktlint
+.idea/copyright/New_vector.xml
+.idea/copyright/profiles_settings.xml

.idea/dictionaries/bmarty.xml

@@ -0,0 +1,24 @@
+<component name="ProjectDictionaryState">
+  <dictionary name="bmarty">
+    <words>
+      <w>backstack</w>
+      <w>bytearray</w>
+      <w>checkables</w>
+      <w>ciphertext</w>
+      <w>coroutine</w>
+      <w>decryptor</w>
+      <w>emoji</w>
+      <w>emojis</w>
+      <w>hmac</w>
+      <w>ktlint</w>
+      <w>linkified</w>
+      <w>linkify</w>
+      <w>megolm</w>
+      <w>msisdn</w>
+      <w>pbkdf</w>
+      <w>pkcs</w>
+      <w>signin</w>
+      <w>signup</w>
+    </words>
+  </dictionary>
+</component>

CHANGES.md

@@ -1,24 +1,213 @@
-Changes in RiotX 0.XX (2019-XX-XX)
+Changes in RiotX 0.9.1 (2019-12-05)
+===================================================
+
+Bugfix 🐛:
+ - Fix an issue with DB transaction (#740)
+
+Changes in RiotX 0.9.0 (2019-12-05)
+===================================================
+
+Features ✨:
+ - Account creation. It's now possible to create account on any homeserver with RiotX (#34)
+ - Iteration of the login flow (#613)
+
+Improvements 🙌:
+ - Send mention Pills from composer
+ - Links in message preview in the bottom sheet are now active. 
+ - Rework the read marker to make it more usable
+
+Other changes:
+ - Fix a small grammatical error when an empty room list is shown.
+
+Bugfix 🐛:
+ - Do not show long click help if only invitation are displayed
+ - Fix emoji filtering not working
+ - Fix issue of closing Realm in another thread (#725)
+ - Attempt to properly cancel the crypto module when user signs out (#724)
+
+Changes in RiotX 0.8.0 (2019-11-19)
+===================================================
+
+Features ✨:
+ - Handle long click on room in the room list (#395)
+ - Ignore/UnIgnore users, and display list of ignored users (#542, #617)
+
+Improvements 🙌:
+ - Search reaction by name or keyword in emoji picker
+ - Handle code tags (#567)
+ - Support spoiler messages
+ - Support m.sticker and m.room.join_rules events in timeline
+
+Other changes:
+ - Markdown set to off by default (#412)
+ - Accessibility improvements to the attachment file type chooser
+
+Bugfix 🐛:
+ - Fix issues with some member events rendering (#498)
+ - Passphrase does not match (Export room keys) (#644)
+ - Ask for permission to write external storage when uri comes from the keyboard (#658)
+ - Fix issue with english US/GB translation (#671)
+
+Changes in RiotX 0.7.0 (2019-10-24)
 ===================================================
 
 Features:
- - Contextual action menu for messages in room
+ - Share elements from other app to RiotX (#58)
+ - Read marker (#84)
+ - Add ability to report content (#515)
 
 Improvements:
- -
+ - Persist active tab between sessions (#503)
+ - Do not upload file too big for the homeserver (#587)
+ - Attachments: start using system pickers (#52)
+ - Mark all messages as read (#396)
+
 
 Other changes:
- -
+ - Accessibility improvements to read receipts in the room timeline and reactions emoji chooser
 
 Bugfix:
- -
+ - Fix issue on upload error in loop (#587)
+ - Fix opening a permalink: the targeted event is displayed twice (#556)
+ - Fix opening a permalink paginates all the history up to the last event (#282)
+ - after login, the icon in the top left is a green 'A' for (all communities) rather than my avatar (#267)
+ - Picture uploads are unreliable, pictures are shown in wrong aspect ratio on desktop client (#517)
+ - Invitation notifications are not dismissed automatically if room is joined from another client (#347)
+ - Opening links from RiotX reuses browser tab (#599)
 
-Translations:
- -
+Changes in RiotX 0.6.1 (2019-09-24)
+===================================================
+
+Bugfix:
+ - Fix crash: MergedHeaderItem was missing dimensionConverter
+
+Changes in RiotX 0.6.0 (2019-09-24)
+===================================================
+
+Features:
+ - Save draft of a message when exiting a room with non empty composer (#329)
+
+Improvements:
+ - Add unread indent on room list (#485)
+ - Message Editing: Update notifications (#128)
+ - Remove any notification of a redacted event (#563)
+
+Other changes:
+ - Fix a few accessibility issues
+
+Bugfix:
+ - Fix characters erased from the Search field when the result are coming (#545)
+ - "No connection" banner was displayed by mistake
+ - Leaving community (from another client) has no effect on RiotX (#497)
+ - Push rules was not retrieved after a clear cache
+ - m.notice messages trigger push notifications (#238)
+ - Embiggen messages with multiple emojis also for edited messages (#458)
 
 Build:
- -
+ - Fix (again) issue with bad versionCode generated by Buildkite (#553)
 
+Changes in RiotX 0.5.0 (2019-09-17)
+===================================================
+
+Features:
+ - Implementation of login to homeserver with SSO (#557)
+ - Handle M_CONSENT_NOT_GIVEN error (#64)
+ - Auto configure homeserver and identity server URLs of LoginActivity with a magic link
+
+Improvements:
+ - Reduce default release build log level, and lab option to enable more logs.
+ - Display a no network indicator when there is no network (#559)
+
+Bugfix:
+ - Fix crash due to missing informationData (#535)
+ - Progress in initial sync dialog is decreasing for a step and should not (#532)
+ - Fix rendering issue of accepted third party invitation event
+ - All current notifications were dismissed by mistake when the app is launched from the launcher
+
+Build:
+ - Fix issue with version name (#533)
+ - Fix issue with bad versionCode generated by Buildkite (#553)
+
+Changes in RiotX 0.4.0 (2019-08-30)
+===================================================
+
+Features:
+ - Display read receipts in timeline (#81)
+
+Improvements:
+ - Reactions: Reinstate the ability to react with non-unicode keys (#307)
+
+Bugfix:
+ - Fix text diff linebreak display (#441)
+ - Date change message repeats for each redaction until a normal message (#358)
+ - Slide-in reply icon is distorted (#423)
+ - Regression / e2e replies not encrypted
+ - Some video won't play
+ - Privacy: remove log of notifiable event (#519)
+ - Fix crash with EmojiCompat (#530)
+
+Changes in RiotX 0.3.0 (2019-08-08)
+===================================================
+
+Features:
+ - Create Direct Room flow
+ - Handle `/markdown` command
+
+Improvements:
+ - UI for pending edits (#193)
+ - UX image preview screen transition (#393)
+ - Basic support for resending failed messages (retry/remove)
+ - Enable proper cancellation of suspending functions (including db transaction)
+ - Enhances network connectivity checks in SDK
+ - Add "View Edit History" item in the message bottom sheet (#401)
+ - Cancel sync request on pause and timeout to 0 after pause (#404)
+
+Other changes:
+ - Show sync progress also in room detail screen (#403)
+
+Bugfix:
+ - Edited message: link confusion when (edited) appears in body (#398)
+ - Close detail room screen when the room is left with another client (#256)
+ - Clear notification for a room left on another client
+ - Fix messages with empty `in_reply_to` not rendering (#447)
+ - Fix clear cache (#408) and Logout (#205)
+ - Fix `(edited)` link can be copied to clipboard (#402)
+
+Build:
+ - Split APK: generate one APK per arch, to reduce APK size of about 30%
+
+
+Changes in RiotX 0.2.0 (2019-07-18)
+===================================================
+
+Features:
+ - Message Editing: View edit history (#121)
+ - Rooms filtering (#304)
+ - Edit in encrypted room
+
+Improvements:
+ - Handle click on redacted events: view source and create permalink
+ - Improve long tap menu: reply on top, more compact (#368)
+ - Quick reply in timeline with swipe gesture (#167)
+ - Improve edit of replies
+ - Improve performance on Room Members and Users management (#381)
+
+Other changes:
+ - migrate from rxbinding 2 to rxbinding 3
+
+Bugfix:
+ - Fix regression on permalink click
+ - Fix crash reported by the PlayStore (#341)
+ - Fix Chat composer separator color in dark/black theme
+ - Fix bad layout for room directory filter (#349)
+ - Fix Copying link from a message shouldn't open context menu (#364)
+
+Changes in RiotX 0.1.0 (2019-07-11)
+===================================================
+
+First release!
+
+Mode details here: https://medium.com/@RiotChat/introducing-the-riotx-beta-for-android-b17952e8f771
 
 
 =======================================================
@@ -26,24 +215,24 @@ Build:
 =======================================================
 
 
-Changes in RiotX 0.XX (2019-XX-XX)
+Changes in RiotX 0.0.0 (2019-XX-XX)
 ===================================================
 
-Features:
+Features ✨:
  -
 
-Improvements:
+Improvements 🙌:
  -
 
 Other changes:
  -
 
-Bugfix:
+Bugfix 🐛:
  -
 
-Translations:
+Translations 🗣:
  -
 
-Build:
+Build 🧱:
  -
 

CONTRIBUTING.md

@@ -40,19 +40,45 @@ Please add a line to the top of the file `CHANGES.md` describing your change.
 
 Make sure the following commands execute without any error:
 
-> ./tools/check/check_code_quality.sh
+#### Internal tool
 
-> ./gradlew lintGplayRelease
+<pre>
+./tools/check/check_code_quality.sh
+</pre>
+
+#### ktlint
+
+<pre>
+curl -sSLO https://github.com/pinterest/ktlint/releases/download/0.34.2/ktlint && chmod a+x ktlint
+./ktlint --android --experimental -v
+</pre>
+
+Note that you can run
+
+<pre>
+./ktlint --android --experimental -v -F
+</pre>
+
+For ktlint to fix some detected errors for you (you still have to check and commit the fix of course)
+
+#### lint
+
+<pre>
+./gradlew lintGplayRelease
+./gradlew lintFdroidRelease
+</pre>
 
 ### Unit tests
 
 Make sure the following commands execute without any error:
 
-> ./gradlew testGplayReleaseUnitTest
+<pre>
+./gradlew testGplayReleaseUnitTest
+</pre>
 
 ### Tests
 
-RiotX is currently supported on Android Jelly Bean (API 16+): please test your change on an Android device (or Android emulator) running with API 16. Many issues can happen (including crashes) on older devices.
+RiotX is currently supported on Android KitKat (API 19+): please test your change on an Android device (or Android emulator) running with API 19. Many issues can happen (including crashes) on older devices.
 Also, if possible, please test your change on a real device. Testing on Android emulator may not be sufficient.
 
 ### Internationalisation
@@ -60,6 +86,10 @@ Also, if possible, please test your change on a real device. Testing on Android
 When adding new string resources, please only add new entries in file `value/strings.xml`. Translations will be added later by the community of translators with a specific tool named [Weblate](https://translate.riot.im/projects/riot-android/).
 Do not hesitate to use plurals when appropriate.
 
+### Accessibility
+
+Please consider accessibility as an important point. As a minimum requirement, in layout XML files please use attributes such as `android:contentDescription` and `android:importantForAccessibility`, and test with a screen reader if it's working well. You can add new string resources, dedicated to accessibility, in this case, please prefix theirs id with `a11y_`.
+
 ### Layout
 
 When adding or editing layouts, make sure the layout will render correctly if device uses a RTL (Right To Left) language.

README.md

@@ -1,4 +1,4 @@
-[![Buildkite](https://badge.buildkite.com/657d3db27364448d69d54f66c690f7788bc6aa80a7628e37f3.svg?branch=develop)](https://buildkite.com/matrix-dot-org/riotx-android)
+[![Buildkite](https://badge.buildkite.com/657d3db27364448d69d54f66c690f7788bc6aa80a7628e37f3.svg?branch=develop)](https://buildkite.com/matrix-dot-org/riotx-android/builds?branch=develop)
 [![Weblate](https://translate.riot.im/widgets/riot-android/-/svg-badge.svg)](https://translate.riot.im/engage/riot-android/?utm_source=widget)
 [![RiotX Android Matrix room #riot-android:matrix.org](https://img.shields.io/matrix/riotx:matrix.org.svg?label=%23RiotX:matrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#riotx:matrix.org)
 [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=vector.android.riotx&metric=alert_status)](https://sonarcloud.io/dashboard?id=vector.android.riotx)
@@ -7,14 +7,31 @@
 
 # RiotX Android
 
-RiotX is an Android Matrix Client currently in development. The application is not yet available on the PlayStore. 
+RiotX is an Android Matrix Client currently in beta but in active development.
 
-It's based on a new Matrix SDK, written in Kotlin.
+It is a total rewrite of [Riot-Android](https://github.com/vector-im/riot-android) with a new user experience. RiotX will become the official replacement as soon as all features are implemented.
 
-Download nightly build here: [![Buildkite](https://badge.buildkite.com/657d3db27364448d69d54f66c690f7788bc6aa80a7628e37f3.svg?branch=develop)](https://buildkite.com/matrix-dot-org/riotx-android/builds?branch=develop)
+[<img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" alt="Get it on Google Play" height="60">](https://play.google.com/store/apps/details?id=im.vector.riotx)
+
+Nightly build: [![Buildkite](https://badge.buildkite.com/657d3db27364448d69d54f66c690f7788bc6aa80a7628e37f3.svg?branch=develop)](https://buildkite.com/matrix-dot-org/riotx-android/builds?branch=develop)
+
+# New Android SDK
+
+RiotX is based on a new Android SDK fully written in Kotlin (like RiotX). In order to make the early development as fast as possible, RiotX and the new SDK currently share the same git repository. We will make separate repos once the API is stable enough.
+
+
+# Roadmap
+
+The current target is to release an application out of beta with the same level of features (and even more) as Riot.
+The roadmap has 3 phases:
+
+- [phase 0](https://github.com/vector-im/riotX-android/labels/phase0): Prototyping / Project setup
+- [phase 1](https://github.com/vector-im/riotX-android/labels/phase1): Beta release to the Play Store
+- [phase 2](https://github.com/vector-im/riotX-android/labels/phase2): Out of beta
 
-Matrix Room: [![RiotX Android Matrix room #riot-android:matrix.org](https://img.shields.io/matrix/riotx:matrix.org.svg?label=%23RiotX:matrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#riotx:matrix.org)
 
 ## Contributing
 
-Please refer to [CONTRIBUTING.md](https://github.com/vector-im/riotX-android/blob/develop/CONTRIBUTING.md) if you want to contribute the Matrix on Android projects!
+Please refer to [CONTRIBUTING.md](https://github.com/vector-im/riotX-android/blob/develop/CONTRIBUTING.md) if you want to contribute on Matrix Android projects!
+
+Come chat with the community in the dedicated Matrix [room](https://matrix.to/#/#riotx:matrix.org).

build.gradle

@@ -1,8 +1,7 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 
 buildscript {
-    ext.kotlin_version = '1.3.21'
-    ext.koin_version = '1.0.2'
+    ext.kotlin_version = '1.3.50'
     repositories {
         google()
         jcenter()
@@ -11,11 +10,12 @@ buildscript {
         }
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.3.2'
-        classpath 'com.google.gms:google-services:4.2.0'
-        classpath "com.airbnb.okreplay:gradle-plugin:1.4.0"
+        classpath 'com.android.tools.build:gradle:3.5.1'
+        classpath 'com.google.gms:google-services:4.3.2'
+        classpath "com.airbnb.okreplay:gradle-plugin:1.5.0"
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
-        classpath 'org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:2.6.2'
+        classpath 'org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:2.7.1'
+        classpath 'com.google.android.gms:oss-licenses-plugin:0.9.5'
 
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
@@ -24,12 +24,52 @@ buildscript {
 
 allprojects {
     repositories {
-        maven { url "http://dl.bintray.com/piasy/maven" }
-        maven { url 'https://jitpack.io' }
+        // For olm library. This has to be declared first, to ensure that Olm library is not downloaded from another repo
+        maven {
+            url 'https://jitpack.io'
+            content {
+                // Use this repo only for olm library
+                includeGroupByRegex "org\\.matrix\\.gitlab\\.matrix-org"
+                // And also for FilePicker
+                includeGroupByRegex "com\\.github\\.jaiselrahman"
+                // And monarchy
+                includeGroupByRegex "com\\.github\\.Zhuinden"
+            }
+        }
+        maven {
+            url "http://dl.bintray.com/piasy/maven"
+            content {
+                includeGroupByRegex "com\\.github\\.piasy"
+            }
+        }
         maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
         google()
         jcenter()
+        maven {
+            url 'https://repo.adobe.com/nexus/content/repositories/public/'
+            content {
+                includeGroupByRegex "diff_match_patch"
+            }
+        }
     }
+
+    tasks.withType(JavaCompile).all {
+        options.compilerArgs += [
+                '-Adagger.gradle.incremental=enabled'
+        ]
+    }
+
+    tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).all {
+        // Warnings are potential errors, so stop ignoring them
+        kotlinOptions.allWarningsAsErrors = true
+    }
+
+    afterEvaluate {
+        extensions.findByName("kapt")?.arguments {
+            arg("dagger.gradle.incremental", "enabled")
+        }
+    }
+
 }
 
 task clean(type: Delete) {
@@ -38,6 +78,10 @@ task clean(type: Delete) {
 
 apply plugin: 'org.sonarqube'
 
+// To run a sonar analysis:
+// Run './gradlew sonarqube -Dsonar.login=<REPLACE_WITH_SONAR_KEY>'
+// The SONAR_KEY is stored in passbolt
+
 sonarqube {
     properties {
         property "sonar.projectName", "RiotX-Android"
@@ -63,3 +107,23 @@ project(":vector") {
         }
     }
 }
+
+//project(":matrix-sdk-android") {
+//    sonarqube {
+//        properties {
+//            property "sonar.sources", project(":matrix-sdk-android").android.sourceSets.main.java.srcDirs
+//            // exclude source code from analyses separated by a colon (:)
+//            // property "sonar.exclusions", "**/*.*"
+//        }
+//    }
+//}
+//
+//project(":matrix-sdk-android-rx") {
+//    sonarqube {
+//        properties {
+//            property "sonar.sources", project(":matrix-sdk-android-rx").android.sourceSets.main.java.srcDirs
+//            // exclude source code from analyses separated by a colon (:)
+//            // property "sonar.exclusions", "**/*.*"
+//        }
+//    }
+//}

docs/notifications.md

@@ -0,0 +1,281 @@
+This document aims to describe how RiotX android displays notifications to the end user. It also clarifies notifications and background settings in the app.
+
+# Table of Contents
+1. [Prerequisites Knowledge](#prerequisites-knowledge)
+    * [How does a matrix client gets a message from a Home Server?](#how-does-a-matrix-client-gets-a-message-from-a-home-server)
+    * [How does a mobile app receives push notification?](#how-does-a-mobile-app-receives-push-notification)
+    * [Push VS Notification](#push-vs-notification)
+    * [Push in the matrix federated world](#push-in-the-matrix-federated-world)
+    * [How does the Home Server knows when to notify a client?](#how-does-the-home-server-knows-when-to-notify-a-client)
+    * [Push vs privacy, and mitigation](#push-vs-privacy-and-mitigation)
+    * [Background processing limitations](#background-processing-limitations)
+2. [RiotX Notification implementations](#riotx-notification-implementations)
+    * [Requirements](#requirements) 
+    * [Foreground sync mode (Gplay & F-Droid)](#foreground-sync-mode-gplay-f-droid)
+    * [Push (FCM) received in background](#push-fcm-received-in-background)
+    * [FCM Fallback mode](#fcm-fallback-mode)
+    * [F-Droid background Mode](#f-droid-background-mode)
+3. [Application Settings](#application-settings)
+
+
+First let's start with some prerequisite knowledge
+
+# Prerequisites Knowledge
+
+## How does a matrix client gets a message from a Home Server?
+
+In order to get messages from a home server, a matrix client need to perform a ``sync`` operation.
+
+`To read events, the intended flow of operation is for clients to first call the /sync API without a since parameter. This returns the most recent message events for each room, as well as the state of the room at the start of the returned timeline. `
+
+The client need to call the `sync`API periodically in order to get incremental updates of the server state (new messages).
+This mechanism is known as **HTTP long Polling**.
+
+Using the **HTTP Long Polling** mechanism  a client polls a server requesting new information.
+The server *holds the request open until new data is available*.
+Once available, the server responds and sends the new information.
+When the client receives the new information, it immediately sends another request, and the operation is repeated.
+This effectively emulates a server push feature.
+
+The HTTP long Polling can be fine tuned in the **SDK** using two parameters:
+* timout (Sync request timeout)
+* delay (Delay between each sync)
+
+**timeout** is a server paramter, defined by:
+```
+The maximum time to wait, in milliseconds, before returning this request.`
+If no events (or other data) become available before this time elapses, the server will return a response with empty fields.
+By default, this is 0, so the server will return immediately even if the response is empty.
+```
+
+**delay** is a client preference. When the server responds to a sync request, the client waits for `delay`before calling a new sync.
+
+When the RiotX Android app is open (i.e in foreground state), the default timeout is 30 seconds, and delay is 0.
+
+## How does a mobile app receives push notification
+
+Push notification is used as a way to wake up a mobile application when some important information is available and should be processed.
+
+Typically in order to get push notification, an application relies on a **Push Notification Service** or **Push Provider**.
+
+For example iOS uses APNS (Apple Push Notification Service).
+Most of android devices relies on Google's Firebase Cloud Messaging (FCM).
+ > FCM has replaced Google Cloud Messaging (GCM - deprecated April 10 2018)
+
+FCM will only work on android devices that have Google plays services installed
+(In simple terms, Google Play Services is a background service that runs on Android, which in turn helps in integrating Google’s advanced functionalities to other applications)
+
+De-Googlified devices need to rely on something else in order to stay up to date with a server.
+There some cases when devices with google services cannot use FCM (network infrastructure limitations -firewalls- ,
+ privacy and or independency requirement, source code licence)
+
+## Push VS Notification
+
+This need some disambiguation, because it is the source of common confusion:
+
+
+*The fact that you see a notification on your screen does not mean that you have successfully configured your PUSH plateform.*
+
+  Technically there is a difference between a push and a notification. A notification is what you see on screen and/or in the notification Menu/Drawer (in the top bar of the phone).
+
+  Notifications are not always triggered by a push (One can display a notification locally triggered by an alarm)
+
+
+## Push in the matrix federated world
+
+In order to send a push to a mobile, App developers need to have a server that will use the FCM APIs, and these APIs requires authentication!
+This server is called a **Push Gateway** in the matrix world
+
+That means that RiotX Android, a matrix client created by New Vector, is using a **Push Gateway** with the needed credentials (FCM API secret Key) in order to send push to the New Vector client.
+
+If you create your own matrix client, you will also need to deploy an instance of a **Push Gateway** with the credentials needed to use FCM for your app.
+
+On registration, a matrix client must tell to it's Home Server what Push Gateway to use.
+
+See [Sygnal](https://github.com/matrix-org/sygnal/) for a reference implementation.
+```
+
+                                  +--------------------+  +-------------------+
+                 Matrix HTTP      |                    |  |                   |
+            Notification Protocol |   App Developer    |  |   Device Vendor   |
+                                  |                    |  |                   |
+          +-------------------+   | +----------------+ |  | +---------------+ |
+          |                   |   | |                | |  | |               | |
+          | Matrix homeserver +----->  Push Gateway  +------> Push Provider | |
+          |                   |   | |                | |  | |               | |
+          +-^-----------------+   | +----------------+ |  | +----+----------+ |
+            |                     |                    |  |      |            |
+   Matrix   |                     |                    |  |      |            |
+Client/Server API  +              |                    |  |      |            |
+            |      |              +--------------------+  +-------------------+
+            |   +--+-+                                           |
+            |   |    <-------------------------------------------+
+            +---+    |
+                |    |          Provider Push Protocol
+                +----+
+
+        Mobile Device or Client
+```
+
+Recommended reading:
+ * https://thomask.sdf.org/blog/2016/12/11/riots-magical-push-notifications-in-ios.html
+* https://matrix.org/docs/spec/client_server/r0.4.0.html#id128
+
+
+## How does the Home Server knows when to notify a client?
+
+This is defined by [**push rules**](https://matrix.org/docs/spec/client_server/r0.4.0.html#push-rules-).
+
+`A push rule is a single rule that states under what conditions an event should be passed onto a push gateway and how the notification should be presented (sound / importance).`
+
+A Home Server can be configured with default rules (for Direct messages, group messages, mentions, etc.. ). 
+
+There are different kind of push rules, it can be per room (each new message on this room should be notified), it can also define a pattern that a message should match (when you are mentioned, or key word based).
+
+Notifications have 2 'levels' (`highlighted = true/false sound = default/custom`). In RiotX these notifications level are reflected as Noisy/Silent. 
+
+**What about encrypted messages?**
+
+Of course, content patterns matching cannot be used for encrypted messages server side (as the content is encrypted).
+
+That is why clients are able to **process the push rules client side** to decide what kind of notification should be presented for a given event.
+
+## Push vs privacy, and mitigation
+
+As seen previously, App developers don't directly send a push to the end user's device, they use a Push Provider as intermediary. So technically this intermediary is able to read the content of what is sent.
+
+App developers usually mitigate this by sending a `silent notification`, that is a notification with no identifiable data, or with an encrypted payload. When the push is received the app can then synchronise to it's server in order to generate a local notification.
+
+
+## Background processing limitations
+
+A mobile applications process live in a managed word, meaning that its process can be limited (e.g no network access), stopped or killed at almost anytime by the Operating System.
+
+In order to improve the battery life of their devices some constructors started to implement mechanism to drastically limit background execution of applications (e.g MIUI/Xiaomi restrictions, Sony stamina mode). 
+Then starting android M, android has also put more focus on improving device performances, introducing several IDLE modes, App-Standby, Light Doze, Doze.
+
+In a nutshell, apps can't do much in background now.
+
+If the devices is not plugged and stays IDLE for a certain amount of time, radio (mobile connectivity) and CPU can/will be turned off.
+
+For an application like RiotX, where users can receive important information at anytime, the best option is to rely on a push system (Google's Firebase Message a.k.a FCM). FCM high priority push can wake up the device and whitelist an application to perform background task (for a limited but unspecified amount of time). 
+
+Notice that this is still evolving, and in future versions application that has been 'background restricted' by users won't be able to wake up even when a high priority push is received. Also high priority notifications could be rate limited (not defined anywhere)
+
+It's getting a lot more complicated when you cannot rely on FCM (because: closed sources, network/firewall restrictions, privacy concerns). 
+The documentation on this subject is vague, and as per our experiments not always exact, also device's behaviour is fragmented. 
+
+It is getting more and more complex to have reliable notifications when FCM is not used.
+
+# RiotX Notification implementations
+
+## Requirements
+
+RiotX Android must work with and without FCM.
+* The RiotX android app published on F-Droid do not rely on FCM (all related dependencies are not present)
+* The RiotX android app published on google play rely on FCM, with a fallback mode when FCM registration has failed (e.g outdated or missing Google Play Services)
+
+## Foreground sync mode (Gplay & F-Droid)
+
+When in foreground, RiotX performs sync continuously with a timeout value set to 10 seconds (see HttpPooling).
+
+As this mode does not need to live beyond the scope of the application, and as per Google recommendation, RiotX uses the internal app resources (Thread and Timers) to perform the syncs. 
+
+This mode is turned on when the app enters foreground, and off when enters background.
+
+In background, and depending on wether push is available or not, RiotX will use different methods to perform the syncs (Workers / Alarms / Service)
+
+## Push (FCM) received in background 
+
+In order to enable Push, RiotX must first get a push token from the firebase SDK, then register a pusher with this token on the HomeServer.
+
+When a message should be notified to a user,  the user's homeserver notifies the registered `push gateway` for RiotX, that is [sygnal](https://github.com/matrix-org/sygnal) _- The reference implementation for push gateways -_ hosted by matrix.org. 
+
+This sygnal instance is configured with the required FCM API authentication token, and will then use the FCM API in order to notify the user's device running riotX.
+
+```
+Homeserver ----> Sygnal (configured for RiotX) ----> FCM ----> RiotX
+```
+
+The push gateway is configured to only send  `(eventId,roomId)` in the push payload (for better [privacy](#push-vs-privacy-and-mitigation)).
+
+RiotX needs then to synchronise with the user's HomeServer, in order to resolve the event and create a notification.
+
+As per [Google recommendation](https://android-developers.googleblog.com/2018/09/notifying-your-users-with-fcm.html), RiotX will then use the WorkManager API in order to trigger a background sync. 
+
+**Google recommendations:** 
+>  We recommend using FCM messages in combination with the WorkManager 1 or JobScheduler API
+
+>  Avoid background services. One common pitfall is using a background service to fetch data in the FCM message handler, since background service will be stopped by the system per recent changes to Google Play Policy
+
+```
+Homeserver ----> Sygnal ----> FCM ----> RiotX
+                                        (Sync) ----> Homeserver
+                                               <----
+                                        Display notification
+```
+
+**Possible outcomes**
+
+Upon reception of the FCM push, RiotX will perform a sync call to the Home Server, during this process it is possible that:
+  * Happy path, the sync is performed, the message resolved and displayed in the notification drawer
+  * The notified message is not in the sync. Can happen if a lot of things did happen since the push (`gappy sync`)
+  * The sync generates additional notifications (e.g an encrypted message where the user is mentioned detected locally)
+  * The sync takes too long and the process is killed before completion, or network is not reliable and the sync fails.
+
+RiotX implements several strategies in these cases (TODO document)
+
+## FCM Fallback mode
+
+It is possible that RiotX is not able to get a FCM push token.
+Common errors (amoung several others) that can cause that:
+* Google Play Services is outdated
+* Google Play Service fails in someways with FCM servers (infamous `SERVICE_NOT_AVAILABLE`)
+
+If RiotX is able to detect one of this cases, it will notifies it to the users and when possible help him fix it via a dedicated troubleshoot screen.
+
+Meanwhile, in order to offer a minimal service, and as per Google's recommendation for background activities, RiotX will launch periodic background sync in order to stays in sync with servers.
+
+The fallback mode is impacted by all the battery life saving mechanism implemented by android. Meaning that if the app is not used for a certain amount of time (`App-Standby`), or the device stays still and unplugged (`Light Doze`) , the sync will become less frequent.
+
+And if the device stays unplugged and still for too long (`Doze Mode`), no background sync will be perform at all (the system's `Ignore Battery Optimization option` has no effect on that).
+
+ Also the time interval between sync is elastic, controlled by the system to group other apps background sync request and start radio/cpu only once for all.
+
+Usually in this mode, what happen is when you take back your phone in your hand, you suddenly receive notifications.
+
+The fallback mode is supposed to be a temporary state waiting for the user to fix issues for FCM, or for App Developers that has done a fork to correctly configure their FCM settings.
+
+## F-Droid background Mode
+
+The F-Droid RiotX flavor has no dependencies to FCM, therefore cannot relies on Push.
+
+Also Google's recommended background processing method cannot be applied. This is because all of these methods are affected by IDLE modes, and will result on the user not being notified at all when the app is in a Doze mode (only in maintenance windows that could happens only after hours).
+
+Only solution left is to use `AlarmManager`, that offers new API to allow launching some process even if the App is in IDLE modes.
+
+Notice that these alarms, due to their potential impact on battery life, can still be restricted by the system. Documentation says that they will not be triggered more than every minutes under normal system operation, and when in low power mode about every 15 mn.
+
+These restrictions can be relaxed by requirering the app to be white listed from battery optimization.
+
+F-Droid version will schedule alarms that will then trigger a Broadcast Receiver, that in turn will launch a Service (in the classic android way), and the reschedule an alarm for next time.
+
+Depending on the system status (or device make),  it is still possible that the app is not given enough time to launch the service, or that the radio is still turned off thus preventing the sync to success (that's why Alarms are not recommended for network related tasks).
+
+That is why on RiotX F-Droid, the broadcast receiver will acquire a temporary WAKE_LOCK for several seconds (thus securing cpu/network), and launch the service in foreground. The service performs the sync.
+
+Note that foreground services require to put a notification informing the user that the app is doing something even if not launched).
+
+
+
+# Application Settings
+
+**Notifications > Enable notifications for this account**
+
+Configure Sygnal to send or not notifications to all user devices.
+
+**Notifications > Enable notifications for this device**
+
+Disable notifications locally. The push server will continue to send notifications to the device but this one will ignore them.
+
+

docs/signin.md

@@ -0,0 +1,260 @@
+# Sign in to a homeserver
+
+This document describes the flow of signin to a homeserver, and also the flow when user want to reset his password. Examples come from the `matrix.org` homeserver.
+
+## Sign up flows
+
+### Get the flow
+
+Client request the sign-in flows, once the homeserver is chosen by the user and its url is known (in the example it's `https://matrix.org`)
+
+> curl -X GET 'https://matrix.org/_matrix/client/r0/login'
+
+200
+
+```json
+{
+  "flows": [
+    {
+      "type": "m.login.password"
+    }
+  ]
+}
+```
+
+### Login with username
+
+The user is able to connect using `m.login.password`
+
+> curl -X POST --data $'{"identifier":{"type":"m.id.user","user":"alice"},"password":"weak_password","type":"m.login.password","initial_device_display_name":"Portable"}' 'https://matrix.org/_matrix/client/r0/login'
+
+```json
+{
+  "identifier": {
+    "type": "m.id.user",
+    "user": "alice"
+  },
+  "password": "weak_password",
+  "type": "m.login.password",
+  "initial_device_display_name": "Portable"
+}
+```
+
+#### Incorrect password
+
+403
+
+```json
+{
+  "errcode": "M_FORBIDDEN",
+  "error": "Invalid password"
+}
+```
+
+#### Correct password:
+
+We get credential (200)
+
+```json
+{
+  "user_id": "@benoit0816:matrix.org",
+  "access_token": "MDAxOGxvY2F0aW9uIG1hdHREDACTEDb2l0MDgxNjptYXRyaXgub3JnCjAwMTZjaWQgdHlwZSA9IGFjY2VzcwowMDIxY2lkIG5vbmNlID0gfnYrSypfdTtkNXIuNWx1KgowMDJmc2lnbmF0dXJlIOsh1XqeAkXexh4qcofl_aR4kHJoSOWYGOhE7-ubX-DZCg",
+  "home_server": "matrix.org",
+  "device_id": "GTVREDALBF",
+  "well_known": {
+    "m.homeserver": {
+      "base_url": "https:\/\/matrix.org\/"
+    }
+  }
+}
+```
+
+### Login with email
+
+If the user has associated an email with its account, he can signin using the email.
+
+> curl -X POST --data $'{"identifier":{"type":"m.id.thirdparty","medium":"email","address":"alice@yopmail.com"},"password":"weak_password","type":"m.login.password","initial_device_display_name":"Portable"}' 'https://matrix.org/_matrix/client/r0/login'
+
+```json
+{
+  "identifier": {
+    "type": "m.id.thirdparty",
+    "medium": "email",
+    "address": "alice@yopmail.com"
+  },
+  "password": "weak_password",
+  "type": "m.login.password",
+  "initial_device_display_name": "Portable"
+}
+```
+
+#### Unknown email
+
+403
+
+```json
+{
+  "errcode": "M_FORBIDDEN",
+  "error": ""
+}
+```
+
+#### Known email, wrong password
+
+403
+
+```json
+{
+  "errcode": "M_FORBIDDEN",
+  "error": "Invalid password"
+}
+```
+
+##### Known email, correct password
+
+We get the credentials (200)
+
+```json
+{
+  "user_id": "@alice:matrix.org",
+  "access_token": "MDAxOGxvY2F0aW9uIG1hdHJpeC5vcmREDACTEDZXJfaWQgPSBAYmVub2l0MDgxNjptYXRyaXgub3JnCjAwMTZjaWQgdHlwZSA9IGFjY2VzcwowMDIxY2lkIG5vbmNlID0gNjtDY0MwRlNPSFFoOC5wOgowMDJmc2lnbmF0dXJlIGiTRm1mYLLxQywxOh3qzQVT8HoEorSokEP2u-bAwtnYCg",
+  "home_server": "matrix.org",
+  "device_id": "WBSREDASND",
+  "well_known": {
+    "m.homeserver": {
+      "base_url": "https:\/\/matrix.org\/"
+    }
+  }
+}
+```
+
+### Login with Msisdn
+
+Not supported yet in RiotX
+
+### Login with SSO
+
+> curl -X GET 'https://homeserver.with.sso/_matrix/client/r0/login'
+
+200
+
+```json
+{
+  "flows": [
+    {
+      "type": "m.login.sso"
+    }
+  ]
+}
+```
+
+In this case, the user can click on "Sign in with SSO" and the web screen will be displayed on the page `https://homeserver.with.sso/_matrix/static/client/login/` and the credentials will be passed back to the native code through the JS bridge
+
+## Reset password
+
+Ref: `https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-account-password-email-requesttoken`
+
+When the user has forgotten his password, he can reset it by providing an email and a new password.
+
+Here is the flow:
+
+### Send email
+
+User is asked to enter the email linked to his account and a new password.
+We display a warning regarding e2e.
+
+At the first step, we do not send the password, only the email and a client secret, generated by the application
+
+> curl -X POST --data $'{"client_secret":"6c57f284-85e2-421b-8270-fb1795a120a7","send_attempt":0,"email":"user@domain.com"}' 'https://matrix.org/_matrix/client/r0/account/password/email/requestToken'
+
+```json
+{
+  "client_secret": "6c57f284-85e2-421b-8270-fb1795a120a7",
+  "send_attempt": 0,
+  "email": "user@domain.com"
+}
+```
+
+#### When the email is not known
+
+We get a 400
+
+```json
+{
+  "errcode": "M_THREEPID_NOT_FOUND",
+  "error": "Email not found"
+}
+```
+
+#### When the email is known
+
+We get a 200 with a `sid`
+
+```json
+{
+  "sid": "tQNbrREDACTEDldA"
+}
+```
+
+Then the user is asked to click on the link in the email he just received, and to confirm when it's done.
+
+During this step, the new password is sent to the homeserver.
+
+If the user confirms before the link is clicked, we get an error:
+
+> curl -X POST --data $'{"auth":{"type":"m.login.email.identity","threepid_creds":{"client_secret":"6c57f284-85e2-421b-8270-fb1795a120a7","sid":"tQNbrREDACTEDldA"}},"new_password":"weak_password"}' 'https://matrix.org/_matrix/client/r0/account/password'
+
+```json
+{
+  "auth": {
+    "type": "m.login.email.identity",
+    "threepid_creds": {
+      "client_secret": "6c57f284-85e2-421b-8270-fb1795a120a7",
+      "sid": "tQNbrREDACTEDldA"
+    }
+  },
+  "new_password": "weak_password"
+}
+```
+
+401
+
+```json
+{
+  "errcode": "M_UNAUTHORIZED",
+  "error": ""
+}
+```
+
+### User clicks on the link
+
+The link has the form:
+
+https://matrix.org/_matrix/client/unstable/password_reset/email/submit_token?token=fzZLBlcqhTKeaFQFSRbsQnQCkzbwtGAD&client_secret=6c57f284-85e2-421b-8270-fb1795a120a7&sid=tQNbrREDACTEDldA
+
+It contains the client secret, a token and the sid
+
+When the user click the link, if validate his ownership and the new password can now be ent by the application (on user demand):
+
+> curl -X POST --data $'{"auth":{"type":"m.login.email.identity","threepid_creds":{"client_secret":"6c57f284-85e2-421b-8270-fb1795a120a7","sid":"tQNbrREDACTEDldA"}},"new_password":"weak_password"}' 'https://matrix.org/_matrix/client/r0/account/password'
+
+```json
+{
+  "auth": {
+    "type": "m.login.email.identity",
+    "threepid_creds": {
+      "client_secret": "6c57f284-85e2-421b-8270-fb1795a120a7",
+      "sid": "tQNbrREDACTEDldA"
+    }
+  },
+  "new_password": "weak_password"
+}
+```
+
+200
+
+```json
+{}
+```
+
+The password has been changed, and all the existing token are invalidated. User can now login with the new password.

docs/signup.md

@@ -0,0 +1,579 @@
+# Sign up to a homeserver
+
+This document describes the flow of registration to a homeserver. Examples come from the `matrix.org` homeserver.
+
+*Ref*: https://matrix.org/docs/spec/client_server/latest#account-registration-and-management
+
+## Sign up flows
+
+### First step
+
+Client request the sign-up flows, once the homeserver is chosen by the user and its url is known (in the example it's `https://matrix.org`)
+
+> curl -X POST --data $'{}' 'https://matrix.org/_matrix/client/r0/register'
+
+```json
+{
+}
+```
+
+We get the flows with a 401, which also means the the registration is possible on this homeserver.
+
+```json
+{
+  "session": "vwehdKMtkRedactedAMwgCACZ",
+  "flows": [
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.dummy"
+      ]
+    },
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.email.identity"
+      ]
+    }
+  ],
+  "params": {
+    "m.login.recaptcha": {
+      "public_key": "6LcgI54UAAAAAoREDACTEDoDdOocFpYVdjYBRe4zb"
+    },
+    "m.login.terms": {
+      "policies": {
+        "privacy_policy": {
+          "version": "1.0",
+          "en": {
+            "name": "Terms and Conditions",
+            "url": "https:\/\/matrix.org\/_matrix\/consent?v=1.0"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+If the registration is not possible, we get a 403
+
+```json
+{
+  "errcode": "M_FORBIDDEN",
+  "error": "Registration is disabled"
+}
+```
+
+### Step 1: entering user name and password
+
+The app is displaying a form to enter username and password.
+
+> curl -X POST --data $'{"initial_device_display_name":"Mobile device","username":"alice","password": "weak_password"}' 'https://matrix.org/_matrix/client/r0/register'
+
+```json
+{
+  "initial_device_display_name": "Mobile device",
+  "username": "alice",
+  "password": "weak_password"
+}
+```
+
+401. Note that the `session` value has changed (because we did not provide the previous value in the request body), but it's ok, we will use the new value for the next steps.
+
+```json
+{
+  "session": "xptUYoREDACTEDogOWAGVnbJQ",
+  "flows": [
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.dummy"
+      ]
+    },
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.email.identity"
+      ]
+    }
+  ],
+  "params": {
+    "m.login.recaptcha": {
+      "public_key": "6LcgI54UAAAAAoREDACTEDoDdOocFpYVdjYBRe4zb"
+    },
+    "m.login.terms": {
+      "policies": {
+        "privacy_policy": {
+          "version": "1.0",
+          "en": {
+            "name": "Terms and Conditions",
+            "url": "https:\/\/matrix.org\/_matrix\/consent?v=1.0"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+#### If username already exists
+
+We get a 400:
+
+```json
+{
+  "errcode": "M_USER_IN_USE",
+  "error": "User ID already taken."
+}
+```
+
+### Step 2: entering email
+
+User is proposed to enter an email. We skip this step.
+
+> curl -X POST --data $'{"auth":{"session":"xptUYoREDACTEDogOWAGVnbJQ","type":"m.login.dummy"}}' 'https://matrix.org/_matrix/client/r0/register'
+
+```json
+{
+  "auth": {
+    "session": "xptUYoREDACTEDogOWAGVnbJQ",
+    "type": "m.login.dummy"
+  }
+}
+```
+
+401
+
+```json
+{
+  "session": "xptUYoREDACTEDogOWAGVnbJQ",
+  "flows": [
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.dummy"
+      ]
+    },
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.email.identity"
+      ]
+    }
+  ],
+  "params": {
+    "m.login.recaptcha": {
+      "public_key": "6LcgI54UAAAAAoREDACTEDoDdOocFpYVdjYBRe4zb"
+    },
+    "m.login.terms": {
+      "policies": {
+        "privacy_policy": {
+          "version": "1.0",
+          "en": {
+            "name": "Terms and Conditions",
+            "url": "https:\/\/matrix.org\/_matrix\/consent?v=1.0"
+          }
+        }
+      }
+    }
+  },
+  "completed": [
+    "m.login.dummy"
+  ]
+}
+```
+
+### Step 2 bis: we enter an email
+
+We request a token to the homeserver. The `client_secret` is generated by the application
+
+> curl -X POST --data $'{"client_secret":"53e679ea-oRED-ACTED-92b8-3012c49c6cfa","email":"alice@yopmail.com","send_attempt":0}' 'https://matrix.org/_matrix/client/r0/register/email/requestToken'
+
+```json
+{
+  "client_secret": "53e679ea-oRED-ACTED-92b8-3012c49c6cfa",
+  "email": "alice@yopmail.com",
+  "send_attempt": 0
+}
+```
+
+200
+
+```json
+{
+  "sid": "qlBCREDACTEDEtgxD"
+}
+```
+
+And
+
+> curl -X POST --data $'{"auth":{"threepid_creds":{"client_secret":"53e679ea-oRED-ACTED-92b8-3012c49c6cfa","sid":"qlBCREDACTEDEtgxD"},"session":"xptUYoREDACTEDogOWAGVnbJQ","type":"m.login.email.identity"}}' 'https://matrix.org/_matrix/client/r0/register'
+
+```json
+{
+  "auth": {
+    "threepid_creds": {
+      "client_secret": "53e679ea-oRED-ACTED-92b8-3012c49c6cfa",
+      "sid": "qlBCREDACTEDEtgxD"
+    },
+    "session": "xptUYoREDACTEDogOWAGVnbJQ",
+    "type": "m.login.email.identity"
+  }
+}
+```
+
+We get 401 since the email is not validated yet:
+
+```json
+{
+  "errcode": "M_UNAUTHORIZED",
+  "error": ""
+}
+```
+
+The app is now polling on 
+
+> curl -X POST --data $'{"auth":{"threepid_creds":{"client_secret":"53e679ea-oRED-ACTED-92b8-3012c49c6cfa","sid":"qlBCREDACTEDEtgxD"},"session":"xptUYoREDACTEDogOWAGVnbJQ","type":"m.login.email.identity"}}' 'https://matrix.org/_matrix/client/r0/register'
+
+```json
+{
+  "auth": {
+    "threepid_creds": {
+      "client_secret": "53e679ea-oRED-ACTED-92b8-3012c49c6cfa",
+      "sid": "qlBCREDACTEDEtgxD"
+    },
+    "session": "xptUYoREDACTEDogOWAGVnbJQ",
+    "type": "m.login.email.identity"
+  }
+}
+```
+
+We click on the link received by email `https://matrix.org/_matrix/client/unstable/registration/email/submit_token?token=vtQjQIZfwdoREDACTEDozrmKYSWlCXsJ&client_secret=53e679ea-oRED-ACTED-92b8-3012c49c6cfa&sid=qlBCREDACTEDEtgxD` which contains:
+- A `token` vtQjQIZfwdoREDACTEDozrmKYSWlCXsJ
+- The `client_secret`: 53e679ea-oRED-ACTED-92b8-3012c49c6cfa
+- A `sid`: qlBCREDACTEDEtgxD
+
+Once the link is clicked, the registration request (polling) returns a 401 with the following content:
+
+```json
+{
+  "session": "xptUYoREDACTEDogOWAGVnbJQ",
+  "flows": [
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.dummy"
+      ]
+    },
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.email.identity"
+      ]
+    }
+  ],
+  "params": {
+    "m.login.recaptcha": {
+      "public_key": "6LcgI54UAAAAAoREDACTEDoDdOocFpYVdjYBRe4zb"
+    },
+    "m.login.terms": {
+      "policies": {
+        "privacy_policy": {
+          "version": "1.0",
+          "en": {
+            "name": "Terms and Conditions",
+            "url": "https:\/\/matrix.org\/_matrix\/consent?v=1.0"
+          }
+        }
+      }
+    }
+  },
+  "completed": [
+    "m.login.email.identity"
+  ]
+}
+```
+
+### Step 3: Accepting T&C
+
+User is proposed to accept T&C and he accepts them
+
+> curl -X POST --data $'{"auth":{"session":"xptUYoREDACTEDogOWAGVnbJQ","type":"m.login.terms"}}' 'https://matrix.org/_matrix/client/r0/register'
+
+```json
+{
+  "auth": {
+    "session": "xptUYoREDACTEDogOWAGVnbJQ",
+    "type": "m.login.terms"
+  }
+}
+```
+
+401
+
+```json
+{
+  "session": "xptUYoREDACTEDogOWAGVnbJQ",
+  "flows": [
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.dummy"
+      ]
+    },
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.email.identity"
+      ]
+    }
+  ],
+  "params": {
+    "m.login.recaptcha": {
+      "public_key": "6LcgI54UAAAAAoREDACTEDoDdOocFpYVdjYBRe4zb"
+    },
+    "m.login.terms": {
+      "policies": {
+        "privacy_policy": {
+          "version": "1.0",
+          "en": {
+            "name": "Terms and Conditions",
+            "url": "https:\/\/matrix.org\/_matrix\/consent?v=1.0"
+          }
+        }
+      }
+    }
+  },
+  "completed": [
+    "m.login.dummy",
+    "m.login.terms"
+  ]
+}
+```
+
+### Step 4: Captcha
+
+User is proposed to prove he is not a robot and he does it:
+
+> curl -X POST --data $'{"auth":{"response":"03AOLTBLSiGS9GhFDpAMblJ2nlXOmHXqAYJ5OvHCPUjiVLBef3k9snOYI_BDC32-t4D2jv-tpvkaiEI_uloobFd9RUTPpJ7con2hMddbKjSCYqXqcUQFhzhbcX6kw8uBnh2sbwBe80_ihrHGXEoACXQkL0ki1Q0uEtOeW20YBRjbNABsZPpLNZhGIWC0QVXnQ4FouAtZrl3gOAiyM-oG3cgP6M9pcANIAC_7T2P2amAHbtsTlSR9CsazNyS-rtDR9b5MywdtnWN9Aw8fTJb8cXQk_j7nvugMxzofPjSOrPKcr8h5OqPlpUCyxxnFtag6cuaPSUwh43D2L0E-ZX7djzaY2Yh_U2n6HegFNPOQ22CJmfrKwDlodmAfMPvAXyq77n3HpoREDACTEDo3830RHF4BfkGXUaZjctgg-A1mvC17hmQmQpkG7IhDqyw0onU-0vF_-ehCjq_CcQEDpS_O3uiHJaG5xGf-0rhLm57v_wA3deugbsZuO4uTuxZZycN_mKxZ97jlDVBetl9hc_5REPbhcT1w3uzTCSx7Q","session":"xptUYoREDACTEDogOWAGVnbJQ","type":"m.login.recaptcha"}}' 'https://matrix.org/_matrix/client/r0/register'
+
+```json
+{
+  "auth": {
+    "response": "03AOLTBLSiGS9GhFDpAMblJ2nlXOmHXqAYJ5OvHCPUjiVLBef3k9snOYI_BDC32-t4D2jv-tpvkaiEI_uloobFd9RUTPpJ7con2hMddbKjSCYqXqcUQFhzhbcX6kw8uBnh2sbwBe80_ihrHGXEoACXQkL0ki1Q0uEtOeW20YBRjbNABsZPpLNZhGIWC0QVXnQ4FouAtZrl3gOAiyM-oG3cgP6M9pcANIAC_7T2P2amAHbtsTlSR9CsazNyS-rtDR9b5MywdtnWN9Aw8fTJb8cXQk_j7nvugMxzofPjSOrPKcr8h5OqPlpUCyxxnFtag6cuaPSUwh43D2L0E-ZX7djzaY2Yh_U2n6HegFNPOQ22CJmfrKwDlodmAfMPvAXyq77n3HpoREDACTEDo3830RHF4BfkGXUaZjctgg-A1mvC17hmQmQpkG7IhDqyw0onU-0vF_-ehCjq_CcQEDpS_O3uiHJaG5xGf-0rhLm57v_wA3deugbsZuO4uTuxZZycN_mKxZ97jlDVBetl9hc_5REPbhcT1w3uzTCSx7Q",
+    "session": "xptUYoREDACTEDogOWAGVnbJQ",
+    "type": "m.login.recaptcha"
+  }
+}
+```
+
+200
+
+```json
+{
+  "user_id": "@alice:matrix.org",
+  "home_server": "matrix.org",
+  "access_token": "MDAxOGxvY2F0aW9uIG1hdHJpeC5vcmcKMoREDACTEDo50aWZpZXIga2V5CjAwMTBjaWQgZ2VuID0gMQowMDI5Y2lkIHVzZXJfaWQgPSBAYmVub2l0eHh4eDptYXRoREDACTEDoCjAwMTZjaWQgdHlwZSA9IGFjY2VzcwowMDIxY2lkIG5vbmNlID0gNHVSVm00aVFDaWlKdoREDACTEDoJmc2lnbmF0dXJlIOmHnTLRfxiPjhrWhS-dThUX-qAzZktfRThzH1YyAsxaCg",
+  "device_id": "FLBAREDAJZ"
+}
+```
+
+The account is created!
+
+### Step 5: MSISDN
+
+Some homeservers may require the user to enter MSISDN.
+
+On matrix.org, it's not required, and not even optional, but it's still possible for the app to add a MSISDN during the registration.
+
+The user enter a phone number and select a country, the `client_secret` is generated by the application
+
+> curl -X POST --data $'{"client_secret":"d3e285f6-972a-496c-9a22-7915a2db57c7","send_attempt":1,"country":"FR","phone_number":"+33611223344"}'  'https://matrix.org/_matrix/client/r0/register/msisdn/requestToken'
+
+```json
+{
+  "client_secret": "d3e285f6-972a-496c-9a22-7915a2db57c7",
+  "send_attempt": 1,
+  "country": "FR",
+  "phone_number": "+33611223344"
+}
+```
+
+If the msisdn is already associated to another account, you will received an error:
+
+```json
+{
+  "errcode": "M_THREEPID_IN_USE",
+  "error": "Phone number is already in use"
+}
+```
+
+If it is not the case, the homeserver send the SMS and returns some data, especially a `sid` and a `submit_url`:
+
+```json
+{
+  "msisdn": "33611223344",
+  "intl_fmt": "+336 11 22 33 44",
+  "success": true,
+  "sid": "1678881798",
+  "submit_url": "https:\/\/matrix.org\/_matrix\/client\/unstable\/add_threepid\/msisdn\/submit_token"
+}
+```
+
+When you execute the register request, with the received `sid`, you get an error since the MSISDN is not validated yet:
+
+> curl -X POST --data $'{"auth":{"type":"m.login.msisdn","session":"xptUYoREDACTEDogOWAGVnbJQ","threepid_creds":{"client_secret":"d3e285f6-972a-496c-9a22-7915a2db57c7","sid":"1678881798"}}}' 'https://matrix.org/_matrix/client/r0/register'
+
+
+```json
+  "auth": {
+    "type": "m.login.msisdn",
+    "session": "xptUYoREDACTEDogOWAGVnbJQ",
+    "threepid_creds": {
+      "client_secret": "d3e285f6-972a-496c-9a22-7915a2db57c7",
+      "sid": "1678881798"
+    }
+  }
+}
+```
+
+There is an issue on Synapse, which return a 401, it sends too much data along with the classical MatrixError fields:
+
+```json
+{
+  "session": "xptUYoREDACTEDogOWAGVnbJQ",
+  "flows": [
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.dummy"
+      ]
+    },
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.email.identity"
+      ]
+    }
+  ],
+  "params": {
+    "m.login.recaptcha": {
+      "public_key": "6LcgI54UAAAAABGdGmruw6DdOocFpYVdjYBRe4zb"
+    },
+    "m.login.terms": {
+      "policies": {
+        "privacy_policy": {
+          "version": "1.0",
+          "en": {
+            "name": "Terms and Conditions",
+            "url": "https:\/\/matrix.org\/_matrix\/consent?v=1.0"
+          }
+        }
+      }
+    }
+  },
+  "completed": [],
+  "error": "",
+  "errcode": "M_UNAUTHORIZED"
+}
+```
+
+The user receive the SMS, he can enter the SMS code in the app, which is sent using the "submit_url" received ie the response of the `requestToken` request:
+
+> curl -X POST --data $'{"client_secret":"d3e285f6-972a-496c-9a22-7915a2db57c7","sid":"1678881798","token":"123456"}' 'https://matrix.org/_matrix/client/unstable/add_threepid/msisdn/submit_token'
+
+```json
+{
+  "client_secret": "d3e285f6-972a-496c-9a22-7915a2db57c7",
+  "sid": "1678881798",
+  "token": "123456"
+}
+```
+
+If the code is not correct, we get a 200 with:
+
+```json
+{
+  "success": false
+}
+```
+
+And if the code is correct we get a 200 with:
+
+```json
+{
+  "success": true
+}
+```
+
+We can now execute the registration request, to the homeserver
+
+> curl -X POST --data $'{"auth":{"type":"m.login.msisdn","session":"xptUYoREDACTEDogOWAGVnbJQ","threepid_creds":{"client_secret":"d3e285f6-972a-496c-9a22-7915a2db57c7","sid":"1678881798"}}}' 'https://matrix.org/_matrix/client/r0/register'
+
+```json
+{
+  "auth": {
+    "type": "m.login.msisdn",
+    "session": "xptUYoREDACTEDogOWAGVnbJQ",
+    "threepid_creds": {
+      "client_secret": "d3e285f6-972a-496c-9a22-7915a2db57c7",
+      "sid": "1678881798"
+    }
+  }
+}
+```
+
+Now the homeserver consider that the `m.login.msisdn` step is completed (401):
+
+```json
+{
+  "session": "xptUYoREDACTEDogOWAGVnbJQ",
+  "flows": [
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.dummy"
+      ]
+    },
+    {
+      "stages": [
+        "m.login.recaptcha",
+        "m.login.terms",
+        "m.login.email.identity"
+      ]
+    }
+  ],
+  "params": {
+    "m.login.recaptcha": {
+      "public_key": "6LcgI54UAAAAABGdGmruw6DdOocFpYVdjYBRe4zb"
+    },
+    "m.login.terms": {
+      "policies": {
+        "privacy_policy": {
+          "version": "1.0",
+          "en": {
+            "name": "Terms and Conditions",
+            "url": "https:\/\/matrix.org\/_matrix\/consent?v=1.0"
+          }
+        }
+      }
+    }
+  },
+  "completed": [
+    "m.login.msisdn"
+  ]
+}
+```

gradle.properties

@@ -13,3 +13,11 @@ org.gradle.jvmargs=-Xmx1536m
 # This option should only be used with decoupled projects. More details, visit
 # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
 # org.gradle.parallel=true
+
+
+vector.debugPrivateData=false
+vector.httpLogLevel=NONE
+
+# 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
+#vector.httpLogLevel=BODY

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Tue Mar 19 09:53:05 CET 2019
+#Fri Sep 27 10:10:35 CEST 2019
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-all.zip

matrix-sdk-android-rx/build.gradle

@@ -5,16 +5,15 @@ apply plugin: 'kotlin-kapt'
 android {
     compileSdkVersion 28
 
-
-
     defaultConfig {
         minSdkVersion 16
         targetSdkVersion 28
         versionCode 1
         versionName "1.0"
 
+        // Multidex is useful for tests
+        multiDexEnabled true
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
-
     }
 
     buildTypes {
@@ -29,20 +28,20 @@ android {
         targetCompatibility JavaVersion.VERSION_1_8
     }
 
-
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
 }
 
 dependencies {
-    implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation project(":matrix-sdk-android")
-    implementation 'androidx.appcompat:appcompat:1.1.0-alpha01'
+    implementation 'androidx.appcompat:appcompat:1.1.0'
     implementation 'io.reactivex.rxjava2:rxkotlin:2.3.0'
-    implementation 'io.reactivex.rxjava2:rxandroid:2.0.2'
-
+    implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'
     // Paging
-    implementation 'androidx.paging:paging-runtime:2.0.0'
+    implementation "androidx.paging:paging-runtime-ktx:2.1.0"
 
     testImplementation 'junit:junit:4.12'
-    androidTestImplementation 'androidx.test:runner:1.1.1'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.1'
+    androidTestImplementation 'androidx.test:runner:1.2.0'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
 }

matrix-sdk-android-rx/src/androidTest/java/im/vector/matrix/rx/ExampleInstrumentedTest.java

@@ -1,42 +0,0 @@
-/*
- * Copyright 2019 New Vector Ltd
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package im.vector.matrix.rx;
-
-import android.content.Context;
-import androidx.test.InstrumentationRegistry;
-import androidx.test.runner.AndroidJUnit4;
-
-import org.junit.Test;
-import org.junit.runner.RunWith;
-
-import static org.junit.Assert.*;
-
-/**
- * Instrumented test, which will execute on an Android device.
- *
- * @see <a href="http://d.android.com/tools/testing">Testing documentation</a>
- */
-@RunWith(AndroidJUnit4.class)
-public class ExampleInstrumentedTest {
-    @Test
-    public void useAppContext() {
-        // Context of the app under test.
-        Context appContext = InstrumentationRegistry.getTargetContext();
-
-        assertEquals("im.vector.matrix.rx.test", appContext.getPackageName());
-    }
-}

matrix-sdk-android-rx/src/main/java/im/vector/matrix/rx/LiveDataObservable.kt

@@ -20,6 +20,7 @@ import androidx.lifecycle.LiveData
 import androidx.lifecycle.Observer
 import io.reactivex.Observable
 import io.reactivex.android.MainThreadDisposable
+import io.reactivex.schedulers.Schedulers
 
 private class LiveDataObservable<T>(
         private val liveData: LiveData<T>,
@@ -57,5 +58,5 @@ private class LiveDataObservable<T>(
 }
 
 fun <T> LiveData<T>.asObservable(): Observable<T> {
-    return LiveDataObservable(this)
-}
+    return LiveDataObservable(this).observeOn(Schedulers.computation())
+}

matrix-sdk-android-rx/src/main/java/im/vector/matrix/rx/MatrixCallbackCompletable.kt

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.rx
+
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.util.Cancelable
+import io.reactivex.CompletableEmitter
+
+internal class MatrixCallbackCompletable<T>(private val completableEmitter: CompletableEmitter) : MatrixCallback<T> {
+
+    override fun onSuccess(data: T) {
+        completableEmitter.onComplete()
+    }
+
+    override fun onFailure(failure: Throwable) {
+        completableEmitter.tryOnError(failure)
+    }
+}
+
+fun Cancelable.toCompletable(completableEmitter: CompletableEmitter) {
+    completableEmitter.setCancellable {
+        this.cancel()
+    }
+}

matrix-sdk-android-rx/src/main/java/im/vector/matrix/rx/MatrixCallbackSingle.kt

@@ -14,23 +14,25 @@
  * limitations under the License.
  */
 
-package im.vector.riotredesign.features.home.room.list
+package im.vector.matrix.rx
 
-import android.content.SharedPreferences
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.util.Cancelable
+import io.reactivex.SingleEmitter
 
-private const val SHARED_PREFS_SELECTED_ROOM_KEY = "SHARED_PREFS_SELECTED_ROOM_KEY"
+internal class MatrixCallbackSingle<T>(private val singleEmitter: SingleEmitter<T>) : MatrixCallback<T> {
 
-class RoomSelectionRepository(private val sharedPreferences: SharedPreferences) {
-
-    fun lastSelectedRoom(): String? {
-        return sharedPreferences.getString(SHARED_PREFS_SELECTED_ROOM_KEY, null)
+    override fun onSuccess(data: T) {
+        singleEmitter.onSuccess(data)
     }
 
-    fun saveLastSelectedRoom(roomId: String) {
-        sharedPreferences.edit()
-                .putString(SHARED_PREFS_SELECTED_ROOM_KEY, roomId)
-                .apply()
+    override fun onFailure(failure: Throwable) {
+        singleEmitter.tryOnError(failure)
     }
-
 }
 
+fun <T> Cancelable.toSingle(singleEmitter: SingleEmitter<T>) {
+    singleEmitter.setCancellable {
+        this.cancel()
+    }
+}

matrix-sdk-android-rx/src/main/java/im/vector/matrix/rx/OptionalRx.kt

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.rx
+
+import im.vector.matrix.android.api.util.Optional
+import io.reactivex.Observable
+
+fun <T : Any> Observable<Optional<T>>.unwrap(): Observable<T> {
+    return filter { it.hasValue() }.map { it.get() }
+}

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

@@ -17,21 +17,63 @@
 package im.vector.matrix.rx
 
 import im.vector.matrix.android.api.session.room.Room
+import im.vector.matrix.android.api.session.room.model.EventAnnotationsSummary
+import im.vector.matrix.android.api.session.room.model.ReadReceipt
 import im.vector.matrix.android.api.session.room.model.RoomSummary
+import im.vector.matrix.android.api.session.room.notification.RoomNotificationState
+import im.vector.matrix.android.api.session.room.send.UserDraft
+import im.vector.matrix.android.api.session.room.timeline.TimelineEvent
+import im.vector.matrix.android.api.util.Optional
 import io.reactivex.Observable
+import io.reactivex.Single
 
 class RxRoom(private val room: Room) {
 
-    fun liveRoomSummary(): Observable<RoomSummary> {
-        return room.roomSummary.asObservable()
+    fun liveRoomSummary(): Observable<Optional<RoomSummary>> {
+        return room.getRoomSummaryLive().asObservable()
     }
 
     fun liveRoomMemberIds(): Observable<List<String>> {
         return room.getRoomMemberIdsLive().asObservable()
     }
 
+    fun liveAnnotationSummary(eventId: String): Observable<Optional<EventAnnotationsSummary>> {
+        return room.getEventSummaryLive(eventId).asObservable()
+    }
+
+    fun liveTimelineEvent(eventId: String): Observable<Optional<TimelineEvent>> {
+        return room.getTimeLineEventLive(eventId).asObservable()
+    }
+
+    fun liveReadMarker(): Observable<Optional<String>> {
+        return room.getReadMarkerLive().asObservable()
+    }
+
+    fun liveReadReceipt(): Observable<Optional<String>> {
+        return room.getMyReadReceiptLive().asObservable()
+    }
+
+    fun loadRoomMembersIfNeeded(): Single<Unit> = Single.create {
+        room.loadRoomMembersIfNeeded(MatrixCallbackSingle(it)).toSingle(it)
+    }
+
+    fun joinRoom(viaServers: List<String> = emptyList()): Single<Unit> = Single.create {
+        room.join(viaServers, MatrixCallbackSingle(it)).toSingle(it)
+    }
+
+    fun liveEventReadReceipts(eventId: String): Observable<List<ReadReceipt>> {
+        return room.getEventReadReceiptsLive(eventId).asObservable()
+    }
+
+    fun liveDrafts(): Observable<List<UserDraft>> {
+        return room.getDraftsLive().asObservable()
+    }
+
+    fun liveNotificationState(): Observable<RoomNotificationState> {
+        return room.getLiveRoomNotificationState().asObservable()
+    }
 }
 
 fun Room.rx(): RxRoom {
     return RxRoom(this)
-}
+}

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

@@ -16,10 +16,17 @@
 
 package im.vector.matrix.rx
 
+import androidx.paging.PagedList
 import im.vector.matrix.android.api.session.Session
 import im.vector.matrix.android.api.session.group.model.GroupSummary
+import im.vector.matrix.android.api.session.pushers.Pusher
 import im.vector.matrix.android.api.session.room.model.RoomSummary
+import im.vector.matrix.android.api.session.room.model.create.CreateRoomParams
+import im.vector.matrix.android.api.session.sync.SyncState
+import im.vector.matrix.android.api.session.user.model.User
+import im.vector.matrix.android.api.util.Optional
 import io.reactivex.Observable
+import io.reactivex.Single
 
 class RxSession(private val session: Session) {
 
@@ -31,8 +38,45 @@ class RxSession(private val session: Session) {
         return session.liveGroupSummaries().asObservable()
     }
 
+    fun liveSyncState(): Observable<SyncState> {
+        return session.syncState().asObservable()
+    }
+
+    fun livePushers(): Observable<List<Pusher>> {
+        return session.livePushers().asObservable()
+    }
+
+    fun liveUser(userId: String): Observable<Optional<User>> {
+        return session.liveUser(userId).asObservable().distinctUntilChanged()
+    }
+
+    fun liveUsers(): Observable<List<User>> {
+        return session.liveUsers().asObservable()
+    }
+
+    fun liveIgnoredUsers(): Observable<List<User>> {
+        return session.liveIgnoredUsers().asObservable()
+    }
+
+    fun livePagedUsers(filter: String? = null): Observable<PagedList<User>> {
+        return session.livePagedUsers(filter).asObservable()
+    }
+
+    fun createRoom(roomParams: CreateRoomParams): Single<String> = Single.create {
+        session.createRoom(roomParams, MatrixCallbackSingle(it)).toSingle(it)
+    }
+
+    fun searchUsersDirectory(search: String,
+                             limit: Int,
+                             excludedUserIds: Set<String>): Single<List<User>> = Single.create {
+        session.searchUsersDirectory(search, limit, excludedUserIds, MatrixCallbackSingle(it)).toSingle(it)
+    }
+
+    fun joinRoom(roomId: String, viaServers: List<String> = emptyList()): Single<Unit> = Single.create {
+        session.joinRoom(roomId, viaServers, MatrixCallbackSingle(it)).toSingle(it)
+    }
 }
 
 fun Session.rx(): RxSession {
     return RxSession(this)
-}
+}

matrix-sdk-android/build.gradle

@@ -6,20 +6,14 @@ apply plugin: 'realm-android'
 apply plugin: 'okreplay'
 
 buildscript {
-
     repositories {
         jcenter()
     }
     dependencies {
-        classpath "io.realm:realm-gradle-plugin:5.9.0"
+        classpath "io.realm:realm-gradle-plugin:5.12.0"
     }
 }
 
-repositories {
-    google()
-    jcenter()
-}
-
 androidExtensions {
     experimental = true
 }
@@ -32,10 +26,12 @@ android {
         minSdkVersion 16
         targetSdkVersion 28
         versionCode 1
-        versionName "1.0"
+        versionName "0.0.1"
+        // Multidex is useful for tests
         multiDexEnabled true
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
 
+        buildConfigField "String", "GIT_SDK_REVISION", "\"${gitRevision()}\""
         resValue "string", "git_sdk_revision", "\"${gitRevision()}\""
         resValue "string", "git_sdk_revision_unix_date", "\"${gitRevisionUnixDate()}\""
         resValue "string", "git_sdk_revision_date", "\"${gitRevisionDate()}\""
@@ -45,10 +41,9 @@ android {
 
         debug {
             // Set to true to log privacy or sensible data, such as token
-            buildConfigField "boolean", "LOG_PRIVATE_DATA", "false"
-
+            buildConfigField "boolean", "LOG_PRIVATE_DATA", project.property("vector.debugPrivateData")
             // Set to BODY instead of NONE to enable logging
-            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." + project.property("vector.httpLogLevel")
         }
 
         release {
@@ -67,6 +62,15 @@ android {
     lintOptions {
         lintConfig file("lint.xml")
     }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
 }
 
 static def gitRevision() {
@@ -86,74 +90,84 @@ static def gitRevisionDate() {
 
 dependencies {
 
-    def arrow_version = "0.8.0"
-    def support_version = '1.1.0-alpha03'
+    def arrow_version = "0.8.2"
     def moshi_version = '1.8.0'
-    def lifecycle_version = '2.0.0'
-    def coroutines_version = "1.0.1"
+    def lifecycle_version = '2.1.0'
+    def coroutines_version = "1.3.2"
+    def markwon_version = '3.1.0'
+    def daggerVersion = '2.24'
 
-    implementation fileTree(dir: 'libs', include: ['*.aar'])
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
     implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines_version"
     implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutines_version"
 
-    implementation "androidx.appcompat:appcompat:$support_version"
-    implementation "androidx.recyclerview:recyclerview:$support_version"
+    implementation "androidx.appcompat:appcompat:1.1.0"
+    implementation "androidx.recyclerview:recyclerview:1.1.0-beta05"
 
     implementation "androidx.lifecycle:lifecycle-extensions:$lifecycle_version"
     kapt "androidx.lifecycle:lifecycle-compiler:$lifecycle_version"
 
     // Network
-    implementation 'com.squareup.retrofit2:retrofit:2.4.0'
-    implementation 'com.squareup.retrofit2:converter-moshi:2.4.0'
-    implementation 'com.squareup.okhttp3:okhttp:3.11.0'
-    implementation 'com.squareup.okhttp3:logging-interceptor:3.10.0'
-    implementation 'com.novoda:merlin:1.1.6'
+    implementation 'com.squareup.retrofit2:retrofit:2.6.2'
+    implementation 'com.squareup.retrofit2:converter-moshi:2.6.2'
+    implementation 'com.squareup.okhttp3:okhttp:4.2.2'
+    implementation 'com.squareup.okhttp3:logging-interceptor:4.2.2'
+    implementation 'com.novoda:merlin:1.2.0'
     implementation "com.squareup.moshi:moshi-adapters:$moshi_version"
     kapt "com.squareup.moshi:moshi-kotlin-codegen:$moshi_version"
 
+    implementation "ru.noties.markwon:core:$markwon_version"
+
+    // Image
+    implementation 'androidx.exifinterface:exifinterface:1.0.0'
+
     // Database
     implementation 'com.github.Zhuinden:realm-monarchy:0.5.1'
     kapt 'dk.ilios:realmfieldnameshelper:1.1.1'
 
     // Work
-    implementation "android.arch.work:work-runtime-ktx:1.0.0"
+    implementation "androidx.work:work-runtime-ktx:2.3.0-alpha01"
 
     // FP
     implementation "io.arrow-kt:arrow-core:$arrow_version"
     implementation "io.arrow-kt:arrow-instances-core:$arrow_version"
-    implementation "io.arrow-kt:arrow-effects:$arrow_version"
-    implementation "io.arrow-kt:arrow-effects-instances:$arrow_version"
-    implementation "io.arrow-kt:arrow-integration-retrofit-adapter:$arrow_version"
+
+    // olm lib is now hosted by jitpack: https://jitpack.io/#org.matrix.gitlab.matrix-org/olm
+    implementation 'org.matrix.gitlab.matrix-org:olm:3.1.2'
 
     // DI
-    implementation "org.koin:koin-core:$koin_version"
-    implementation "org.koin:koin-core-ext:$koin_version"
+    implementation "com.google.dagger:dagger:$daggerVersion"
+    kapt "com.google.dagger:dagger-compiler:$daggerVersion"
+    compileOnly 'com.squareup.inject:assisted-inject-annotations-dagger2:0.5.0'
+    kapt 'com.squareup.inject:assisted-inject-processor-dagger2:0.5.0'
 
     // Logging
     implementation 'com.jakewharton.timber:timber:4.7.1'
-    implementation 'com.facebook.stetho:stetho-okhttp3:1.5.0'
+    implementation 'com.facebook.stetho:stetho-okhttp3:1.5.1'
 
-    debugImplementation 'com.airbnb.okreplay:okreplay:1.4.0'
-    releaseImplementation 'com.airbnb.okreplay:noop:1.4.0'
-    androidTestImplementation 'com.airbnb.okreplay:espresso:1.4.0'
+    // Bus
+    implementation 'org.greenrobot:eventbus:3.1.1'
+
+    debugImplementation 'com.airbnb.okreplay:okreplay:1.5.0'
+    releaseImplementation 'com.airbnb.okreplay:noop:1.5.0'
+    androidTestImplementation 'com.airbnb.okreplay:espresso:1.5.0'
 
     testImplementation 'junit:junit:4.12'
-    testImplementation 'org.robolectric:robolectric:4.0.2'
-    testImplementation "org.koin:koin-test:$koin_version"
+    testImplementation 'org.robolectric:robolectric:4.3'
     //testImplementation 'org.robolectric:shadows-support-v4:3.0'
-    testImplementation "io.mockk:mockk:1.8.13.kotlin13"
+    // Note: version sticks to 1.9.2 due to https://github.com/mockk/mockk/issues/281
+    testImplementation 'io.mockk:mockk:1.9.2.kotlin12'
     testImplementation 'org.amshove.kluent:kluent-android:1.44'
     testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutines_version"
 
-    androidTestImplementation "org.koin:koin-test:$koin_version"
-    androidTestImplementation 'androidx.test:core:1.1.0'
-    androidTestImplementation 'androidx.test:runner:1.1.1'
-    androidTestImplementation 'androidx.test:rules:1.1.1'
-    androidTestImplementation 'androidx.test.ext:junit:1.1.0'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.1'
+    androidTestImplementation 'androidx.test:core:1.2.0'
+    androidTestImplementation 'androidx.test:runner:1.2.0'
+    androidTestImplementation 'androidx.test:rules:1.2.0'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.1'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
     androidTestImplementation 'org.amshove.kluent:kluent-android:1.44'
-    androidTestImplementation "io.mockk:mockk-android:1.8.13.kotlin13"
+    // Note: version sticks to 1.9.2 due to https://github.com/mockk/mockk/issues/281
+    androidTestImplementation 'io.mockk:mockk-android:1.9.2.kotlin12'
     androidTestImplementation "androidx.arch.core:core-testing:$lifecycle_version"
     androidTestImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutines_version"
 

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/InstrumentedTest.kt

@@ -17,15 +17,15 @@
 package im.vector.matrix.android
 
 import android.content.Context
-import androidx.test.InstrumentationRegistry
+import androidx.test.core.app.ApplicationProvider
 import java.io.File
 
 interface InstrumentedTest {
     fun context(): Context {
-        return InstrumentationRegistry.getTargetContext()
+        return ApplicationProvider.getApplicationContext()
     }
 
     fun cacheDir(): File {
         return context().cacheDir
     }
-}
+}

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/LiveDataTestObserver.java

@@ -16,10 +16,10 @@
 
 package im.vector.matrix.android;
 
+import androidx.annotation.Nullable;
 import androidx.lifecycle.LiveData;
 import androidx.lifecycle.MutableLiveData;
 import androidx.lifecycle.Observer;
-import androidx.annotation.Nullable;
 
 import java.util.ArrayList;
 import java.util.Collections;

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/OkReplayRuleChainNoActivity.kt

@@ -29,4 +29,4 @@ class OkReplayRuleChainNoActivity(
         return RuleChain.outerRule(PermissionRule(configuration))
                 .around(RecorderRule(configuration))
     }
-}
+}

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/SingleThreadCoroutineDispatcher.kt

@@ -19,4 +19,4 @@ package im.vector.matrix.android
 import im.vector.matrix.android.internal.util.MatrixCoroutineDispatchers
 import kotlinx.coroutines.Dispatchers.Main
 
-internal val testCoroutineDispatchers = MatrixCoroutineDispatchers(Main, Main, Main)
+internal val testCoroutineDispatchers = MatrixCoroutineDispatchers(Main, Main, Main, Main, Main)

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/auth/AuthenticationServiceTest.kt

@@ -17,38 +17,22 @@
 package im.vector.matrix.android.auth
 
 import androidx.test.annotation.UiThreadTest
+import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.rule.GrantPermissionRule
-import androidx.test.runner.AndroidJUnit4
-import com.zhuinden.monarchy.Monarchy
 import im.vector.matrix.android.InstrumentedTest
 import im.vector.matrix.android.OkReplayRuleChainNoActivity
-import im.vector.matrix.android.api.auth.Authenticator
-import im.vector.matrix.android.internal.auth.AuthModule
-import im.vector.matrix.android.internal.di.MatrixModule
-import im.vector.matrix.android.internal.di.NetworkModule
+import im.vector.matrix.android.api.auth.AuthenticationService
 import okreplay.*
 import org.junit.ClassRule
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
-import org.koin.standalone.StandAloneContext.loadKoinModules
-import org.koin.standalone.inject
-import org.koin.test.KoinTest
-
 
 @RunWith(AndroidJUnit4::class)
-internal class AuthenticatorTest : InstrumentedTest, KoinTest {
+internal class AuthenticationServiceTest : InstrumentedTest {
 
-    init {
-        Monarchy.init(context())
-        val matrixModule = MatrixModule(context()).definition
-        val networkModule = NetworkModule().definition
-        val authModule = AuthModule().definition
-        loadKoinModules(listOf(matrixModule, networkModule, authModule))
-    }
-
-    private val authenticator: Authenticator by inject()
-    private val okReplayInterceptor: OkReplayInterceptor by inject()
+    lateinit var authenticationService: AuthenticationService
+    lateinit var okReplayInterceptor: OkReplayInterceptor
 
     private val okReplayConfig = OkReplayConfig.Builder()
             .tapeRoot(AndroidTapeRoot(
@@ -65,7 +49,6 @@ internal class AuthenticatorTest : InstrumentedTest, KoinTest {
     @UiThreadTest
     @OkReplay(tape = "auth", mode = TapeMode.READ_WRITE)
     fun auth() {
-
     }
 
     companion object {
@@ -74,6 +57,4 @@ internal class AuthenticatorTest : InstrumentedTest, KoinTest {
         val grantExternalStoragePermissionRule: GrantPermissionRule =
                 GrantPermissionRule.grant(android.Manifest.permission.WRITE_EXTERNAL_STORAGE)
     }
-
-
-}
+}

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/internal/crypto/CryptoStoreHelper.kt

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2018 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.internal.crypto
+
+import im.vector.matrix.android.api.auth.data.Credentials
+import im.vector.matrix.android.internal.crypto.store.IMXCryptoStore
+import im.vector.matrix.android.internal.crypto.store.db.RealmCryptoStore
+import im.vector.matrix.android.internal.crypto.store.db.RealmCryptoStoreModule
+import io.realm.RealmConfiguration
+import kotlin.random.Random
+
+internal class CryptoStoreHelper {
+
+    fun createStore(): IMXCryptoStore {
+        return RealmCryptoStore(
+                realmConfiguration = RealmConfiguration.Builder()
+                        .name("test.realm")
+                        .modules(RealmCryptoStoreModule())
+                        .build(),
+                credentials = createCredential())
+    }
+
+    fun createCredential() = Credentials(
+            userId = "userId_" + Random.nextInt(),
+            homeServer = "http://matrix.org",
+            accessToken = "access_token",
+            refreshToken = null,
+            deviceId = "deviceId_sample"
+    )
+}

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/internal/crypto/CryptoStoreTest.kt

@@ -0,0 +1,117 @@
+/*
+ * Copyright 2018 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.internal.crypto
+
+import im.vector.matrix.android.internal.crypto.model.OlmSessionWrapper
+import im.vector.matrix.android.internal.crypto.store.IMXCryptoStore
+import org.junit.Assert.*
+import org.junit.Test
+import org.matrix.olm.OlmAccount
+import org.matrix.olm.OlmManager
+import org.matrix.olm.OlmSession
+
+private const val DUMMY_DEVICE_KEY = "DeviceKey"
+
+class CryptoStoreTest {
+
+    private val cryptoStoreHelper = CryptoStoreHelper()
+
+    @Test
+    fun test_metadata_realm_ok() {
+        val cryptoStore: IMXCryptoStore = cryptoStoreHelper.createStore()
+
+        assertFalse(cryptoStore.hasData())
+
+        cryptoStore.open()
+
+        assertEquals("deviceId_sample", cryptoStore.getDeviceId())
+
+        assertTrue(cryptoStore.hasData())
+
+        // Cleanup
+        cryptoStore.close()
+        cryptoStore.deleteStore()
+    }
+
+    @Test
+    fun test_lastSessionUsed() {
+        // Ensure Olm is initialized
+        OlmManager()
+
+        val cryptoStore: IMXCryptoStore = cryptoStoreHelper.createStore()
+
+        assertNull(cryptoStore.getLastUsedSessionId(DUMMY_DEVICE_KEY))
+
+        val olmAccount1 = OlmAccount().apply {
+            generateOneTimeKeys(1)
+        }
+
+        val olmSession1 = OlmSession().apply {
+            initOutboundSession(olmAccount1,
+                    olmAccount1.identityKeys()[OlmAccount.JSON_KEY_IDENTITY_KEY],
+                    olmAccount1.oneTimeKeys()[OlmAccount.JSON_KEY_ONE_TIME_KEY]?.values?.first())
+        }
+
+        val sessionId1 = olmSession1.sessionIdentifier()
+        val olmSessionWrapper1 = OlmSessionWrapper(olmSession1)
+
+        cryptoStore.storeSession(olmSessionWrapper1, DUMMY_DEVICE_KEY)
+
+        assertEquals(sessionId1, cryptoStore.getLastUsedSessionId(DUMMY_DEVICE_KEY))
+
+        val olmAccount2 = OlmAccount().apply {
+            generateOneTimeKeys(1)
+        }
+
+        val olmSession2 = OlmSession().apply {
+            initOutboundSession(olmAccount2,
+                    olmAccount2.identityKeys()[OlmAccount.JSON_KEY_IDENTITY_KEY],
+                    olmAccount2.oneTimeKeys()[OlmAccount.JSON_KEY_ONE_TIME_KEY]?.values?.first())
+        }
+
+        val sessionId2 = olmSession2.sessionIdentifier()
+        val olmSessionWrapper2 = OlmSessionWrapper(olmSession2)
+
+        cryptoStore.storeSession(olmSessionWrapper2, DUMMY_DEVICE_KEY)
+
+        // Ensure sessionIds are distinct
+        assertNotEquals(sessionId1, sessionId2)
+
+        // Note: we cannot be sure what will be the result of getLastUsedSessionId() here
+
+        olmSessionWrapper2.onMessageReceived()
+        cryptoStore.storeSession(olmSessionWrapper2, DUMMY_DEVICE_KEY)
+
+        // sessionId2 is returned now
+        assertEquals(sessionId2, cryptoStore.getLastUsedSessionId(DUMMY_DEVICE_KEY))
+
+        Thread.sleep(2)
+
+        olmSessionWrapper1.onMessageReceived()
+        cryptoStore.storeSession(olmSessionWrapper1, DUMMY_DEVICE_KEY)
+
+        // sessionId1 is returned now
+        assertEquals(sessionId1, cryptoStore.getLastUsedSessionId(DUMMY_DEVICE_KEY))
+
+        // Cleanup
+        olmSession1.releaseSession()
+        olmSession2.releaseSession()
+
+        olmAccount1.releaseAccount()
+        olmAccount2.releaseAccount()
+    }
+}

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/internal/util/JsonCanonicalizerTest.kt

@@ -0,0 +1,153 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.internal.util
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import im.vector.matrix.android.InstrumentedTest
+import org.junit.Assert.assertEquals
+import org.junit.Test
+import org.junit.runner.RunWith
+
+@RunWith(AndroidJUnit4::class)
+internal class JsonCanonicalizerTest : InstrumentedTest {
+
+    @Test
+    fun identityTest() {
+        listOf(
+                "{}",
+                """{"a":true}""",
+                """{"a":false}""",
+                """{"a":1}""",
+                """{"a":1.2}""",
+                """{"a":null}""",
+                """{"a":[]}""",
+                """{"a":["b":"c"]}""",
+                """{"a":["c":"b","d":"e"]}""",
+                """{"a":["d":"b","c":"e"]}"""
+        ).forEach {
+            assertEquals(it,
+                    JsonCanonicalizer.canonicalize(it))
+        }
+    }
+
+    @Test
+    fun reorderTest() {
+        assertEquals("""{"a":true,"b":false}""",
+                JsonCanonicalizer.canonicalize("""{"b":false,"a":true}"""))
+    }
+
+    @Test
+    fun realSampleTest() {
+        assertEquals("""{"algorithms":["m.megolm.v1.aes-sha2","m.olm.v1.curve25519-aes-sha2"],"device_id":"VSCUNFSOUI","keys":{"curve25519:VSCUNFSOUI":"utyOjnhiQ73qNhi9HlN0OgWIowe5gthTS8r0r9TcJ3o","ed25519:VSCUNFSOUI":"qNhEt+Yggaajet0hX\/FjTRLfySgs65ldYyomm7PIx6U"},"user_id":"@benoitx:matrix.org"}""",
+                JsonCanonicalizer.canonicalize("""{"algorithms":["m.megolm.v1.aes-sha2","m.olm.v1.curve25519-aes-sha2"],"device_id":"VSCUNFSOUI","user_id":"@benoitx:matrix.org","keys":{"curve25519:VSCUNFSOUI":"utyOjnhiQ73qNhi9HlN0OgWIowe5gthTS8r0r9TcJ3o","ed25519:VSCUNFSOUI":"qNhEt+Yggaajet0hX/FjTRLfySgs65ldYyomm7PIx6U"}}"""))
+    }
+
+    @Test
+    fun doubleQuoteTest() {
+        assertEquals("{\"a\":\"\\\"\"}",
+                JsonCanonicalizer.canonicalize("{\"a\":\"\\\"\"}"))
+    }
+
+    /* ==========================================================================================
+     * Test from https://matrix.org/docs/spec/appendices.html#examples
+     * ========================================================================================== */
+
+    @Test
+    fun matrixOrg001Test() {
+        assertEquals("""{}""",
+                JsonCanonicalizer.canonicalize("""{}"""))
+    }
+
+    @Test
+    fun matrixOrg002Test() {
+        assertEquals("""{"one":1,"two":"Two"}""",
+                JsonCanonicalizer.canonicalize("""{
+    "one": 1,
+    "two": "Two"
+}"""))
+    }
+
+    @Test
+    fun matrixOrg003Test() {
+        assertEquals("""{"a":"1","b":"2"}""",
+                JsonCanonicalizer.canonicalize("""{
+    "b": "2",
+    "a": "1"
+}"""))
+    }
+
+    @Test
+    fun matrixOrg004Test() {
+        assertEquals("""{"a":"1","b":"2"}""",
+                JsonCanonicalizer.canonicalize("""{"b":"2","a":"1"}"""))
+    }
+
+    @Test
+    fun matrixOrg005Test() {
+        assertEquals("""{"auth":{"mxid":"@john.doe:example.com","profile":{"display_name":"John Doe","three_pids":[{"address":"john.doe@example.org","medium":"email"},{"address":"123456789","medium":"msisdn"}]},"success":true}}""",
+                JsonCanonicalizer.canonicalize("""{
+    "auth": {
+        "success": true,
+        "mxid": "@john.doe:example.com",
+        "profile": {
+            "display_name": "John Doe",
+            "three_pids": [
+                {
+                    "medium": "email",
+                    "address": "john.doe@example.org"
+                },
+                {
+                    "medium": "msisdn",
+                    "address": "123456789"
+                }
+            ]
+        }
+    }
+}"""))
+    }
+
+    @Test
+    fun matrixOrg006Test() {
+        assertEquals("""{"a":"日本語"}""",
+                JsonCanonicalizer.canonicalize("""{
+    "a": "日本語"
+}"""))
+    }
+
+    @Test
+    fun matrixOrg007Test() {
+        assertEquals("""{"日":1,"本":2}""",
+                JsonCanonicalizer.canonicalize("""{
+    "本": 2,
+    "日": 1
+}"""))
+    }
+
+    @Test
+    fun matrixOrg008Test() {
+        assertEquals("""{"a":"日"}""",
+                JsonCanonicalizer.canonicalize("{\"a\": \"\u65E5\"}"))
+    }
+
+    @Test
+    fun matrixOrg009Test() {
+        assertEquals("""{"a":null}""",
+                JsonCanonicalizer.canonicalize("""{
+    "a": null
+}"""))
+    }
+}

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/ChunkEntityTest.kt

@@ -19,11 +19,7 @@ package im.vector.matrix.android.session.room.timeline
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import com.zhuinden.monarchy.Monarchy
 import im.vector.matrix.android.InstrumentedTest
-import im.vector.matrix.android.internal.database.helper.add
-import im.vector.matrix.android.internal.database.helper.addAll
-import im.vector.matrix.android.internal.database.helper.isUnlinked
-import im.vector.matrix.android.internal.database.helper.lastStateIndex
-import im.vector.matrix.android.internal.database.helper.merge
+import im.vector.matrix.android.internal.database.helper.*
 import im.vector.matrix.android.internal.database.model.ChunkEntity
 import im.vector.matrix.android.internal.session.room.timeline.PaginationDirection
 import im.vector.matrix.android.session.room.timeline.RoomDataHelper.createFakeListOfEvents
@@ -39,7 +35,6 @@ import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
 
-
 @RunWith(AndroidJUnit4::class)
 internal class ChunkEntityTest : InstrumentedTest {
 
@@ -52,14 +47,13 @@ internal class ChunkEntityTest : InstrumentedTest {
         monarchy = Monarchy.Builder().setRealmConfiguration(testConfig).build()
     }
 
-
     @Test
     fun add_shouldAdd_whenNotAlreadyIncluded() {
         monarchy.runTransactionSync { realm ->
             val chunk: ChunkEntity = realm.createObject()
             val fakeEvent = createFakeMessageEvent()
             chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
-            chunk.events.size shouldEqual 1
+            chunk.timelineEvents.size shouldEqual 1
         }
     }
 
@@ -70,7 +64,7 @@ internal class ChunkEntityTest : InstrumentedTest {
             val fakeEvent = createFakeMessageEvent()
             chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
             chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
-            chunk.events.size shouldEqual 1
+            chunk.timelineEvents.size shouldEqual 1
         }
     }
 
@@ -126,7 +120,7 @@ internal class ChunkEntityTest : InstrumentedTest {
             chunk1.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS)
             chunk2.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS)
             chunk1.merge("roomId", chunk2, PaginationDirection.BACKWARDS)
-            chunk1.events.size shouldEqual 60
+            chunk1.timelineEvents.size shouldEqual 60
         }
     }
 
@@ -142,7 +136,7 @@ internal class ChunkEntityTest : InstrumentedTest {
             chunk1.addAll("roomId", eventsForChunk1, PaginationDirection.FORWARDS)
             chunk2.addAll("roomId", eventsForChunk2, PaginationDirection.BACKWARDS)
             chunk1.merge("roomId", chunk2, PaginationDirection.BACKWARDS)
-            chunk1.events.size shouldEqual 40
+            chunk1.timelineEvents.size shouldEqual 40
             chunk1.isLastForward.shouldBeTrue()
         }
     }
@@ -198,5 +192,4 @@ internal class ChunkEntityTest : InstrumentedTest {
             chunk1.nextToken shouldEqual nextToken
         }
     }
-
-}
+}

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/FakeGetContextOfEventTask.kt

@@ -16,16 +16,14 @@
 
 package im.vector.matrix.android.session.room.timeline
 
-import arrow.core.Try
 import im.vector.matrix.android.internal.session.room.timeline.GetContextOfEventTask
 import im.vector.matrix.android.internal.session.room.timeline.PaginationDirection
-import im.vector.matrix.android.internal.session.room.timeline.TokenChunkEvent
 import im.vector.matrix.android.internal.session.room.timeline.TokenChunkEventPersistor
 import kotlin.random.Random
 
-internal class FakeGetContextOfEventTask(private val tokenChunkEventPersistor: TokenChunkEventPersistor) : GetContextOfEventTask {
+internal class FakeGetContextOfEventTask constructor(private val tokenChunkEventPersistor: TokenChunkEventPersistor) : GetContextOfEventTask {
 
-    override fun execute(params: GetContextOfEventTask.Params): Try<TokenChunkEventPersistor.Result> {
+    override suspend fun execute(params: GetContextOfEventTask.Params): TokenChunkEventPersistor.Result {
         val fakeEvents = RoomDataHelper.createFakeListOfEvents(30)
         val tokenChunkEvent = FakeTokenChunkEvent(
                 Random.nextLong(System.currentTimeMillis()).toString(),
@@ -34,6 +32,4 @@ internal class FakeGetContextOfEventTask(private val tokenChunkEventPersistor: T
         )
         return tokenChunkEventPersistor.insertInDb(tokenChunkEvent, params.roomId, PaginationDirection.BACKWARDS)
     }
-
-
-}
+}

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/FakePaginationTask.kt

@@ -16,18 +16,16 @@
 
 package im.vector.matrix.android.session.room.timeline
 
-import arrow.core.Try
 import im.vector.matrix.android.internal.session.room.timeline.PaginationTask
 import im.vector.matrix.android.internal.session.room.timeline.TokenChunkEventPersistor
+import javax.inject.Inject
 import kotlin.random.Random
 
-internal class FakePaginationTask(private val tokenChunkEventPersistor: TokenChunkEventPersistor) : PaginationTask {
+internal class FakePaginationTask @Inject constructor(private val tokenChunkEventPersistor: TokenChunkEventPersistor) : PaginationTask {
 
-    override fun execute(params: PaginationTask.Params): Try<TokenChunkEventPersistor.Result> {
+    override suspend fun execute(params: PaginationTask.Params): TokenChunkEventPersistor.Result {
         val fakeEvents = RoomDataHelper.createFakeListOfEvents(30)
         val tokenChunkEvent = FakeTokenChunkEvent(params.from, Random.nextLong(System.currentTimeMillis()).toString(), fakeEvents)
         return tokenChunkEventPersistor.insertInDb(tokenChunkEvent, params.roomId, params.direction)
     }
-
 }
-

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/FakeTokenChunkEvent.kt

@@ -23,4 +23,4 @@ internal data class FakeTokenChunkEvent(override val start: String?,
                                         override val end: String?,
                                         override val events: List<Event> = emptyList(),
                                         override val stateEvents: List<Event> = emptyList()
-) : TokenChunkEvent
+) : TokenChunkEvent

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/RoomDataHelper.kt

@@ -59,7 +59,7 @@ object RoomDataHelper {
                 eventId = Random.nextLong().toString(),
                 content = content,
                 prevContent = prevContent,
-                sender = sender,
+                senderId = sender,
                 stateKey = stateKey
         )
     }
@@ -88,6 +88,4 @@ object RoomDataHelper {
             roomEntity.addOrUpdate(chunkEntity)
         }
     }
-
-
-}
+}

matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/TimelineTest.kt

@@ -18,24 +18,6 @@ package im.vector.matrix.android.session.room.timeline
 
 import com.zhuinden.monarchy.Monarchy
 import im.vector.matrix.android.InstrumentedTest
-import im.vector.matrix.android.api.auth.data.Credentials
-import im.vector.matrix.android.api.session.room.timeline.Timeline
-import im.vector.matrix.android.api.session.room.timeline.TimelineEvent
-import im.vector.matrix.android.internal.session.room.EventRelationExtractor
-import im.vector.matrix.android.internal.session.room.EventRelationsAggregationUpdater
-import im.vector.matrix.android.internal.session.room.members.SenderRoomMemberExtractor
-import im.vector.matrix.android.internal.session.room.timeline.DefaultTimeline
-import im.vector.matrix.android.internal.session.room.timeline.TimelineEventFactory
-import im.vector.matrix.android.internal.session.room.timeline.TokenChunkEventPersistor
-import im.vector.matrix.android.internal.task.TaskExecutor
-import im.vector.matrix.android.testCoroutineDispatchers
-import io.realm.Realm
-import io.realm.RealmConfiguration
-import org.amshove.kluent.shouldEqual
-import org.junit.Before
-import org.junit.Test
-import timber.log.Timber
-import java.util.concurrent.CountDownLatch
 
 internal class TimelineTest : InstrumentedTest {
 
@@ -45,59 +27,58 @@ internal class TimelineTest : InstrumentedTest {
 
     private lateinit var monarchy: Monarchy
 
-    @Before
-    fun setup() {
-        Timber.plant(Timber.DebugTree())
-        Realm.init(context())
-        val testConfiguration = RealmConfiguration.Builder().name("test-realm").build()
-        Realm.deleteRealm(testConfiguration)
-        monarchy = Monarchy.Builder().setRealmConfiguration(testConfiguration).build()
-        RoomDataHelper.fakeInitialSync(monarchy, ROOM_ID)
-    }
-
-    private fun createTimeline(initialEventId: String? = null): Timeline {
-        val taskExecutor = TaskExecutor(testCoroutineDispatchers)
-        val erau = EventRelationsAggregationUpdater(Credentials("", "", "", null, null))
-        val tokenChunkEventPersistor = TokenChunkEventPersistor(monarchy, erau)
-        val paginationTask = FakePaginationTask(tokenChunkEventPersistor)
-        val getContextOfEventTask = FakeGetContextOfEventTask(tokenChunkEventPersistor)
-        val roomMemberExtractor = SenderRoomMemberExtractor(ROOM_ID)
-        val timelineEventFactory = TimelineEventFactory(roomMemberExtractor, EventRelationExtractor())
-        return DefaultTimeline(
-                ROOM_ID,
-                initialEventId,
-                monarchy.realmConfiguration,
-                taskExecutor,
-                getContextOfEventTask,
-                timelineEventFactory,
-                paginationTask,
-                null)
-    }
-
-    @Test
-    fun backPaginate_shouldLoadMoreEvents_whenPaginateIsCalled() {
-        val timeline = createTimeline()
-        timeline.start()
-        val paginationCount = 30
-        var initialLoad = 0
-        val latch = CountDownLatch(2)
-        var timelineEvents: List<TimelineEvent> = emptyList()
-        timeline.listener = object : Timeline.Listener {
-            override fun onUpdated(snapshot: List<TimelineEvent>) {
-                if (snapshot.isNotEmpty()) {
-                    if (initialLoad == 0) {
-                        initialLoad = snapshot.size
-                    }
-                    timelineEvents = snapshot
-                    latch.countDown()
-                    timeline.paginate(Timeline.Direction.BACKWARDS, paginationCount)
-                }
-            }
-        }
-        latch.await()
-        timelineEvents.size shouldEqual initialLoad + paginationCount
-        timeline.dispose()
-    }
-
-
-}
+//    @Before
+//    fun setup() {
+//        Timber.plant(Timber.DebugTree())
+//        Realm.init(context())
+//        val testConfiguration = RealmConfiguration.Builder().name("test-realm")
+//                .modules(SessionRealmModule()).build()
+//
+//        Realm.deleteRealm(testConfiguration)
+//        monarchy = Monarchy.Builder().setRealmConfiguration(testConfiguration).build()
+//        RoomDataHelper.fakeInitialSync(monarchy, ROOM_ID)
+//    }
+//
+//    private fun createTimeline(initialEventId: String? = null): Timeline {
+//        val taskExecutor = TaskExecutor(testCoroutineDispatchers)
+//        val tokenChunkEventPersistor = TokenChunkEventPersistor(monarchy)
+//        val paginationTask = FakePaginationTask @Inject constructor(tokenChunkEventPersistor)
+//        val getContextOfEventTask = FakeGetContextOfEventTask @Inject constructor(tokenChunkEventPersistor)
+//        val roomMemberExtractor = SenderRoomMemberExtractor(ROOM_ID)
+//        val timelineEventFactory = TimelineEventFactory(roomMemberExtractor, EventRelationExtractor())
+//        return DefaultTimeline(
+//                ROOM_ID,
+//                initialEventId,
+//                monarchy.realmConfiguration,
+//                taskExecutor,
+//                getContextOfEventTask,
+//                timelineEventFactory,
+//                paginationTask,
+//                null)
+//    }
+//
+//    @Test
+//    fun backPaginate_shouldLoadMoreEvents_whenPaginateIsCalled() {
+//        val timeline = createTimeline()
+//        timeline.start()
+//        val paginationCount = 30
+//        var initialLoad = 0
+//        val latch = CountDownLatch(2)
+//        var timelineEvents: List<TimelineEvent> = emptyList()
+//        timeline.listener = object : Timeline.Listener {
+//            override fun onUpdated(snapshot: List<TimelineEvent>) {
+//                if (snapshot.isNotEmpty()) {
+//                    if (initialLoad == 0) {
+//                        initialLoad = snapshot.size
+//                    }
+//                    timelineEvents = snapshot
+//                    latch.countDown()
+//                    timeline.paginate(Timeline.Direction.BACKWARDS, paginationCount)
+//                }
+//            }
+//        }
+//        latch.await()
+//        timelineEvents.size shouldEqual initialLoad + paginationCount
+//        timeline.dispose()
+//    }
+}

matrix-sdk-android/src/debug/java/im/vector/matrix/android/internal/network/interceptors/CurlLoggingInterceptor.kt

@@ -17,12 +17,15 @@
 
 package im.vector.matrix.android.internal.network.interceptors
 
+import im.vector.matrix.android.internal.di.MatrixScope
 import okhttp3.Interceptor
 import okhttp3.Response
 import okhttp3.logging.HttpLoggingInterceptor
 import okio.Buffer
+import timber.log.Timber
 import java.io.IOException
 import java.nio.charset.Charset
+import javax.inject.Inject
 
 /**
  * An OkHttp interceptor that logs requests as curl shell commands. They can then
@@ -33,7 +36,8 @@ import java.nio.charset.Charset
  * information. It should only be used in a controlled manner or in a
  * non-production environment.
  */
-internal class CurlLoggingInterceptor(private val logger: HttpLoggingInterceptor.Logger = HttpLoggingInterceptor.Logger.DEFAULT)
+@MatrixScope
+internal class CurlLoggingInterceptor @Inject constructor(private val logger: HttpLoggingInterceptor.Logger)
     : Interceptor {
 
     /**
@@ -48,27 +52,33 @@ internal class CurlLoggingInterceptor(private val logger: HttpLoggingInterceptor
         var compressed = false
 
         var curlCmd = "curl"
-        if (curlOptions != null) {
-            curlCmd += " " + curlOptions!!
+        curlOptions?.let {
+            curlCmd += " $it"
         }
-        curlCmd += " -X " + request.method()
+        curlCmd += " -X " + request.method
 
-        val requestBody = request.body()
+        val requestBody = request.body
         if (requestBody != null) {
-            val buffer = Buffer()
-            requestBody.writeTo(buffer)
-            var charset: Charset? = UTF8
-            val contentType = requestBody.contentType()
-            if (contentType != null) {
-                charset = contentType.charset(UTF8)
+            if (requestBody.contentLength() > 100_000) {
+                Timber.w("Unable to log curl command data, size is too big (${requestBody.contentLength()})")
+                // Ensure the curl command will failed
+                curlCmd += "DATA IS TOO BIG"
+            } else {
+                val buffer = Buffer()
+                requestBody.writeTo(buffer)
+                var charset: Charset? = UTF8
+                val contentType = requestBody.contentType()
+                if (contentType != null) {
+                    charset = contentType.charset(UTF8)
+                }
+                // try to keep to a single line and use a subshell to preserve any line breaks
+                curlCmd += " --data $'" + buffer.readString(charset!!).replace("\n", "\\n") + "'"
             }
-            // try to keep to a single line and use a subshell to preserve any line breaks
-            curlCmd += " --data $'" + buffer.readString(charset!!).replace("\n", "\\n") + "'"
         }
 
-        val headers = request.headers()
+        val headers = request.headers
         var i = 0
-        val count = headers.size()
+        val count = headers.size
         while (i < count) {
             val name = headers.name(i)
             val value = headers.value(i)
@@ -79,7 +89,7 @@ internal class CurlLoggingInterceptor(private val logger: HttpLoggingInterceptor
             i++
         }
 
-        curlCmd += ((if (compressed) " --compressed " else " ") + "'" + request.url().toString()
+        curlCmd += ((if (compressed) " --compressed " else " ") + "'" + request.url.toString()
                 // Replace localhost for emulator by localhost for shell
                 .replace("://10.0.2.2:8080/".toRegex(), "://127.0.0.1:8080/")
                 + "'")
@@ -87,7 +97,7 @@ internal class CurlLoggingInterceptor(private val logger: HttpLoggingInterceptor
         // Add Json formatting
         curlCmd += " | python -m json.tool"
 
-        logger.log("--- cURL (" + request.url() + ")")
+        logger.log("--- cURL (" + request.url + ")")
         logger.log(curlCmd)
 
         return chain.proceed(request)

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

@@ -51,7 +51,6 @@ class FormattedJsonHttpLogger : HttpLoggingInterceptor.Logger {
                     // Finally this is not a JSON string...
                     Timber.e(e)
                 }
-
             } else if (message.startsWith("[")) {
                 // JSON Array detected
                 try {
@@ -61,7 +60,6 @@ class FormattedJsonHttpLogger : HttpLoggingInterceptor.Logger {
                     // Finally not JSON...
                     Timber.e(e)
                 }
-
             }
             // Else not a json string to log
         }
@@ -73,4 +71,4 @@ class FormattedJsonHttpLogger : HttpLoggingInterceptor.Logger {
             Timber.v(s)
         }
     }
-}
+}

matrix-sdk-android/src/main/AndroidManifest.xml

@@ -1,4 +1,5 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
     package="im.vector.matrix.android">
 
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
@@ -7,9 +8,10 @@
 
     <application>
 
-        <provider
-            android:name=".internal.MatrixInitProvider"
-            android:authorities="im.vector.matrix.android.MatrixInitProvider" />
+        <provider android:name="androidx.work.impl.WorkManagerInitializer"
+            android:authorities="${applicationId}.workmanager-init"
+            android:exported="false"
+            tools:node="remove" />
 
     </application>
 

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

@@ -18,74 +18,83 @@ package im.vector.matrix.android.api
 
 import android.content.Context
 import androidx.lifecycle.ProcessLifecycleOwner
+import androidx.work.Configuration
+import androidx.work.WorkManager
 import com.zhuinden.monarchy.Monarchy
-import im.vector.matrix.android.api.auth.Authenticator
-import im.vector.matrix.android.api.session.Session
-import im.vector.matrix.android.api.session.sync.FilterService
-import im.vector.matrix.android.internal.auth.AuthModule
-import im.vector.matrix.android.internal.di.MatrixKoinComponent
-import im.vector.matrix.android.internal.di.MatrixKoinHolder
-import im.vector.matrix.android.internal.di.MatrixModule
-import im.vector.matrix.android.internal.di.NetworkModule
+import im.vector.matrix.android.BuildConfig
+import im.vector.matrix.android.api.auth.AuthenticationService
+import im.vector.matrix.android.internal.SessionManager
+import im.vector.matrix.android.internal.di.DaggerMatrixComponent
 import im.vector.matrix.android.internal.network.UserAgentHolder
 import im.vector.matrix.android.internal.util.BackgroundDetectionObserver
-import org.koin.standalone.inject
+import org.matrix.olm.OlmManager
 import java.util.concurrent.atomic.AtomicBoolean
+import javax.inject.Inject
+
+data class MatrixConfiguration(
+        val applicationFlavor: String = "Default-application-flavor"
+) {
+
+    interface Provider {
+        fun providesMatrixConfiguration(): MatrixConfiguration
+    }
+}
 
 /**
  * This is the main entry point to the matrix sdk.
- * This class is automatically init by a provider.
  * To get the singleton instance, use getInstance static method.
  */
-class Matrix private constructor(context: Context) : MatrixKoinComponent {
+class Matrix private constructor(context: Context, matrixConfiguration: MatrixConfiguration) {
 
-    private val authenticator by inject<Authenticator>()
-    private val userAgentHolder by inject<UserAgentHolder>()
-    private val backgroundDetectionObserver by inject<BackgroundDetectionObserver>()
-    var currentSession: Session? = null
+    @Inject internal lateinit var authenticationService: AuthenticationService
+    @Inject internal lateinit var userAgentHolder: UserAgentHolder
+    @Inject internal lateinit var backgroundDetectionObserver: BackgroundDetectionObserver
+    @Inject internal lateinit var olmManager: OlmManager
+    @Inject internal lateinit var sessionManager: SessionManager
 
     init {
         Monarchy.init(context)
-        val matrixModule = MatrixModule(context).definition
-        val networkModule = NetworkModule().definition
-        val authModule = AuthModule().definition
-        MatrixKoinHolder.instance.loadModules(listOf(matrixModule, networkModule, authModule))
-        ProcessLifecycleOwner.get().lifecycle.addObserver(backgroundDetectionObserver)
-        authenticator.getLastActiveSession()?.also {
-            currentSession = it
-            it.open()
-            it.setFilter(FilterService.FilterPreset.RiotFilter)
-            it.startSync()
+        DaggerMatrixComponent.factory().create(context).inject(this)
+        if (context.applicationContext !is Configuration.Provider) {
+            WorkManager.initialize(context, Configuration.Builder().build())
         }
-    }
-
-    fun authenticator(): Authenticator {
-        return authenticator
-    }
-
-    /**
-     * Set application flavor, to alter user agent.
-     */
-    fun setApplicationFlavor(flavor: String) {
-        userAgentHolder.setApplicationFlavor(flavor)
+        ProcessLifecycleOwner.get().lifecycle.addObserver(backgroundDetectionObserver)
+        userAgentHolder.setApplicationFlavor(matrixConfiguration.applicationFlavor)
     }
 
     fun getUserAgent() = userAgentHolder.userAgent
 
+    fun authenticationService(): AuthenticationService {
+        return authenticationService
+    }
+
     companion object {
+
         private lateinit var instance: Matrix
         private val isInit = AtomicBoolean(false)
 
-        internal fun initialize(context: Context) {
+        fun initialize(context: Context, matrixConfiguration: MatrixConfiguration) {
             if (isInit.compareAndSet(false, true)) {
-                instance = Matrix(context.applicationContext)
+                instance = Matrix(context.applicationContext, matrixConfiguration)
             }
         }
 
-        fun getInstance(): Matrix {
+        fun getInstance(context: Context): Matrix {
+            if (isInit.compareAndSet(false, true)) {
+                val appContext = context.applicationContext
+                if (appContext is MatrixConfiguration.Provider) {
+                    val matrixConfiguration = (appContext as MatrixConfiguration.Provider).providesMatrixConfiguration()
+                    instance = Matrix(appContext, matrixConfiguration)
+                } else {
+                    throw IllegalStateException("Matrix is not initialized properly." +
+                            " You should call Matrix.initialize or let your application implements MatrixConfiguration.Provider.")
+                }
+            }
             return instance
         }
 
+        fun getSdkVersion(): String {
+            return BuildConfig.VERSION_NAME + " (" + BuildConfig.GIT_SDK_REVISION + ")"
+        }
     }
-
 }

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/MatrixCallback.kt

@@ -27,7 +27,7 @@ interface MatrixCallback<in T> {
      * @param data the data successfully returned from the async function
      */
     fun onSuccess(data: T) {
-        //no-op
+        // no-op
     }
 
     /**
@@ -35,7 +35,6 @@ interface MatrixCallback<in T> {
      * @param failure the failure data returned from the async function
      */
     fun onFailure(failure: Throwable) {
-        //no-op
+        // no-op
     }
-
-}
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/MatrixPatterns.kt

@@ -16,62 +16,63 @@
 
 package im.vector.matrix.android.api
 
-import java.util.*
-import java.util.regex.Pattern
-
 /**
  * This class contains pattern to match the different Matrix ids
  */
 object MatrixPatterns {
 
     // Note: TLD is not mandatory (localhost, IP address...)
-    private val DOMAIN_REGEX = ":[A-Z0-9.-]+(:[0-9]{2,5})?"
+    private const val DOMAIN_REGEX = ":[A-Z0-9.-]+(:[0-9]{2,5})?"
 
     // regex pattern to find matrix user ids in a string.
     // See https://matrix.org/speculator/spec/HEAD/appendices.html#historical-user-ids
-    private val MATRIX_USER_IDENTIFIER_REGEX = "@[A-Z0-9\\x21-\\x39\\x3B-\\x7F]+$DOMAIN_REGEX"
-    val PATTERN_CONTAIN_MATRIX_USER_IDENTIFIER = Pattern.compile(MATRIX_USER_IDENTIFIER_REGEX, Pattern.CASE_INSENSITIVE)
+    private const val MATRIX_USER_IDENTIFIER_REGEX = "@[A-Z0-9\\x21-\\x39\\x3B-\\x7F]+$DOMAIN_REGEX"
+    val PATTERN_CONTAIN_MATRIX_USER_IDENTIFIER = MATRIX_USER_IDENTIFIER_REGEX.toRegex(RegexOption.IGNORE_CASE)
 
     // regex pattern to find room ids in a string.
-    private val MATRIX_ROOM_IDENTIFIER_REGEX = "![A-Z0-9]+$DOMAIN_REGEX"
-    val PATTERN_CONTAIN_MATRIX_ROOM_IDENTIFIER = Pattern.compile(MATRIX_ROOM_IDENTIFIER_REGEX, Pattern.CASE_INSENSITIVE)
+    private const val MATRIX_ROOM_IDENTIFIER_REGEX = "![A-Z0-9]+$DOMAIN_REGEX"
+    private val PATTERN_CONTAIN_MATRIX_ROOM_IDENTIFIER = MATRIX_ROOM_IDENTIFIER_REGEX.toRegex(RegexOption.IGNORE_CASE)
 
     // regex pattern to find room aliases in a string.
-    private val MATRIX_ROOM_ALIAS_REGEX = "#[A-Z0-9._%#@=+-]+$DOMAIN_REGEX"
-    val PATTERN_CONTAIN_MATRIX_ALIAS = Pattern.compile(MATRIX_ROOM_ALIAS_REGEX, Pattern.CASE_INSENSITIVE)
+    private const val MATRIX_ROOM_ALIAS_REGEX = "#[A-Z0-9._%#@=+-]+$DOMAIN_REGEX"
+    private val PATTERN_CONTAIN_MATRIX_ALIAS = MATRIX_ROOM_ALIAS_REGEX.toRegex(RegexOption.IGNORE_CASE)
 
     // regex pattern to find message ids in a string.
-    private val MATRIX_EVENT_IDENTIFIER_REGEX = "\\$[A-Z0-9]+$DOMAIN_REGEX"
-    val PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER = Pattern.compile(MATRIX_EVENT_IDENTIFIER_REGEX, Pattern.CASE_INSENSITIVE)
+    private const val MATRIX_EVENT_IDENTIFIER_REGEX = "\\$[A-Z0-9]+$DOMAIN_REGEX"
+    private val PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER = MATRIX_EVENT_IDENTIFIER_REGEX.toRegex(RegexOption.IGNORE_CASE)
 
     // regex pattern to find message ids in a string.
-    private val MATRIX_EVENT_IDENTIFIER_V3_REGEX = "\\$[A-Z0-9/+]+"
-    val PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER_V3 = Pattern.compile(MATRIX_EVENT_IDENTIFIER_V3_REGEX, Pattern.CASE_INSENSITIVE)
+    private const val MATRIX_EVENT_IDENTIFIER_V3_REGEX = "\\$[A-Z0-9/+]+"
+    private val PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER_V3 = MATRIX_EVENT_IDENTIFIER_V3_REGEX.toRegex(RegexOption.IGNORE_CASE)
+
+    // Ref: https://matrix.org/docs/spec/rooms/v4#event-ids
+    private const val MATRIX_EVENT_IDENTIFIER_V4_REGEX = "\\$[A-Z0-9\\-_]+"
+    private val PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER_V4 = MATRIX_EVENT_IDENTIFIER_V4_REGEX.toRegex(RegexOption.IGNORE_CASE)
 
     // regex pattern to find group ids in a string.
-    private val MATRIX_GROUP_IDENTIFIER_REGEX = "\\+[A-Z0-9=_\\-./]+$DOMAIN_REGEX"
-    val PATTERN_CONTAIN_MATRIX_GROUP_IDENTIFIER = Pattern.compile(MATRIX_GROUP_IDENTIFIER_REGEX, Pattern.CASE_INSENSITIVE)
+    private const val MATRIX_GROUP_IDENTIFIER_REGEX = "\\+[A-Z0-9=_\\-./]+$DOMAIN_REGEX"
+    private val PATTERN_CONTAIN_MATRIX_GROUP_IDENTIFIER = MATRIX_GROUP_IDENTIFIER_REGEX.toRegex(RegexOption.IGNORE_CASE)
 
     // regex pattern to find permalink with message id.
     // Android does not support in URL so extract it.
-    private val PERMALINK_BASE_REGEX = "https://matrix\\.to/#/"
-    private val APP_BASE_REGEX = "https://[A-Z0-9.-]+\\.[A-Z]{2,}/[A-Z]{3,}/#/room/"
-    val SEP_REGEX = "/"
+    private const val PERMALINK_BASE_REGEX = "https://matrix\\.to/#/"
+    private const val APP_BASE_REGEX = "https://[A-Z0-9.-]+\\.[A-Z]{2,}/[A-Z]{3,}/#/room/"
+    const val SEP_REGEX = "/"
 
-    private val LINK_TO_ROOM_ID_REGEXP = PERMALINK_BASE_REGEX + MATRIX_ROOM_IDENTIFIER_REGEX + SEP_REGEX + MATRIX_EVENT_IDENTIFIER_REGEX
-    val PATTERN_CONTAIN_MATRIX_TO_PERMALINK_ROOM_ID = Pattern.compile(LINK_TO_ROOM_ID_REGEXP, Pattern.CASE_INSENSITIVE)
+    private const val LINK_TO_ROOM_ID_REGEXP = PERMALINK_BASE_REGEX + MATRIX_ROOM_IDENTIFIER_REGEX + SEP_REGEX + MATRIX_EVENT_IDENTIFIER_REGEX
+    private val PATTERN_CONTAIN_MATRIX_TO_PERMALINK_ROOM_ID = LINK_TO_ROOM_ID_REGEXP.toRegex(RegexOption.IGNORE_CASE)
 
-    private val LINK_TO_ROOM_ALIAS_REGEXP = PERMALINK_BASE_REGEX + MATRIX_ROOM_ALIAS_REGEX + SEP_REGEX + MATRIX_EVENT_IDENTIFIER_REGEX
-    val PATTERN_CONTAIN_MATRIX_TO_PERMALINK_ROOM_ALIAS = Pattern.compile(LINK_TO_ROOM_ALIAS_REGEXP, Pattern.CASE_INSENSITIVE)
+    private const val LINK_TO_ROOM_ALIAS_REGEXP = PERMALINK_BASE_REGEX + MATRIX_ROOM_ALIAS_REGEX + SEP_REGEX + MATRIX_EVENT_IDENTIFIER_REGEX
+    private val PATTERN_CONTAIN_MATRIX_TO_PERMALINK_ROOM_ALIAS = LINK_TO_ROOM_ALIAS_REGEXP.toRegex(RegexOption.IGNORE_CASE)
 
-    private val LINK_TO_APP_ROOM_ID_REGEXP = APP_BASE_REGEX + MATRIX_ROOM_IDENTIFIER_REGEX + SEP_REGEX + MATRIX_EVENT_IDENTIFIER_REGEX
-    val PATTERN_CONTAIN_APP_LINK_PERMALINK_ROOM_ID = Pattern.compile(LINK_TO_APP_ROOM_ID_REGEXP, Pattern.CASE_INSENSITIVE)
+    private const val LINK_TO_APP_ROOM_ID_REGEXP = APP_BASE_REGEX + MATRIX_ROOM_IDENTIFIER_REGEX + SEP_REGEX + MATRIX_EVENT_IDENTIFIER_REGEX
+    private val PATTERN_CONTAIN_APP_LINK_PERMALINK_ROOM_ID = LINK_TO_APP_ROOM_ID_REGEXP.toRegex(RegexOption.IGNORE_CASE)
 
-    private val LINK_TO_APP_ROOM_ALIAS_REGEXP = APP_BASE_REGEX + MATRIX_ROOM_ALIAS_REGEX + SEP_REGEX + MATRIX_EVENT_IDENTIFIER_REGEX
-    val PATTERN_CONTAIN_APP_LINK_PERMALINK_ROOM_ALIAS = Pattern.compile(LINK_TO_APP_ROOM_ALIAS_REGEXP, Pattern.CASE_INSENSITIVE)
+    private const val LINK_TO_APP_ROOM_ALIAS_REGEXP = APP_BASE_REGEX + MATRIX_ROOM_ALIAS_REGEX + SEP_REGEX + MATRIX_EVENT_IDENTIFIER_REGEX
+    private val PATTERN_CONTAIN_APP_LINK_PERMALINK_ROOM_ALIAS = LINK_TO_APP_ROOM_ALIAS_REGEXP.toRegex(RegexOption.IGNORE_CASE)
 
     // list of patterns to find some matrix item.
-    val MATRIX_PATTERNS = Arrays.asList(
+    val MATRIX_PATTERNS = listOf(
             PATTERN_CONTAIN_MATRIX_TO_PERMALINK_ROOM_ID,
             PATTERN_CONTAIN_MATRIX_TO_PERMALINK_ROOM_ALIAS,
             PATTERN_CONTAIN_APP_LINK_PERMALINK_ROOM_ID,
@@ -90,7 +91,7 @@ object MatrixPatterns {
      * @return true if the string is a valid user id
      */
     fun isUserId(str: String?): Boolean {
-        return str != null && PATTERN_CONTAIN_MATRIX_USER_IDENTIFIER.matcher(str).matches()
+        return str != null && str matches PATTERN_CONTAIN_MATRIX_USER_IDENTIFIER
     }
 
     /**
@@ -100,7 +101,7 @@ object MatrixPatterns {
      * @return true if the string is a valid room Id
      */
     fun isRoomId(str: String?): Boolean {
-        return str != null && PATTERN_CONTAIN_MATRIX_ROOM_IDENTIFIER.matcher(str).matches()
+        return str != null && str matches PATTERN_CONTAIN_MATRIX_ROOM_IDENTIFIER
     }
 
     /**
@@ -110,7 +111,7 @@ object MatrixPatterns {
      * @return true if the string is a valid room alias.
      */
     fun isRoomAlias(str: String?): Boolean {
-        return str != null && PATTERN_CONTAIN_MATRIX_ALIAS.matcher(str).matches()
+        return str != null && str matches PATTERN_CONTAIN_MATRIX_ALIAS
     }
 
     /**
@@ -121,7 +122,9 @@ object MatrixPatterns {
      */
     fun isEventId(str: String?): Boolean {
         return str != null
-                && (PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER.matcher(str).matches() || PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER_V3.matcher(str).matches())
+               && (str matches PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER
+                   || str matches PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER_V3
+                   || str matches PATTERN_CONTAIN_MATRIX_EVENT_IDENTIFIER_V4)
     }
 
     /**
@@ -131,6 +134,24 @@ object MatrixPatterns {
      * @return true if the string is a valid group id.
      */
     fun isGroupId(str: String?): Boolean {
-        return str != null && PATTERN_CONTAIN_MATRIX_GROUP_IDENTIFIER.matcher(str).matches()
+        return str != null && str matches PATTERN_CONTAIN_MATRIX_GROUP_IDENTIFIER
     }
-}// Cannot be instantiated
+
+    /**
+     * Extract server name from a matrix id
+     *
+     * @param matrixId
+     * @return null if not found or if matrixId is null
+     */
+    fun extractServerNameFromId(matrixId: String?): String? {
+        if (matrixId == null) {
+            return null
+        }
+
+        val index = matrixId.indexOf(":")
+
+        return if (index == -1) {
+            null
+        } else matrixId.substring(index + 1)
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/AuthenticationService.kt

@@ -0,0 +1,92 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.auth
+
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.auth.data.Credentials
+import im.vector.matrix.android.api.auth.data.HomeServerConnectionConfig
+import im.vector.matrix.android.api.auth.data.LoginFlowResult
+import im.vector.matrix.android.api.auth.data.SessionParams
+import im.vector.matrix.android.api.auth.login.LoginWizard
+import im.vector.matrix.android.api.auth.registration.RegistrationWizard
+import im.vector.matrix.android.api.session.Session
+import im.vector.matrix.android.api.util.Cancelable
+
+/**
+ * This interface defines methods to authenticate or to create an account to a matrix server.
+ */
+interface AuthenticationService {
+
+    /**
+     * Request the supported login flows for this homeserver.
+     * This is the first method to call to be able to get a wizard to login or the create an account
+     */
+    fun getLoginFlow(homeServerConnectionConfig: HomeServerConnectionConfig, callback: MatrixCallback<LoginFlowResult>): Cancelable
+
+    /**
+     * Return a LoginWizard, to login to the homeserver. The login flow has to be retrieved first.
+     */
+    fun getLoginWizard(): LoginWizard
+
+    /**
+     * Return a RegistrationWizard, to create an matrix account on the homeserver. The login flow has to be retrieved first.
+     */
+    fun getRegistrationWizard(): RegistrationWizard
+
+    /**
+     * True when login and password has been sent with success to the homeserver
+     */
+    val isRegistrationStarted: Boolean
+
+    /**
+     * Cancel pending login or pending registration
+     */
+    fun cancelPendingLoginOrRegistration()
+
+    /**
+     * Reset all pending settings, including current HomeServerConnectionConfig
+     */
+    fun reset()
+
+    /**
+     * Check if there is an authenticated [Session].
+     * @return true if there is at least one active session.
+     */
+    fun hasAuthenticatedSessions(): Boolean
+
+    /**
+     * Get the last authenticated [Session], if there is an active session.
+     * @return the last active session if any, or null
+     */
+    fun getLastAuthenticatedSession(): Session?
+
+    /**
+     * Get an authenticated session. You should at least call authenticate one time before.
+     * If you logout, this session will no longer be valid.
+     *
+     * @param sessionParams the sessionParams to open with.
+     * @return the associated session if any, or null
+     */
+    fun getSession(sessionParams: SessionParams): Session?
+
+    /**
+     * Create a session after a SSO successful login
+     */
+    fun createSessionFromSso(homeServerConnectionConfig: HomeServerConnectionConfig,
+                             credentials: Credentials,
+                             callback: MatrixCallback<Session>): Cancelable
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/Credentials.kt

@@ -30,4 +30,7 @@ data class Credentials(
         @Json(name = "home_server") val homeServer: String,
         @Json(name = "access_token") val accessToken: String,
         @Json(name = "refresh_token") val refreshToken: String?,
-        @Json(name = "device_id") val deviceId: String?)
+        @Json(name = "device_id") val deviceId: String?,
+        // Optional data that may contain info to override home server and/or identity server
+        @Json(name = "well_known") val wellKnown: WellKnown? = null
+)

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/HomeServerConnectionConfig.kt

@@ -25,13 +25,13 @@ import okhttp3.TlsVersion
 
 /**
  * This data class holds how to connect to a specific Homeserver.
- * It's used with [im.vector.matrix.android.api.auth.Authenticator] class.
+ * It's used with [im.vector.matrix.android.api.auth.AuthenticationService] class.
  * You should use the [Builder] to create one.
  */
 @JsonClass(generateAdapter = true)
 data class HomeServerConnectionConfig(
         val homeServerUri: Uri,
-        val identityServerUri: Uri,
+        val identityServerUri: Uri? = null,
         val antiVirusServerUri: Uri? = null,
         val allowedFingerprints: MutableList<Fingerprint> = ArrayList(),
         val shouldPin: Boolean = false,
@@ -48,7 +48,7 @@ data class HomeServerConnectionConfig(
     class Builder {
 
         private lateinit var homeServerUri: Uri
-        private lateinit var identityServerUri: Uri
+        private var identityServerUri: Uri? = null
         private var antiVirusServerUri: Uri? = null
         private val allowedFingerprints: MutableList<Fingerprint> = ArrayList()
         private var shouldPin: Boolean = false
@@ -70,11 +70,11 @@ data class HomeServerConnectionConfig(
             if (hsUri.scheme != "http" && hsUri.scheme != "https") {
                 throw RuntimeException("Invalid home server URI: " + hsUri)
             }
-            // remove trailing /
-            homeServerUri = if (hsUri.toString().endsWith("/")) {
+            // ensure trailing /
+            homeServerUri = if (!hsUri.toString().endsWith("/")) {
                 try {
                     val url = hsUri.toString()
-                    Uri.parse(url.substring(0, url.length - 1))
+                    Uri.parse("$url/")
                 } catch (e: Exception) {
                     throw RuntimeException("Invalid home server URI: $hsUri")
                 }
@@ -96,11 +96,11 @@ data class HomeServerConnectionConfig(
             if (identityServerUri.scheme != "http" && identityServerUri.scheme != "https") {
                 throw RuntimeException("Invalid identity server URI: $identityServerUri")
             }
-            // remove trailing /
-            if (identityServerUri.toString().endsWith("/")) {
+            // ensure trailing /
+            if (!identityServerUri.toString().endsWith("/")) {
                 try {
                     val url = identityServerUri.toString()
-                    this.identityServerUri = Uri.parse(url.substring(0, url.length - 1))
+                    this.identityServerUri = Uri.parse("$url/")
                 } catch (e: Exception) {
                     throw RuntimeException("Invalid identity server URI: $identityServerUri")
                 }
@@ -253,13 +253,5 @@ data class HomeServerConnectionConfig(
                     forceUsageTlsVersions
             )
         }
-
     }
-
-
 }
-
-
-
-
-

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

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.auth.data
+
+import im.vector.matrix.android.internal.auth.data.LoginFlowResponse
+
+// Either a LoginFlowResponse, or an error if the homeserver is outdated
+sealed class LoginFlowResult {
+    data class Success(
+            val loginFlowResponse: LoginFlowResponse,
+            val isLoginAndRegistrationSupported: Boolean
+    ) : LoginFlowResult()
+
+    object OutdatedHomeserver : LoginFlowResult()
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/Versions.kt

@@ -0,0 +1,111 @@
+/*
+ * Copyright 2018 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.auth.data
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Model for https://matrix.org/docs/spec/client_server/latest#get-matrix-client-versions
+ *
+ * Ex:
+ * <pre>
+ *   {
+ *     "unstable_features": {
+ *       "m.lazy_load_members": true
+ *     },
+ *     "versions": [
+ *       "r0.0.1",
+ *       "r0.1.0",
+ *       "r0.2.0",
+ *       "r0.3.0"
+ *     ]
+ *   }
+ * </pre>
+ */
+@JsonClass(generateAdapter = true)
+data class Versions(
+        @Json(name = "versions")
+        val supportedVersions: List<String>? = null,
+
+        @Json(name = "unstable_features")
+        val unstableFeatures: Map<String, Boolean>? = null
+)
+
+// MatrixClientServerAPIVersion
+private const val r0_0_1 = "r0.0.1"
+private const val r0_1_0 = "r0.1.0"
+private const val r0_2_0 = "r0.2.0"
+private const val r0_3_0 = "r0.3.0"
+private const val r0_4_0 = "r0.4.0"
+private const val r0_5_0 = "r0.5.0"
+private const val r0_6_0 = "r0.6.0"
+
+// MatrixVersionsFeature
+private const val FEATURE_LAZY_LOAD_MEMBERS = "m.lazy_load_members"
+private const val FEATURE_REQUIRE_IDENTITY_SERVER = "m.require_identity_server"
+private const val FEATURE_ID_ACCESS_TOKEN = "m.id_access_token"
+private const val FEATURE_SEPARATE_ADD_AND_BIND = "m.separate_add_and_bind"
+
+/**
+ * Return true if the SDK supports this homeserver version
+ */
+fun Versions.isSupportedBySdk(): Boolean {
+    return supportLazyLoadMembers()
+}
+
+/**
+ * Return true if the SDK supports this homeserver version for login and registration
+ */
+fun Versions.isLoginAndRegistrationSupportedBySdk(): Boolean {
+    return !doesServerRequireIdentityServerParam()
+            && doesServerAcceptIdentityAccessToken()
+            && doesServerSeparatesAddAndBind()
+}
+
+/**
+ * Return true if the server support the lazy loading of room members
+ *
+ * @return true if the server support the lazy loading of room members
+ */
+private fun Versions.supportLazyLoadMembers(): Boolean {
+    return supportedVersions?.contains(r0_5_0) == true
+            || unstableFeatures?.get(FEATURE_LAZY_LOAD_MEMBERS) == true
+}
+
+/**
+ * Indicate if the `id_server` parameter is required when registering with an 3pid,
+ * adding a 3pid or resetting password.
+ */
+private fun Versions.doesServerRequireIdentityServerParam(): Boolean {
+    if (supportedVersions?.contains(r0_6_0) == true) return false
+    return unstableFeatures?.get(FEATURE_REQUIRE_IDENTITY_SERVER) ?: true
+}
+
+/**
+ * Indicate if the `id_access_token` parameter can be safely passed to the homeserver.
+ * Some homeservers may trigger errors if they are not prepared for the new parameter.
+ */
+private fun Versions.doesServerAcceptIdentityAccessToken(): Boolean {
+    return supportedVersions?.contains(r0_6_0) == true
+            || unstableFeatures?.get(FEATURE_ID_ACCESS_TOKEN) ?: false
+}
+
+private fun Versions.doesServerSeparatesAddAndBind(): Boolean {
+    return supportedVersions?.contains(r0_6_0) == true
+            || unstableFeatures?.get(FEATURE_SEPARATE_ADD_AND_BIND) ?: false
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/WellKnown.kt

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.auth.data
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * https://matrix.org/docs/spec/client_server/r0.4.0.html#server-discovery
+ * <pre>
+ * {
+ *     "m.homeserver": {
+ *         "base_url": "https://matrix.org"
+ *     },
+ *     "m.identity_server": {
+ *         "base_url": "https://vector.im"
+ *     }
+ *     "m.integrations": {
+ *          "managers": [
+ *              {
+ *                  "api_url": "https://integrations.example.org",
+ *                  "ui_url": "https://integrations.example.org/ui"
+ *              },
+ *              {
+ *                  "api_url": "https://bots.example.org"
+ *              }
+ *          ]
+ *    }
+ * }
+ * </pre>
+ */
+@JsonClass(generateAdapter = true)
+data class WellKnown(
+        @Json(name = "m.homeserver")
+        var homeServer: WellKnownBaseConfig? = null,
+
+        @Json(name = "m.identity_server")
+        var identityServer: WellKnownBaseConfig? = null,
+
+        @Json(name = "m.integrations")
+        var integrations: Map<String, @JvmSuppressWildcards Any>? = null
+) {
+    /**
+     * Returns the list of integration managers proposed
+     */
+    fun getIntegrationManagers(): List<WellKnownManagerConfig> {
+        val managers = ArrayList<WellKnownManagerConfig>()
+        integrations?.get("managers")?.let {
+            (it as? ArrayList<*>)?.let { configs ->
+                configs.forEach { config ->
+                    (config as? Map<*, *>)?.let { map ->
+                        val apiUrl = map["api_url"] as? String
+                        val uiUrl = map["ui_url"] as? String ?: apiUrl
+                        if (apiUrl != null
+                                && apiUrl.startsWith("https://")
+                                && uiUrl!!.startsWith("https://")) {
+                            managers.add(WellKnownManagerConfig(
+                                    apiUrl = apiUrl,
+                                    uiUrl = uiUrl
+                            ))
+                        }
+                    }
+                }
+            }
+        }
+        return managers
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/WellKnownBaseConfig.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.auth.data
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * https://matrix.org/docs/spec/client_server/r0.4.0.html#server-discovery
+ * <pre>
+ * {
+ *     "base_url": "https://vector.im"
+ * }
+ * </pre>
+ */
+@JsonClass(generateAdapter = true)
+data class WellKnownBaseConfig(
+        @Json(name = "base_url")
+        val baseURL: String? = null
+)

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/data/WellKnownManagerConfig.kt

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.auth.data
+
+data class WellKnownManagerConfig(
+        val apiUrl : String,
+        val uiUrl: String
+)

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/login/LoginWizard.kt

@@ -14,40 +14,35 @@
  * limitations under the License.
  */
 
-package im.vector.matrix.android.api.auth
+package im.vector.matrix.android.api.auth.login
 
 import im.vector.matrix.android.api.MatrixCallback
-import im.vector.matrix.android.api.auth.data.HomeServerConnectionConfig
 import im.vector.matrix.android.api.session.Session
 import im.vector.matrix.android.api.util.Cancelable
 
-/**
- * This interface defines methods to authenticate to a matrix server.
- */
-interface Authenticator {
+interface LoginWizard {
 
     /**
-     * @param homeServerConnectionConfig this param is used to configure the Homeserver
      * @param login the login field
      * @param password the password field
+     * @param deviceName the initial device name
      * @param callback  the matrix callback on which you'll receive the result of authentication.
      * @return return a [Cancelable]
      */
-    fun authenticate(homeServerConnectionConfig: HomeServerConnectionConfig, login: String, password: String, callback: MatrixCallback<Session>): Cancelable
+    fun login(login: String,
+              password: String,
+              deviceName: String,
+              callback: MatrixCallback<Session>): Cancelable
 
-    //TODO remove this method. Shouldn't be managed like that.
     /**
-     * Check if there is an active [Session].
-     * @return true if there is at least one active session.
+     * Reset user password
      */
-    fun hasActiveSessions(): Boolean
+    fun resetPassword(email: String,
+                      newPassword: String,
+                      callback: MatrixCallback<Unit>): Cancelable
 
-    //TODO remove this method. Shouldn't be managed like that.
     /**
-     * Get the last active [Session], if there is an active session.
-     * @return the lastActive session if any, or null
+     * Confirm the new password, once the user has checked his email
      */
-    fun getLastActiveSession(): Session?
-
-
-}
+    fun resetPasswordMailConfirmed(callback: MatrixCallback<Unit>): Cancelable
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/registration/RegisterThreePid.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.auth.registration
+
+sealed class RegisterThreePid {
+    data class Email(val email: String) : RegisterThreePid()
+    data class Msisdn(val msisdn: String, val countryCode: String) : RegisterThreePid()
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/registration/RegistrationResult.kt

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.auth.registration
+
+import im.vector.matrix.android.api.session.Session
+
+// Either a session or an object containing data about registration stages
+sealed class RegistrationResult {
+    data class Success(val session: Session) : RegistrationResult()
+    data class FlowResponse(val flowResult: FlowResult) : RegistrationResult()
+}
+
+data class FlowResult(
+        val missingStages: List<Stage>,
+        val completedStages: List<Stage>
+)

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/registration/RegistrationWizard.kt

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.auth.registration
+
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.util.Cancelable
+
+interface RegistrationWizard {
+
+    fun getRegistrationFlow(callback: MatrixCallback<RegistrationResult>): Cancelable
+
+    fun createAccount(userName: String, password: String, initialDeviceDisplayName: String?, callback: MatrixCallback<RegistrationResult>): Cancelable
+
+    fun performReCaptcha(response: String, callback: MatrixCallback<RegistrationResult>): Cancelable
+
+    fun acceptTerms(callback: MatrixCallback<RegistrationResult>): Cancelable
+
+    fun dummy(callback: MatrixCallback<RegistrationResult>): Cancelable
+
+    fun addThreePid(threePid: RegisterThreePid, callback: MatrixCallback<RegistrationResult>): Cancelable
+
+    fun sendAgainThreePid(callback: MatrixCallback<RegistrationResult>): Cancelable
+
+    fun handleValidateThreePid(code: String, callback: MatrixCallback<RegistrationResult>): Cancelable
+
+    fun checkIfEmailHasBeenValidated(delayMillis: Long, callback: MatrixCallback<RegistrationResult>): Cancelable
+
+    val currentThreePid: String?
+
+    // True when login and password has been sent with success to the homeserver
+    val isRegistrationStarted: Boolean
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/auth/registration/Stage.kt

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.auth.registration
+
+sealed class Stage(open val mandatory: Boolean) {
+
+    // m.login.recaptcha
+    data class ReCaptcha(override val mandatory: Boolean, val publicKey: String) : Stage(mandatory)
+
+    // m.login.oauth2
+    // m.login.email.identity
+    data class Email(override val mandatory: Boolean) : Stage(mandatory)
+
+    // m.login.msisdn
+    data class Msisdn(override val mandatory: Boolean) : Stage(mandatory)
+
+    // m.login.token
+
+    // m.login.dummy, can be mandatory if there is no other stages. In this case the account cannot be created by just sending a username
+    // and a password, the dummy stage has to be done
+    data class Dummy(override val mandatory: Boolean) : Stage(mandatory)
+
+    // Undocumented yet: m.login.terms
+    data class Terms(override val mandatory: Boolean, val policies: TermPolicies) : Stage(mandatory)
+
+    // For unknown stages
+    data class Other(override val mandatory: Boolean, val type: String, val params: Map<*, *>?) : Stage(mandatory)
+}
+
+typealias TermPolicies = Map<*, *>

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/comparators/DatedObjectComparators.kt

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.comparators
+
+import im.vector.matrix.android.api.interfaces.DatedObject
+
+object DatedObjectComparators {
+
+    /**
+     * Comparator to sort DatedObjects from the oldest to the latest.
+     */
+    val ascComparator by lazy {
+        Comparator<DatedObject> { datedObject1, datedObject2 ->
+            (datedObject1.date - datedObject2.date).toInt()
+        }
+    }
+
+    /**
+     * Comparator to sort DatedObjects from the latest to the oldest.
+     */
+    val descComparator by lazy {
+        Comparator<DatedObject> { datedObject1, datedObject2 ->
+            (datedObject2.date - datedObject1.date).toInt()
+        }
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/crypto/Emojis.kt

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.crypto
+
+import im.vector.matrix.android.api.session.crypto.sas.EmojiRepresentation
+import im.vector.matrix.android.internal.crypto.verification.getEmojiForCode
+
+/**
+ * Provide all the emojis used for SAS verification (for debug purpose)
+ */
+fun getAllVerificationEmojis(): List<EmojiRepresentation> {
+    return (0..63).map { getEmojiForCode(it) }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/extensions/MatrixSdkExtensions.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2018 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.extensions
+
+import im.vector.matrix.android.api.comparators.DatedObjectComparators
+import im.vector.matrix.android.internal.crypto.model.MXDeviceInfo
+import im.vector.matrix.android.internal.crypto.model.rest.DeviceInfo
+
+/* ==========================================================================================
+ * MXDeviceInfo
+ * ========================================================================================== */
+
+fun MXDeviceInfo.getFingerprintHumanReadable() = fingerprint()
+        ?.chunked(4)
+        ?.joinToString(separator = " ")
+
+fun MutableList<DeviceInfo>.sortByLastSeen() {
+    sortWith(DatedObjectComparators.descComparator)
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/failure/ConsentNotGivenError.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.failure
+
+// This data class will be sent to the bus
+data class ConsentNotGivenError(
+        val consentUri: String
+)

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/failure/Failure.kt

@@ -16,6 +16,8 @@
 
 package im.vector.matrix.android.api.failure
 
+import im.vector.matrix.android.api.session.crypto.MXCryptoError
+import im.vector.matrix.android.internal.auth.registration.RegistrationFlowResponse
 import java.io.IOException
 
 /**
@@ -29,9 +31,16 @@ import java.io.IOException
  */
 sealed class Failure(cause: Throwable? = null) : Throwable(cause = cause) {
     data class Unknown(val throwable: Throwable? = null) : Failure(throwable)
+    data class Cancelled(val throwable: Throwable? = null) : Failure(throwable)
     data class NetworkConnection(val ioException: IOException? = null) : Failure(ioException)
-    data class ServerError(val error: MatrixError) : Failure(RuntimeException(error.toString()))
+    data class ServerError(val error: MatrixError, val httpCode: Int) : Failure(RuntimeException(error.toString()))
+    object SuccessError : Failure(RuntimeException(RuntimeException("SuccessResult is false")))
+    // When server send an error, but it cannot be interpreted as a MatrixError
+    data class OtherServerError(val errorBody: String, val httpCode: Int) : Failure(RuntimeException(errorBody))
+
+    data class RegistrationFlowError(val registrationFlowResponse: RegistrationFlowResponse) : Failure(RuntimeException(registrationFlowResponse.toString()))
+
+    data class CryptoError(val error: MXCryptoError) : Failure(error)
 
     abstract class FeatureFailure : Failure()
-
-}
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/failure/MatrixError.kt

@@ -26,8 +26,14 @@ import com.squareup.moshi.JsonClass
 @JsonClass(generateAdapter = true)
 data class MatrixError(
         @Json(name = "errcode") val code: String,
-        @Json(name = "error") val message: String
-) {
+        @Json(name = "error") val message: String,
+
+        @Json(name = "consent_uri") val consentUri: String? = null,
+        // RESOURCE_LIMIT_EXCEEDED data
+        @Json(name = "limit_type") val limitType: String? = null,
+        @Json(name = "admin_contact") val adminUri: String? = null,
+        // For LIMIT_EXCEEDED
+        @Json(name = "retry_after_ms") val retryAfterMillis: Long? = null) {
 
     companion object {
         const val FORBIDDEN = "M_FORBIDDEN"
@@ -54,5 +60,9 @@ data class MatrixError(
         const val TOO_LARGE = "M_TOO_LARGE"
         const val M_CONSENT_NOT_GIVEN = "M_CONSENT_NOT_GIVEN"
         const val RESOURCE_LIMIT_EXCEEDED = "M_RESOURCE_LIMIT_EXCEEDED"
+        const val WRONG_ROOM_KEYS_VERSION = "M_WRONG_ROOM_KEYS_VERSION"
+
+        // Possible value for "limit_type"
+        const val LIMIT_TYPE_MAU = "monthly_active_user"
     }
-}
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/interfaces/DatedObject.kt

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2018 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.interfaces
+
+/**
+ * Can be implemented by any object containing a timestamp.
+ * This interface can be use to sort such object
+ */
+interface DatedObject {
+    val date: Long
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/listeners/ProgressListener.kt

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.listeners
+
+/**
+ * Interface to send a progress info
+ */
+interface ProgressListener {
+    /**
+     * @param progress from 0 to total by contract
+     * @param total
+     */
+    fun onProgress(progress: Int, total: Int)
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/listeners/StepProgressListener.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.listeners
+
+/**
+ * Interface to send a progress info
+ */
+interface StepProgressListener {
+
+    sealed class Step {
+        data class ComputingKey(val progress: Int, val total: Int) : Step()
+        object DownloadingKey : Step()
+        data class ImportingKey(val progress: Int, val total: Int) : Step()
+    }
+
+    /**
+     * @param step The current step, containing progress data if available. Else you should consider progress as indeterminate
+     */
+    fun onStepProgress(step: Step)
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/MatrixLinkify.kt

@@ -17,9 +17,6 @@
 package im.vector.matrix.android.api.permalinks
 
 import android.text.Spannable
-import android.text.SpannableString
-import android.text.method.LinkMovementMethod
-import android.widget.TextView
 import im.vector.matrix.android.api.MatrixPatterns
 
 /**
@@ -33,22 +30,20 @@ object MatrixLinkify {
      *
      * @param spannable the text in which the matrix items has to be clickable.
      */
-    fun addLinks(spannable: Spannable?, callback: MatrixPermalinkSpan.Callback?): Boolean {
+    fun addLinks(spannable: Spannable, callback: MatrixPermalinkSpan.Callback?): Boolean {
         // sanity checks
-        if (spannable.isNullOrEmpty()) {
+        if (spannable.isEmpty()) {
             return false
         }
         val text = spannable.toString()
         var hasMatch = false
-        for (index in MatrixPatterns.MATRIX_PATTERNS.indices) {
-            val pattern = MatrixPatterns.MATRIX_PATTERNS[index]
-            val matcher = pattern.matcher(spannable)
-            while (matcher.find()) {
+        for (pattern in MatrixPatterns.MATRIX_PATTERNS) {
+            for (match in pattern.findAll(spannable)) {
                 hasMatch = true
-                val startPos = matcher.start(0)
+                val startPos = match.range.first
                 if (startPos == 0 || text[startPos - 1] != '/') {
-                    val endPos = matcher.end(0)
-                    val url = text.substring(matcher.start(0), matcher.end(0))
+                    val endPos = match.range.last + 1
+                    val url = text.substring(match.range)
                     val span = MatrixPermalinkSpan(url, callback)
                     spannable.setSpan(span, startPos, endPos, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE)
                 }
@@ -56,37 +51,4 @@ object MatrixLinkify {
         }
         return hasMatch
     }
-
-    fun addLinks(textView: TextView, callback: MatrixPermalinkSpan.Callback?): Boolean {
-        val text = textView.text
-        if (text is Spannable) {
-            if (addLinks(text, callback)) {
-                addLinkMovementMethod(textView)
-                return true
-            }
-
-            return false
-        } else {
-            val spannableString = SpannableString.valueOf(text)
-            if (addLinks(spannableString, callback)) {
-                addLinkMovementMethod(textView)
-                textView.text = spannableString
-                return true
-            }
-            return false
-        }
-    }
-
-    /**
-     * Add linkMovementMethod on textview if not already set
-     * @param textView the textView on which the movementMethod is set
-     */
-    fun addLinkMovementMethod(textView: TextView) {
-        val movementMethod = textView.movementMethod
-        if (movementMethod == null || movementMethod !is LinkMovementMethod) {
-            if (textView.linksClickable) {
-                textView.movementMethod = LinkMovementMethod.getInstance()
-            }
-        }
-    }
-}
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/MatrixPermalinkSpan.kt

@@ -18,6 +18,7 @@ package im.vector.matrix.android.api.permalinks
 
 import android.text.style.ClickableSpan
 import android.view.View
+import im.vector.matrix.android.api.permalinks.MatrixPermalinkSpan.Callback
 
 /**
  * This MatrixPermalinkSpan is a clickable span which use a [Callback] to communicate back.
@@ -34,6 +35,4 @@ class MatrixPermalinkSpan(private val url: String,
     override fun onClick(widget: View) {
         callback?.onUrlClicked(url)
     }
-
-
-}
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/PermalinkData.kt

@@ -33,5 +33,4 @@ sealed class PermalinkData {
     data class GroupLink(val groupId: String) : PermalinkData()
 
     data class FallbackLink(val uri: Uri) : PermalinkData()
-
 }

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/PermalinkFactory.kt

@@ -16,7 +16,6 @@
 
 package im.vector.matrix.android.api.permalinks
 
-import android.text.TextUtils
 import im.vector.matrix.android.api.session.events.model.Event
 
 /**
@@ -24,7 +23,7 @@ import im.vector.matrix.android.api.session.events.model.Event
  */
 object PermalinkFactory {
 
-    private val MATRIX_TO_URL_BASE = "https://matrix.to/#/"
+    const val MATRIX_TO_URL_BASE = "https://matrix.to/#/"
 
     /**
      * Creates a permalink for an event.
@@ -48,10 +47,9 @@ object PermalinkFactory {
      * @return the permalink, or null in case of error
      */
     fun createPermalink(id: String): String? {
-        return if (TextUtils.isEmpty(id)) {
+        return if (id.isEmpty()) {
             null
         } else MATRIX_TO_URL_BASE + escape(id)
-
     }
 
     /**
@@ -72,16 +70,14 @@ object PermalinkFactory {
      * @param url the universal link, Ex: "https://matrix.to/#/@benoit:matrix.org"
      * @return the id from the url, ex: "@benoit:matrix.org", or null if the url is not a permalink
      */
-    fun getLinkedId(url: String?): String? {
-        val isSupported = url != null && url.startsWith(MATRIX_TO_URL_BASE)
+    fun getLinkedId(url: String): String? {
+        val isSupported = url.startsWith(MATRIX_TO_URL_BASE)
 
         return if (isSupported) {
-            url!!.substring(MATRIX_TO_URL_BASE.length)
+            url.substring(MATRIX_TO_URL_BASE.length)
         } else null
-
     }
 
-
     /**
      * Escape '/' in id, because it is used as a separator
      *
@@ -89,6 +85,6 @@ object PermalinkFactory {
      * @return the escaped id
      */
     private fun escape(id: String): String {
-        return id.replace("/".toRegex(), "%2F")
+        return id.replace("/", "%2F")
     }
 }

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/permalinks/PermalinkParser.kt

@@ -36,12 +36,20 @@ object PermalinkParser {
      * Turns an uri to a [PermalinkData]
      */
     fun parse(uri: Uri): PermalinkData {
+        if (!uri.toString().startsWith(PermalinkFactory.MATRIX_TO_URL_BASE)) {
+            return PermalinkData.FallbackLink(uri)
+        }
+
         val fragment = uri.fragment
         if (fragment.isNullOrEmpty()) {
             return PermalinkData.FallbackLink(uri)
         }
+
+        val indexOfQuery = fragment.indexOf("?")
+        val safeFragment = if (indexOfQuery != -1) fragment.substring(0, indexOfQuery) else fragment
+
         // we are limiting to 2 params
-        val params = fragment
+        val params = safeFragment
                 .split(MatrixPatterns.SEP_REGEX.toRegex())
                 .filter { it.isNotEmpty() }
                 .take(2)
@@ -64,5 +72,4 @@ object PermalinkParser {
             else                                 -> PermalinkData.FallbackLink(uri)
         }
     }
-
-}
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/Action.kt

@@ -0,0 +1,128 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.pushrules
+
+import im.vector.matrix.android.api.pushrules.rest.PushRule
+import timber.log.Timber
+
+sealed class Action {
+    object Notify : Action()
+    object DoNotNotify : Action()
+    data class Sound(val sound: String = ACTION_OBJECT_VALUE_VALUE_DEFAULT) : Action()
+    data class Highlight(val highlight: Boolean) : Action()
+}
+
+private const val ACTION_NOTIFY = "notify"
+private const val ACTION_DONT_NOTIFY = "dont_notify"
+private const val ACTION_COALESCE = "coalesce"
+
+// Ref: https://matrix.org/docs/spec/client_server/latest#tweaks
+private const val ACTION_OBJECT_SET_TWEAK_KEY = "set_tweak"
+
+private const val ACTION_OBJECT_SET_TWEAK_VALUE_SOUND = "sound"
+private const val ACTION_OBJECT_SET_TWEAK_VALUE_HIGHLIGHT = "highlight"
+
+private const val ACTION_OBJECT_VALUE_KEY = "value"
+private const val ACTION_OBJECT_VALUE_VALUE_DEFAULT = "default"
+
+/**
+ * Ref: https://matrix.org/docs/spec/client_server/latest#actions
+ *
+ * Convert
+ * <pre>
+ * "actions": [
+ *     "notify",
+ *     {
+ *         "set_tweak": "sound",
+ *         "value": "default"
+ *     },
+ *     {
+ *         "set_tweak": "highlight"
+ *     }
+ *   ]
+ *
+ * To
+ * [
+ *     Action.Notify,
+ *     Action.Sound("default"),
+ *     Action.Highlight(true)
+ * ]
+ *
+ * </pre>
+ */
+
+@Suppress("IMPLICIT_CAST_TO_ANY")
+fun List<Action>.toJson(): List<Any> {
+    return map { action ->
+        when (action) {
+            is Action.Notify      -> ACTION_NOTIFY
+            is Action.DoNotNotify -> ACTION_DONT_NOTIFY
+            is Action.Sound       -> {
+                mapOf(
+                        ACTION_OBJECT_SET_TWEAK_KEY to ACTION_OBJECT_SET_TWEAK_VALUE_SOUND,
+                        ACTION_OBJECT_VALUE_KEY to action.sound
+                )
+            }
+            is Action.Highlight   -> {
+                mapOf(
+                        ACTION_OBJECT_SET_TWEAK_KEY to ACTION_OBJECT_SET_TWEAK_VALUE_HIGHLIGHT,
+                        ACTION_OBJECT_VALUE_KEY to action.highlight
+                )
+            }
+        }
+    }
+}
+
+fun PushRule.getActions(): List<Action> {
+    val result = ArrayList<Action>()
+
+    actions.forEach { actionStrOrObj ->
+        when (actionStrOrObj) {
+            ACTION_NOTIFY      -> Action.Notify
+            ACTION_DONT_NOTIFY -> Action.DoNotNotify
+            is Map<*, *>       -> {
+                when (actionStrOrObj[ACTION_OBJECT_SET_TWEAK_KEY]) {
+                    ACTION_OBJECT_SET_TWEAK_VALUE_SOUND     -> {
+                        (actionStrOrObj[ACTION_OBJECT_VALUE_KEY] as? String)?.let { stringValue ->
+                            Action.Sound(stringValue)
+                        }
+                        // When the value is not there, default sound (not specified by the spec)
+                                ?: Action.Sound(ACTION_OBJECT_VALUE_VALUE_DEFAULT)
+                    }
+                    ACTION_OBJECT_SET_TWEAK_VALUE_HIGHLIGHT -> {
+                        (actionStrOrObj[ACTION_OBJECT_VALUE_KEY] as? Boolean)?.let { boolValue ->
+                            Action.Highlight(boolValue)
+                        }
+                        // When the value is not there, default is true, says the spec
+                                ?: Action.Highlight(true)
+                    }
+                    else                                    -> {
+                        Timber.w("Unsupported set_tweak value ${actionStrOrObj[ACTION_OBJECT_SET_TWEAK_KEY]}")
+                        null
+                    }
+                }
+            }
+            else               -> {
+                Timber.w("Unsupported action type $actionStrOrObj")
+                null
+            }
+        }?.let {
+            result.add(it)
+        }
+    }
+
+    return result
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/Condition.kt

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.pushrules
+
+abstract class Condition(val kind: Kind) {
+
+    enum class Kind(val value: String) {
+        event_match("event_match"),
+        contains_display_name("contains_display_name"),
+        room_member_count("room_member_count"),
+        sender_notification_permission("sender_notification_permission"),
+        UNRECOGNIZE("");
+
+        companion object {
+
+            fun fromString(value: String): Kind {
+                return when (value) {
+                    "event_match"                    -> event_match
+                    "contains_display_name"          -> contains_display_name
+                    "room_member_count"              -> room_member_count
+                    "sender_notification_permission" -> sender_notification_permission
+                    else                             -> UNRECOGNIZE
+                }
+            }
+        }
+    }
+
+    abstract fun isSatisfied(conditionResolver: ConditionResolver): Boolean
+
+    open fun technicalDescription(): String {
+        return "Kind: $kind"
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/ConditionResolver.kt

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.pushrules
+
+/**
+ * Acts like a visitor on Conditions.
+ * This class as all required context needed to evaluate rules
+ */
+interface ConditionResolver {
+
+    fun resolveEventMatchCondition(eventMatchCondition: EventMatchCondition): Boolean
+    fun resolveRoomMemberCountCondition(roomMemberCountCondition: RoomMemberCountCondition): Boolean
+    fun resolveSenderNotificationPermissionCondition(senderNotificationPermissionCondition: SenderNotificationPermissionCondition): Boolean
+    fun resolveContainsDisplayNameCondition(containsDisplayNameCondition: ContainsDisplayNameCondition) : Boolean
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/ContainsDisplayNameCondition.kt

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.pushrules
+
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.api.session.events.model.EventType
+import im.vector.matrix.android.api.session.events.model.toModel
+import im.vector.matrix.android.api.session.room.model.message.MessageContent
+import timber.log.Timber
+
+class ContainsDisplayNameCondition : Condition(Kind.contains_display_name) {
+
+    override fun isSatisfied(conditionResolver: ConditionResolver): Boolean {
+        return conditionResolver.resolveContainsDisplayNameCondition(this)
+    }
+
+    override fun technicalDescription(): String {
+        return "User is mentioned"
+    }
+
+    fun isSatisfied(event: Event, displayName: String): Boolean {
+        val message = when (event.type) {
+            EventType.MESSAGE -> {
+                event.content.toModel<MessageContent>()
+            }
+            // TODO the spec says:
+            // Matches any message whose content is unencrypted and contains the user's current display name
+            // EventType.ENCRYPTED -> {
+            //     event.root.getClearContent()?.toModel<MessageContent>()
+            // }
+            else              -> null
+        } ?: return false
+
+        return caseInsensitiveFind(displayName, message.body)
+    }
+
+    companion object {
+        /**
+         * Returns whether a string contains an occurrence of another, as a standalone word, regardless of case.
+         *
+         * @param subString  the string to search for
+         * @param longString the string to search in
+         * @return whether a match was found
+         */
+        fun caseInsensitiveFind(subString: String, longString: String): Boolean {
+            // add sanity checks
+            if (subString.isEmpty() || longString.isEmpty()) {
+                return false
+            }
+
+            try {
+                val regex = Regex("(\\W|^)" + Regex.escape(subString) + "(\\W|$)", RegexOption.IGNORE_CASE)
+                return regex.containsMatchIn(longString)
+            } catch (e: Exception) {
+                Timber.e(e, "## caseInsensitiveFind() : failed")
+            }
+
+            return false
+        }
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/EventMatchCondition.kt

@@ -0,0 +1,94 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.pushrules
+
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.internal.di.MoshiProvider
+import timber.log.Timber
+
+class EventMatchCondition(val key: String, val pattern: String) : Condition(Kind.event_match) {
+
+    override fun isSatisfied(conditionResolver: ConditionResolver) : Boolean {
+        return conditionResolver.resolveEventMatchCondition(this)
+    }
+
+    override fun technicalDescription(): String {
+        return "'$key' Matches '$pattern'"
+    }
+
+    fun isSatisfied(event: Event): Boolean {
+        // TODO encrypted events?
+        val rawJson = MoshiProvider.providesMoshi().adapter(Event::class.java).toJsonValue(event) as? Map<*, *>
+                ?: return false
+        val value = extractField(rawJson, key) ?: return false
+
+        // Patterns with no special glob characters should be treated as having asterisks prepended
+        // and appended when testing the condition.
+        try {
+            val modPattern = if (hasSpecialGlobChar(pattern)) simpleGlobToRegExp(pattern) else simpleGlobToRegExp("*$pattern*")
+            val regex = Regex(modPattern, RegexOption.DOT_MATCHES_ALL)
+            return regex.containsMatchIn(value)
+        } catch (e: Throwable) {
+            // e.g PatternSyntaxException
+            Timber.e(e, "Failed to evaluate push condition")
+            return false
+        }
+    }
+
+    private fun extractField(jsonObject: Map<*, *>, fieldPath: String): String? {
+        val fieldParts = fieldPath.split(".")
+        if (fieldParts.isEmpty()) return null
+
+        var jsonElement: Map<*, *> = jsonObject
+        fieldParts.forEachIndexed { index, pathSegment ->
+            if (index == fieldParts.lastIndex) {
+                return jsonElement[pathSegment]?.toString()
+            } else {
+                val sub = jsonElement[pathSegment] ?: return null
+                if (sub is Map<*, *>) {
+                    jsonElement = sub
+                } else {
+                    return null
+                }
+            }
+        }
+        return null
+    }
+
+    companion object {
+
+        private fun hasSpecialGlobChar(glob: String): Boolean {
+            return glob.contains("*") || glob.contains("?")
+        }
+
+        // Very simple glob to regexp converter
+        private fun simpleGlobToRegExp(glob: String): String {
+            var out = "" // "^"
+            for (i in 0 until glob.length) {
+                val c = glob[i]
+                when (c) {
+                    '*'  -> out += ".*"
+                    '?'  -> out += '.'.toString()
+                    '.'  -> out += "\\."
+                    '\\' -> out += "\\\\"
+                    else -> out += c
+                }
+            }
+            out += "" // '$'.toString()
+            return out
+        }
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/PushRuleService.kt

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.pushrules
+
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.pushrules.rest.PushRule
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.api.util.Cancelable
+
+interface PushRuleService {
+
+    /**
+     * Fetch the push rules from the server
+     */
+    fun fetchPushRules(scope: String = RuleScope.GLOBAL)
+
+    // TODO get push rule set
+    fun getPushRules(scope: String = RuleScope.GLOBAL): List<PushRule>
+
+    // TODO update rule
+
+    fun updatePushRuleEnableStatus(kind: RuleKind, pushRule: PushRule, enabled: Boolean, callback: MatrixCallback<Unit>): Cancelable
+
+    fun addPushRule(kind: RuleKind, pushRule: PushRule, callback: MatrixCallback<Unit>): Cancelable
+
+    fun removePushRule(kind: RuleKind, pushRule: PushRule, callback: MatrixCallback<Unit>): Cancelable
+
+    fun addPushRuleListener(listener: PushRuleListener)
+
+    fun removePushRuleListener(listener: PushRuleListener)
+
+//    fun fulfilledBingRule(event: Event, rules: List<PushRule>): PushRule?
+
+    interface PushRuleListener {
+        fun onMatchRule(event: Event, actions: List<Action>)
+        fun onRoomJoined(roomId: String)
+        fun onRoomLeft(roomId: String)
+        fun onEventRedacted(redactedEventId: String)
+        fun batchFinish()
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RoomMemberCountCondition.kt

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.pushrules
+
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.api.session.room.RoomService
+import timber.log.Timber
+
+private val regex = Regex("^(==|<=|>=|<|>)?(\\d*)$")
+
+class RoomMemberCountCondition(val iz: String) : Condition(Kind.room_member_count) {
+
+    override fun isSatisfied(conditionResolver: ConditionResolver): Boolean {
+        return conditionResolver.resolveRoomMemberCountCondition(this)
+    }
+
+    override fun technicalDescription(): String {
+        return "Room member count is $iz"
+    }
+
+    fun isSatisfied(event: Event, session: RoomService?): Boolean {
+        // sanity check^
+        val roomId = event.roomId ?: return false
+        val room = session?.getRoom(roomId) ?: return false
+
+        // Parse the is field into prefix and number the first time
+        val (prefix, count) = parseIsField() ?: return false
+
+        val numMembers = room.getNumberOfJoinedMembers()
+
+        return when (prefix) {
+            "<"  -> numMembers < count
+            ">"  -> numMembers > count
+            "<=" -> numMembers <= count
+            ">=" -> numMembers >= count
+            else -> numMembers == count
+        }
+    }
+
+    /**
+     * Parse the is field to extract meaningful information.
+     */
+    private fun parseIsField(): Pair<String?, Int>? {
+        try {
+            val match = regex.find(iz) ?: return null
+            val (prefix, count) = match.destructured
+            return prefix to count.toInt()
+        } catch (t: Throwable) {
+            Timber.d(t)
+        }
+        return null
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RuleIds.kt

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.pushrules
+
+/**
+ * Known rule ids
+ *
+ * Ref: https://matrix.org/docs/spec/client_server/latest#predefined-rules
+ */
+object RuleIds {
+    // Default Override Rules
+    const val RULE_ID_DISABLE_ALL = ".m.rule.master"
+    const val RULE_ID_SUPPRESS_BOTS_NOTIFICATIONS = ".m.rule.suppress_notices"
+    const val RULE_ID_INVITE_ME = ".m.rule.invite_for_me"
+    const val RULE_ID_PEOPLE_JOIN_LEAVE = ".m.rule.member_event"
+    const val RULE_ID_CONTAIN_DISPLAY_NAME = ".m.rule.contains_display_name"
+
+    const val RULE_ID_TOMBSTONE = ".m.rule.tombstone"
+    const val RULE_ID_ROOM_NOTIF = ".m.rule.roomnotif"
+
+    // Default Content Rules
+    const val RULE_ID_CONTAIN_USER_NAME = ".m.rule.contains_user_name"
+
+    // Default Underride Rules
+    const val RULE_ID_CALL = ".m.rule.call"
+    const val RULE_ID_ONE_TO_ONE_ENCRYPTED_ROOM = ".m.rule.encrypted_room_one_to_one"
+    const val RULE_ID_ONE_TO_ONE_ROOM = ".m.rule.room_one_to_one"
+    const val RULE_ID_ALL_OTHER_MESSAGES_ROOMS = ".m.rule.message"
+    const val RULE_ID_ENCRYPTED = ".m.rule.encrypted"
+
+    // Not documented
+    const val RULE_ID_FALLBACK = ".m.rule.fallback"
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RuleScope.kt

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.pushrules
+
+object RuleScope {
+    const val GLOBAL = "global"
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/RuleSetKey.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.pushrules
+
+/**
+ * Ref: https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-pushrules
+ */
+enum class RuleSetKey(val value: String) {
+    CONTENT("content"),
+    OVERRIDE("override"),
+    ROOM("room"),
+    SENDER("sender"),
+    UNDERRIDE("underride")
+}
+
+/**
+ * Ref: https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-pushrules-scope-kind-ruleid
+ */
+typealias RuleKind = RuleSetKey

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/SenderNotificationPermissionCondition.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.pushrules
+
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.api.session.room.model.PowerLevels
+
+class SenderNotificationPermissionCondition(val key: String) : Condition(Kind.sender_notification_permission) {
+
+    override fun isSatisfied(conditionResolver: ConditionResolver): Boolean {
+        return conditionResolver.resolveSenderNotificationPermissionCondition(this)
+    }
+
+    override fun technicalDescription(): String {
+        return "User power level <$key>"
+    }
+
+    fun isSatisfied(event: Event, powerLevels: PowerLevels): Boolean {
+        return event.senderId != null && powerLevels.getUserPowerLevel(event.senderId) >= powerLevels.notificationLevel(key)
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/GetPushRulesResponse.kt

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.pushrules.rest
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * All push rulesets for a user.
+ */
+@JsonClass(generateAdapter = true)
+data class GetPushRulesResponse(
+        /**
+         * Global rules, account level applying to all devices
+         */
+        @Json(name = "global")
+        val global: Ruleset,
+
+        /**
+         * Device specific rules, apply only to current device
+         */
+        @Json(name = "device")
+        val device: Ruleset? = null
+)

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/PushCondition.kt

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.pushrules.rest
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import im.vector.matrix.android.api.pushrules.*
+import timber.log.Timber
+
+@JsonClass(generateAdapter = true)
+data class PushCondition(
+        /**
+         * Required. The kind of condition to apply.
+         */
+        val kind: String,
+
+        /**
+         * Required for event_match conditions. The dot- separated field of the event to match.
+         */
+
+        val key: String? = null,
+        /**
+         *Required for event_match conditions.
+         */
+
+        val pattern: String? = null,
+        /**
+         * Required for room_member_count conditions.
+         * A decimal integer optionally prefixed by one of, ==, <, >, >= or <=.
+         * A prefix of < matches rooms where the member count is strictly less than the given number and so forth.
+         * If no prefix is present, this parameter defaults to ==.
+         */
+        @Json(name = "is") val iz: String? = null
+) {
+
+    fun asExecutableCondition(): Condition? {
+        return when (Condition.Kind.fromString(this.kind)) {
+            Condition.Kind.event_match                    -> {
+                if (this.key != null && this.pattern != null) {
+                    EventMatchCondition(key, pattern)
+                } else {
+                    Timber.e("Malformed Event match condition")
+                    null
+                }
+            }
+            Condition.Kind.contains_display_name          -> {
+                ContainsDisplayNameCondition()
+            }
+            Condition.Kind.room_member_count              -> {
+                if (this.iz.isNullOrBlank()) {
+                    Timber.e("Malformed ROOM_MEMBER_COUNT condition")
+                    null
+                } else {
+                    RoomMemberCountCondition(this.iz)
+                }
+            }
+            Condition.Kind.sender_notification_permission -> {
+                this.key?.let { SenderNotificationPermissionCondition(it) }
+            }
+            Condition.Kind.UNRECOGNIZE                    -> {
+                Timber.e("Unknown kind $kind")
+                null
+            }
+        }
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/PushRule.kt

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.pushrules.rest
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class PushRule(
+        /**
+         * Required. The actions to perform when this rule is matched.
+         */
+        val actions: List<Any>,
+        /**
+         * Required. Whether this is a default rule, or has been set explicitly.
+         */
+        val default: Boolean? = false,
+        /**
+         * Required. Whether the push rule is enabled or not.
+         */
+        val enabled: Boolean,
+        /**
+         * Required. The ID of this rule.
+         */
+        @Json(name = "rule_id") val ruleId: String,
+        /**
+         * The conditions that must hold true for an event in order for a rule to be applied to an event
+         */
+        val conditions: List<PushCondition>? = null,
+        /**
+         * The glob-style pattern to match against. Only applicable to content rules.
+         */
+        val pattern: String? = null
+)

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/pushrules/rest/Ruleset.kt

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.pushrules.rest
+
+import com.squareup.moshi.JsonClass
+
+@JsonClass(generateAdapter = true)
+data class Ruleset(
+        val content: List<PushRule>? = null,
+        val override: List<PushRule>? = null,
+        val room: List<PushRule>? = null,
+        val sender: List<PushRule>? = null,
+        val underride: List<PushRule>? = null
+)

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/InitialSyncProgressService.kt

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.session
+
+import androidx.annotation.StringRes
+import androidx.lifecycle.LiveData
+
+interface InitialSyncProgressService {
+
+    fun getInitialSyncProgressStatus() : LiveData<Status?>
+
+    data class Status(
+            @StringRes val statusText: Int,
+            val percentProgress: Int = 0
+    )
+}

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

@@ -17,15 +17,24 @@
 package im.vector.matrix.android.api.session
 
 import androidx.annotation.MainThread
+import androidx.lifecycle.LiveData
 import im.vector.matrix.android.api.auth.data.SessionParams
+import im.vector.matrix.android.api.failure.ConsentNotGivenError
+import im.vector.matrix.android.api.pushrules.PushRuleService
 import im.vector.matrix.android.api.session.cache.CacheService
 import im.vector.matrix.android.api.session.content.ContentUploadStateTracker
 import im.vector.matrix.android.api.session.content.ContentUrlResolver
 import im.vector.matrix.android.api.session.crypto.CryptoService
+import im.vector.matrix.android.api.session.file.FileService
 import im.vector.matrix.android.api.session.group.GroupService
+import im.vector.matrix.android.api.session.homeserver.HomeServerCapabilitiesService
+import im.vector.matrix.android.api.session.pushers.PushersService
+import im.vector.matrix.android.api.session.room.RoomDirectoryService
 import im.vector.matrix.android.api.session.room.RoomService
+import im.vector.matrix.android.api.session.securestorage.SecureStorageService
 import im.vector.matrix.android.api.session.signout.SignOutService
 import im.vector.matrix.android.api.session.sync.FilterService
+import im.vector.matrix.android.api.session.sync.SyncState
 import im.vector.matrix.android.api.session.user.UserService
 
 /**
@@ -34,40 +43,70 @@ import im.vector.matrix.android.api.session.user.UserService
  */
 interface Session :
         RoomService,
+        RoomDirectoryService,
         GroupService,
         UserService,
         CryptoService,
         CacheService,
         SignOutService,
-        FilterService {
+        FilterService,
+        FileService,
+        PushRuleService,
+        PushersService,
+        InitialSyncProgressService,
+        HomeServerCapabilitiesService,
+        SecureStorageService {
 
     /**
      * The params associated to the session
      */
     val sessionParams: SessionParams
 
+    /**
+     * Useful shortcut to get access to the userId
+     */
+    val myUserId: String
+        get() = sessionParams.credentials.userId
+
     /**
      * This method allow to open a session. It does start some service on the background.
      */
     @MainThread
     fun open()
 
+    /**
+     * Requires a one time background sync
+     */
+    fun requireBackgroundSync()
+
+    /**
+     * Launches infinite periodic background syncs
+     * THis does not work in doze mode :/
+     * If battery optimization is on it can work in app standby but that's all :/
+     */
+    fun startAutomaticBackgroundSync(repeatDelay: Long = 30_000L)
+
+    fun stopAnyBackgroundSync()
+
     /**
      * This method start the sync thread.
      */
-    @MainThread
-    fun startSync()
+    fun startSync(fromForeground: Boolean)
 
     /**
      * This method stop the sync thread.
      */
-    @MainThread
     fun stopSync()
 
+    /**
+     * This method allows to listen the sync state.
+     * @return a [LiveData] of [SyncState].
+     */
+    fun syncState(): LiveData<SyncState>
+
     /**
      * This method allow to close a session. It does stop some services.
      */
-    @MainThread
     fun close()
 
     /**
@@ -100,6 +139,10 @@ interface Session :
          * The access token is not valid anymore
          */
         fun onInvalidToken()
-    }
 
-}
+        /**
+         * A M_CONSENT_NOT_GIVEN error has been received from the homeserver
+         */
+        fun onConsentNotGivenError(consentNotGivenError: ConsentNotGivenError)
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/cache/CacheService.kt

@@ -19,7 +19,7 @@ package im.vector.matrix.android.api.session.cache
 import im.vector.matrix.android.api.MatrixCallback
 
 /**
- * This interface defines a method to sign out. It's implemented at the session level.
+ * This interface defines a method to clear the cache. It's implemented at the session level.
  */
 interface CacheService {
 
@@ -27,5 +27,4 @@ interface CacheService {
      * Clear the whole cached data, except credentials. Once done, the session is closed and has to be opened again
      */
     fun clearCache(callback: MatrixCallback<Unit>)
-
-}
+}

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

@@ -17,6 +17,7 @@
 package im.vector.matrix.android.api.session.content
 
 import android.os.Parcelable
+import androidx.exifinterface.media.ExifInterface
 import kotlinx.android.parcel.Parcelize
 
 @Parcelize
@@ -26,6 +27,7 @@ data class ContentAttachmentData(
         val date: Long = 0,
         val height: Long? = 0,
         val width: Long? = 0,
+        val exifOrientation: Int = ExifInterface.ORIENTATION_UNDEFINED,
         val name: String? = null,
         val path: String,
         val mimeType: String,
@@ -38,5 +40,4 @@ data class ContentAttachmentData(
         AUDIO,
         VIDEO
     }
-
-}
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/content/ContentUploadStateTracker.kt

@@ -22,22 +22,17 @@ interface ContentUploadStateTracker {
 
     fun untrack(key: String, updateListener: UpdateListener)
 
-    fun setFailure(key: String)
-
-    fun setSuccess(key: String)
-
-    fun setProgress(key: String, current: Long, total: Long)
-
     interface UpdateListener {
         fun onUpdate(state: State)
     }
 
     sealed class State {
         object Idle : State()
-        data class ProgressData(val current: Long, val total: Long) : State()
+        object EncryptingThumbnail : State()
+        data class UploadingThumbnail(val current: Long, val total: Long) : State()
+        object Encrypting : State()
+        data class Uploading(val current: Long, val total: Long) : State()
         object Success : State()
-        object Failure : State()
+        data class Failure(val throwable: Throwable) : State()
     }
-
-
-}
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/content/ContentUrlResolver.kt

@@ -44,4 +44,4 @@ interface ContentUrlResolver {
      * @return the URL to access the described resource, or null if the url is invalid.
      */
     fun resolveThumbnail(contentUrl: String?, width: Int, height: Int, method: ThumbnailMethod): String?
-}
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/CryptoService.kt

@@ -16,8 +16,100 @@
 
 package im.vector.matrix.android.api.session.crypto
 
+import android.content.Context
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.listeners.ProgressListener
+import im.vector.matrix.android.api.session.crypto.keysbackup.KeysBackupService
+import im.vector.matrix.android.api.session.crypto.keyshare.RoomKeysRequestListener
+import im.vector.matrix.android.api.session.crypto.sas.SasVerificationService
+import im.vector.matrix.android.api.session.events.model.Content
+import im.vector.matrix.android.api.session.events.model.Event
+import im.vector.matrix.android.internal.crypto.MXEventDecryptionResult
+import im.vector.matrix.android.internal.crypto.NewSessionListener
+import im.vector.matrix.android.internal.crypto.model.ImportRoomKeysResult
+import im.vector.matrix.android.internal.crypto.model.MXDeviceInfo
+import im.vector.matrix.android.internal.crypto.model.MXEncryptEventContentResult
+import im.vector.matrix.android.internal.crypto.model.MXUsersDevicesMap
+import im.vector.matrix.android.internal.crypto.model.rest.DevicesListResponse
+import im.vector.matrix.android.internal.crypto.model.rest.RoomKeyRequestBody
+
 interface CryptoService {
 
-    // Not supported for the moment
-    fun isCryptoEnabled() = false
-}
+    fun setDeviceName(deviceId: String, deviceName: String, callback: MatrixCallback<Unit>)
+
+    fun deleteDevice(deviceId: String, callback: MatrixCallback<Unit>)
+
+    fun deleteDeviceWithUserPassword(deviceId: String, authSession: String?, password: String, callback: MatrixCallback<Unit>)
+
+    fun getCryptoVersion(context: Context, longFormat: Boolean): String
+
+    fun isCryptoEnabled(): Boolean
+
+    fun getSasVerificationService(): SasVerificationService
+
+    fun getKeysBackupService(): KeysBackupService
+
+    fun isRoomBlacklistUnverifiedDevices(roomId: String?): Boolean
+
+    fun setWarnOnUnknownDevices(warn: Boolean)
+
+    fun setDeviceVerification(verificationStatus: Int, deviceId: String, userId: String)
+
+    fun getUserDevices(userId: String): MutableList<MXDeviceInfo>
+
+    fun setDevicesKnown(devices: List<MXDeviceInfo>, callback: MatrixCallback<Unit>?)
+
+    fun deviceWithIdentityKey(senderKey: String, algorithm: String): MXDeviceInfo?
+
+    fun getMyDevice(): MXDeviceInfo
+
+    fun getGlobalBlacklistUnverifiedDevices(): Boolean
+
+    fun setGlobalBlacklistUnverifiedDevices(block: Boolean)
+
+    fun setRoomUnBlacklistUnverifiedDevices(roomId: String)
+
+    fun getDeviceTrackingStatus(userId: String): Int
+
+    fun importRoomKeys(roomKeysAsArray: ByteArray, password: String, progressListener: ProgressListener?, callback: MatrixCallback<ImportRoomKeysResult>)
+
+    fun exportRoomKeys(password: String, callback: MatrixCallback<ByteArray>)
+
+    fun setRoomBlacklistUnverifiedDevices(roomId: String)
+
+    fun getDeviceInfo(userId: String, deviceId: String?): MXDeviceInfo?
+
+    fun reRequestRoomKeyForEvent(event: Event)
+
+    fun cancelRoomKeyRequest(requestBody: RoomKeyRequestBody)
+
+    fun addRoomKeysRequestListener(listener: RoomKeysRequestListener)
+
+    fun removeRoomKeysRequestListener(listener: RoomKeysRequestListener)
+
+    fun getDevicesList(callback: MatrixCallback<DevicesListResponse>)
+
+    fun inboundGroupSessionsCount(onlyBackedUp: Boolean): Int
+
+    fun isRoomEncrypted(roomId: String): Boolean
+
+    fun encryptEventContent(eventContent: Content,
+                            eventType: String,
+                            roomId: String,
+                            callback: MatrixCallback<MXEncryptEventContentResult>)
+
+    @Throws(MXCryptoError::class)
+    fun decryptEvent(event: Event, timeline: String): MXEventDecryptionResult
+
+    fun decryptEventAsync(event: Event, timeline: String, callback: MatrixCallback<MXEventDecryptionResult>)
+
+    fun getEncryptionAlgorithm(roomId: String): String?
+
+    fun shouldEncryptForInvitedMembers(roomId: String): Boolean
+
+    fun downloadKeys(userIds: List<String>, forceDownload: Boolean, callback: MatrixCallback<MXUsersDevicesMap<MXDeviceInfo>>)
+
+    fun addNewSessionListener(newSessionListener: NewSessionListener)
+
+    fun removeSessionListener(listener: NewSessionListener)
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/MXCryptoError.kt

@@ -0,0 +1,93 @@
+/*
+ * Copyright 2016 OpenMarket Ltd
+ * Copyright 2017 Vector Creations Ltd
+ * Copyright 2018 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.session.crypto
+
+import im.vector.matrix.android.internal.crypto.model.MXDeviceInfo
+import im.vector.matrix.android.internal.crypto.model.MXUsersDevicesMap
+import org.matrix.olm.OlmException
+
+/**
+ * Represents a crypto error response.
+ */
+sealed class MXCryptoError : Throwable() {
+
+    data class Base(val errorType: ErrorType,
+                    val technicalMessage: String,
+                    /**
+                     * Describe the error with more details
+                     */
+                    val detailedErrorDescription: String? = null) : MXCryptoError()
+
+    data class OlmError(val olmException: OlmException) : MXCryptoError()
+
+    data class UnknownDevice(val deviceList: MXUsersDevicesMap<MXDeviceInfo>) : MXCryptoError()
+
+    enum class ErrorType {
+        ENCRYPTING_NOT_ENABLED,
+        UNABLE_TO_ENCRYPT,
+        UNABLE_TO_DECRYPT,
+        UNKNOWN_INBOUND_SESSION_ID,
+        INBOUND_SESSION_MISMATCH_ROOM_ID,
+        MISSING_FIELDS,
+        BAD_EVENT_FORMAT,
+        MISSING_SENDER_KEY,
+        MISSING_CIPHER_TEXT,
+        BAD_DECRYPTED_FORMAT,
+        NOT_INCLUDE_IN_RECIPIENTS,
+        BAD_RECIPIENT,
+        BAD_RECIPIENT_KEY,
+        FORWARDED_MESSAGE,
+        BAD_ROOM,
+        BAD_ENCRYPTED_MESSAGE,
+        DUPLICATED_MESSAGE_INDEX,
+        MISSING_PROPERTY,
+        OLM,
+        UNKNOWN_DEVICES,
+        UNKNOWN_MESSAGE_INDEX
+    }
+
+    companion object {
+        /**
+         * Resource for technicalMessage
+         */
+        const val UNABLE_TO_ENCRYPT_REASON = "Unable to encrypt %s"
+        const val UNABLE_TO_DECRYPT_REASON = "Unable to decrypt %1\$s. Algorithm: %2\$s"
+        const val OLM_REASON = "OLM error: %1\$s"
+        const val DETAILED_OLM_REASON = "Unable to decrypt %1\$s. OLM error: %2\$s"
+        const val UNKNOWN_INBOUND_SESSION_ID_REASON = "Unknown inbound session id"
+        const val INBOUND_SESSION_MISMATCH_ROOM_ID_REASON = "Mismatched room_id for inbound group session (expected %1\$s, was %2\$s)"
+        const val MISSING_FIELDS_REASON = "Missing fields in input"
+        const val BAD_EVENT_FORMAT_TEXT_REASON = "Bad event format"
+        const val MISSING_SENDER_KEY_TEXT_REASON = "Missing senderKey"
+        const val MISSING_CIPHER_TEXT_REASON = "Missing ciphertext"
+        const val BAD_DECRYPTED_FORMAT_TEXT_REASON = "Bad decrypted event format"
+        const val NOT_INCLUDED_IN_RECIPIENT_REASON = "Not included in recipients"
+        const val BAD_RECIPIENT_REASON = "Message was intended for %1\$s"
+        const val BAD_RECIPIENT_KEY_REASON = "Message not intended for this device"
+        const val FORWARDED_MESSAGE_REASON = "Message forwarded from %1\$s"
+        const val BAD_ROOM_REASON = "Message intended for room %1\$s"
+        const val BAD_ENCRYPTED_MESSAGE_REASON = "Bad Encrypted Message"
+        const val DUPLICATE_MESSAGE_INDEX_REASON = "Duplicate message index, possible replay attack %1\$s"
+        const val ERROR_MISSING_PROPERTY_REASON = "No '%1\$s' property. Cannot prevent unknown-key attack"
+        const val UNKNOWN_DEVICES_REASON = "This room contains unknown devices which have not been verified.\n" +
+                "We strongly recommend you verify them before continuing."
+        const val NO_MORE_ALGORITHM_REASON = "Room was previously configured to use encryption, but is no longer." +
+                " Perhaps the homeserver is hiding the configuration event."
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keysbackup/KeysBackupService.kt

@@ -0,0 +1,213 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.session.crypto.keysbackup
+
+import im.vector.matrix.android.api.MatrixCallback
+import im.vector.matrix.android.api.listeners.ProgressListener
+import im.vector.matrix.android.api.listeners.StepProgressListener
+import im.vector.matrix.android.internal.crypto.keysbackup.model.KeysBackupVersionTrust
+import im.vector.matrix.android.internal.crypto.keysbackup.model.MegolmBackupCreationInfo
+import im.vector.matrix.android.internal.crypto.keysbackup.model.rest.KeysVersion
+import im.vector.matrix.android.internal.crypto.keysbackup.model.rest.KeysVersionResult
+import im.vector.matrix.android.internal.crypto.model.ImportRoomKeysResult
+
+interface KeysBackupService {
+    /**
+     * Retrieve the current version of the backup from the home server
+     *
+     * It can be different than keysBackupVersion.
+     * @param callback onSuccess(null) will be called if there is no backup on the server
+     */
+    fun getCurrentVersion(callback: MatrixCallback<KeysVersionResult?>)
+
+    /**
+     * Create a new keys backup version and enable it, using the information return from [prepareKeysBackupVersion].
+     *
+     * @param keysBackupCreationInfo the info object from [prepareKeysBackupVersion].
+     * @param callback               Asynchronous callback
+     */
+    fun createKeysBackupVersion(keysBackupCreationInfo: MegolmBackupCreationInfo,
+                                callback: MatrixCallback<KeysVersion>)
+
+    /**
+     * Facility method to get the total number of locally stored keys
+     */
+    fun getTotalNumbersOfKeys(): Int
+
+    /**
+     * Facility method to get the number of backed up keys
+     */
+    fun getTotalNumbersOfBackedUpKeys(): Int
+
+    /**
+     * Start to back up keys immediately.
+     *
+     * @param progressListener the callback to follow the progress
+     * @param callback the main callback
+     */
+    fun backupAllGroupSessions(progressListener: ProgressListener?,
+                               callback: MatrixCallback<Unit>?)
+
+    /**
+     * Check trust on a key backup version.
+     *
+     * @param keysBackupVersion the backup version to check.
+     * @param callback block called when the operations completes.
+     */
+    fun getKeysBackupTrust(keysBackupVersion: KeysVersionResult,
+                           callback: MatrixCallback<KeysBackupVersionTrust>)
+
+    /**
+     * Return the current progress of the backup
+     */
+    fun getBackupProgress(progressListener: ProgressListener)
+
+    /**
+     * Get information about a backup version defined on the homeserver.
+     *
+     * It can be different than keysBackupVersion.
+     * @param version the backup version
+     * @param callback
+     */
+    fun getVersion(version: String,
+                   callback: MatrixCallback<KeysVersionResult?>)
+
+    /**
+     * This method fetches the last backup version on the server, then compare to the currently backup version use.
+     * If versions are not the same, the current backup is deleted (on server or locally), then the backup may be started again, using the last version.
+     *
+     * @param callback true if backup is already using the last version, and false if it is not the case
+     */
+    fun forceUsingLastVersion(callback: MatrixCallback<Boolean>)
+
+    /**
+     * Check the server for an active key backup.
+     *
+     * If one is present and has a valid signature from one of the user's verified
+     * devices, start backing up to it.
+     */
+    fun checkAndStartKeysBackup()
+
+    fun addListener(listener: KeysBackupStateListener)
+
+    fun removeListener(listener: KeysBackupStateListener)
+
+    /**
+     * Set up the data required to create a new backup version.
+     * The backup version will not be created and enabled until [createKeysBackupVersion]
+     * is called.
+     * The returned [MegolmBackupCreationInfo] object has a `recoveryKey` member with
+     * the user-facing recovery key string.
+     *
+     * @param password an optional passphrase string that can be entered by the user
+     * when restoring the backup as an alternative to entering the recovery key.
+     * @param progressListener a progress listener, as generating private key from password may take a while
+     * @param callback Asynchronous callback
+     */
+    fun prepareKeysBackupVersion(password: String?,
+                                 progressListener: ProgressListener?,
+                                 callback: MatrixCallback<MegolmBackupCreationInfo>)
+
+    /**
+     * Delete a keys backup version. It will delete all backed up keys on the server, and the backup itself.
+     * If we are backing up to this version. Backup will be stopped.
+     *
+     * @param version  the backup version to delete.
+     * @param callback Asynchronous callback
+     */
+    fun deleteBackup(version: String,
+                     callback: MatrixCallback<Unit>?)
+
+    /**
+     * Ask if the backup on the server contains keys that we may do not have locally.
+     * This should be called when entering in the state READY_TO_BACKUP
+     */
+    fun canRestoreKeys(): Boolean
+
+    /**
+     * Set trust on a keys backup version.
+     * It adds (or removes) the signature of the current device to the authentication part of the keys backup version.
+     *
+     * @param keysBackupVersion the backup version to check.
+     * @param trust the trust to set to the keys backup.
+     * @param callback block called when the operations completes.
+     */
+    fun trustKeysBackupVersion(keysBackupVersion: KeysVersionResult,
+                               trust: Boolean,
+                               callback: MatrixCallback<Unit>)
+
+    /**
+     * Set trust on a keys backup version.
+     *
+     * @param keysBackupVersion the backup version to check.
+     * @param recoveryKey the recovery key to challenge with the key backup public key.
+     * @param callback block called when the operations completes.
+     */
+    fun trustKeysBackupVersionWithRecoveryKey(keysBackupVersion: KeysVersionResult,
+                                              recoveryKey: String,
+                                              callback: MatrixCallback<Unit>)
+
+    /**
+     * Set trust on a keys backup version.
+     *
+     * @param keysBackupVersion the backup version to check.
+     * @param password the pass phrase to challenge with the keyBackupVersion public key.
+     * @param callback block called when the operations completes.
+     */
+    fun trustKeysBackupVersionWithPassphrase(keysBackupVersion: KeysVersionResult,
+                                             password: String,
+                                             callback: MatrixCallback<Unit>)
+
+    /**
+     * Restore a backup with a recovery key from a given backup version stored on the homeserver.
+     *
+     * @param keysVersionResult    the backup version to restore from.
+     * @param recoveryKey          the recovery key to decrypt the retrieved backup.
+     * @param roomId               the id of the room to get backup data from.
+     * @param sessionId            the id of the session to restore.
+     * @param stepProgressListener the step progress listener
+     * @param callback             Callback. It provides the number of found keys and the number of successfully imported keys.
+     */
+    fun restoreKeysWithRecoveryKey(keysVersionResult: KeysVersionResult,
+                                   recoveryKey: String, roomId: String?,
+                                   sessionId: String?,
+                                   stepProgressListener: StepProgressListener?,
+                                   callback: MatrixCallback<ImportRoomKeysResult>)
+
+    /**
+     * Restore a backup with a password from a given backup version stored on the homeserver.
+     *
+     * @param keysBackupVersion the backup version to restore from.
+     * @param password the password to decrypt the retrieved backup.
+     * @param roomId the id of the room to get backup data from.
+     * @param sessionId the id of the session to restore.
+     * @param stepProgressListener the step progress listener
+     * @param callback Callback. It provides the number of found keys and the number of successfully imported keys.
+     */
+    fun restoreKeyBackupWithPassword(keysBackupVersion: KeysVersionResult,
+                                     password: String,
+                                     roomId: String?,
+                                     sessionId: String?,
+                                     stepProgressListener: StepProgressListener?,
+                                     callback: MatrixCallback<ImportRoomKeysResult>)
+
+    val keysBackupVersion: KeysVersionResult?
+    val currentBackupVersion: String?
+    val isEnabled: Boolean
+    val isStucked: Boolean
+    val state: KeysBackupState
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keysbackup/KeysBackupState.kt

@@ -0,0 +1,75 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.session.crypto.keysbackup
+
+/**
+ * E2e keys backup states.
+ *
+ * <pre>
+ *                               |
+ *                               V        deleteKeyBackupVersion (on current backup)
+ *  +---------------------->  UNKNOWN  <-------------
+ *  |                            |
+ *  |                            | checkAndStartKeysBackup (at startup or on new verified device or a new detected backup)
+ *  |                            V
+ *  |                     CHECKING BACKUP
+ *  |                            |
+ *  |    Network error           |
+ *  +<----------+----------------+-------> DISABLED <----------------------+
+ *  |           |                |            |                            |
+ *  |           |                |            | createKeysBackupVersion    |
+ *  |           V                |            V                            |
+ *  +<---  WRONG VERSION         |         ENABLING                        |
+ *      |       ^                |            |                            |
+ *      |       |                V       ok   |     error                  |
+ *      |       |     +------> READY <--------+----------------------------+
+ *      V       |     |          |
+ * NOT TRUSTED  |     |          | on new key
+ *              |     |          V
+ *              |     |     WILL BACK UP (waiting a random duration)
+ *              |     |          |
+ *              |     |          |
+ *              |     | ok       V
+ *              |     +----- BACKING UP
+ *              |                |
+ *              |      Error     |
+ *              +<---------------+
+ * </pre>
+ */
+enum class KeysBackupState {
+    // Need to check the current backup version on the homeserver
+    Unknown,
+    // Checking if backup is enabled on home server
+    CheckingBackUpOnHomeserver,
+    // Backup has been stopped because a new backup version has been detected on the homeserver
+    WrongBackUpVersion,
+    // Backup from this device is not enabled
+    Disabled,
+    // There is a backup available on the homeserver but it is not trusted.
+    // It is not trusted because the signature is invalid or the device that created it is not verified
+    // Use [KeysBackup.getKeysBackupTrust()] to get trust details.
+    // Consequently, the backup from this device is not enabled.
+    NotTrusted,
+    // Backup is being enabled: the backup version is being created on the homeserver
+    Enabling,
+    // Backup is enabled and ready to send backup to the homeserver
+    ReadyToBackUp,
+    // e2e keys are going to be sent to the homeserver
+    WillBackUp,
+    // e2e keys are being sent to the homeserver
+    BackingUp
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keysbackup/KeysBackupStateListener.kt

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.session.crypto.keysbackup
+
+interface KeysBackupStateListener {
+
+    /**
+     * The keys backup state has changed
+     * @param newState the new state
+     */
+    fun onStateChange(newState: KeysBackupState)
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/keyshare/RoomKeysRequestListener.kt

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2018 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.session.crypto.keyshare
+
+import im.vector.matrix.android.internal.crypto.IncomingRoomKeyRequest
+import im.vector.matrix.android.internal.crypto.IncomingRoomKeyRequestCancellation
+
+/**
+ * Room keys events listener
+ */
+interface RoomKeysRequestListener {
+    /**
+     * An room key request has been received.
+     *
+     * @param request the request
+     */
+    fun onRoomKeyRequest(request: IncomingRoomKeyRequest)
+
+    /**
+     * A room key request cancellation has been received.
+     *
+     * @param request the cancellation request
+     */
+    fun onRoomKeyRequestCancellation(request: IncomingRoomKeyRequestCancellation)
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/CancelCode.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package im.vector.matrix.android.api.session.crypto.sas
+
+enum class CancelCode(val value: String, val humanReadable: String) {
+    User("m.user", "the user cancelled the verification"),
+    Timeout("m.timeout", "the verification process timed out"),
+    UnknownTransaction("m.unknown_transaction", "the device does not know about that transaction"),
+    UnknownMethod("m.unknown_method", "the device can’t agree on a key agreement, hash, MAC, or SAS method"),
+    MismatchedCommitment("m.mismatched_commitment", "the hash commitment did not match"),
+    MismatchedSas("m.mismatched_sas", "the SAS did not match"),
+    UnexpectedMessage("m.unexpected_message", "the device received an unexpected message"),
+    InvalidMessage("m.invalid_message", "an invalid message was received"),
+    MismatchedKeys("m.key_mismatch", "Key mismatch"),
+    UserMismatchError("m.user_error", "User mismatch")
+}
+
+fun safeValueOf(code: String?): CancelCode {
+    return CancelCode.values().firstOrNull { code == it.value } ?: CancelCode.User
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/EmojiRepresentation.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.matrix.android.api.session.crypto.sas
+
+import androidx.annotation.StringRes
+
+data class EmojiRepresentation(val emoji: String,
+                               @StringRes val nameResId: Int)