Merge pull request #4660 from vector-im/feature/bma/legals

Legals
element-hq · Dec 10, 2021 · 34898f1 · 34898f1
2 parents 8fefee9 + bf7907a
commit 34898f1
Show file tree

Hide file tree

Showing 31 changed files with 627 additions and 130 deletions.
diff --git a/changelog.d/4638.feature b/changelog.d/4638.feature
@@ -0,0 +1 @@
+Add a help section in the settings.
diff --git a/changelog.d/4660.feature b/changelog.d/4660.feature
@@ -0,0 +1 @@
+Create a legal screen in the setting to group all the different policies.
diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/terms/TermsService.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/terms/TermsService.kt
@@ -16,6 +16,8 @@
 
 package org.matrix.android.sdk.api.session.terms
 
+import org.matrix.android.sdk.internal.session.terms.TermsResponse
+
 interface TermsService {
     enum class ServiceType {
         IntegrationManager,
@@ -28,4 +30,10 @@ interface TermsService {
                              baseUrl: String,
                              agreedUrls: List<String>,
                              token: String?)
+
+    /**
+     * Get the homeserver terms, from the register API.
+     * Will be updated once https://github.com/matrix-org/matrix-doc/pull/3012 will be implemented.
+     */
+    suspend fun getHomeserverTerms(baseUrl: String): TermsResponse
 }
diff --git a/...ndroid/src/main/java/org/matrix/android/sdk/internal/session/terms/DefaultTermsService.kt b/...ndroid/src/main/java/org/matrix/android/sdk/internal/session/terms/DefaultTermsService.kt
@@ -18,10 +18,13 @@ package org.matrix.android.sdk.internal.session.terms
 
 import dagger.Lazy
 import okhttp3.OkHttpClient
+import org.matrix.android.sdk.api.auth.data.LoginFlowTypes
+import org.matrix.android.sdk.api.failure.toRegistrationFlowResponse
 import org.matrix.android.sdk.api.session.accountdata.UserAccountDataTypes
 import org.matrix.android.sdk.api.session.events.model.toModel
 import org.matrix.android.sdk.api.session.terms.GetTermsResponse
 import org.matrix.android.sdk.api.session.terms.TermsService
+import org.matrix.android.sdk.api.util.JsonDict
 import org.matrix.android.sdk.internal.di.UnauthenticatedWithCertificate
 import org.matrix.android.sdk.internal.network.NetworkConstants
 import org.matrix.android.sdk.internal.network.RetrofitFactory
@@ -55,6 +58,27 @@ internal class DefaultTermsService @Inject constructor(
         return GetTermsResponse(termsResponse, getAlreadyAcceptedTermUrlsFromAccountData())
     }
 
+    /**
+     * We use a trick here to get the homeserver T&C, we use the register API
+     */
+    override suspend fun getHomeserverTerms(baseUrl: String): TermsResponse {
+        return try {
+            executeRequest(null) {
+                termsAPI.register(baseUrl + NetworkConstants.URI_API_PREFIX_PATH_R0 + "register")
+            }
+            // Return empty result if it succeed, but it should never happen
+            TermsResponse()
+        } catch (throwable: Throwable) {
+            @Suppress("UNCHECKED_CAST")
+            TermsResponse(
+                    policies = (throwable.toRegistrationFlowResponse()
+                            ?.params
+                            ?.get(LoginFlowTypes.TERMS) as? JsonDict)
+                            ?.get("policies") as? JsonDict
+            )
+        }
+    }
+
     override suspend fun agreeToTerms(serviceType: TermsService.ServiceType,
                                       baseUrl: String,
                                       agreedUrls: List<String>,
@@ -91,7 +115,7 @@ internal class DefaultTermsService @Inject constructor(
     private fun buildUrl(baseUrl: String, serviceType: TermsService.ServiceType): String {
         val servicePath = when (serviceType) {
             TermsService.ServiceType.IntegrationManager -> NetworkConstants.URI_INTEGRATION_MANAGER_PATH
-            TermsService.ServiceType.IdentityService -> NetworkConstants.URI_IDENTITY_PATH_V2
+            TermsService.ServiceType.IdentityService    -> NetworkConstants.URI_IDENTITY_PATH_V2
         }
         return "${baseUrl.ensureTrailingSlash()}$servicePath"
     }

diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/terms/TermsAPI.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/terms/TermsAPI.kt
@@ -16,6 +16,8 @@
 
 package org.matrix.android.sdk.internal.session.terms
 
+import org.matrix.android.sdk.api.util.JsonDict
+import org.matrix.android.sdk.api.util.emptyJsonDict
 import org.matrix.android.sdk.internal.network.HttpHeaders
 import retrofit2.http.Body
 import retrofit2.http.GET
@@ -37,4 +39,12 @@ internal interface TermsAPI {
     suspend fun agreeToTerms(@Url url: String,
                              @Body params: AcceptTermsBody,
                              @Header(HttpHeaders.Authorization) token: String)
+
+    /**
+     * API to retrieve the terms for a homeserver. The API /terms does not exist yet, so retrieve the terms from the login flow.
+     * We do not care about the result (Credentials)
+     */
+    @POST
+    suspend fun register(@Url url: String,
+                         @Body body: JsonDict = emptyJsonDict)
 }
diff --git a/vector/src/main/java/im/vector/app/core/di/FragmentModule.kt b/vector/src/main/java/im/vector/app/core/di/FragmentModule.kt
@@ -133,6 +133,7 @@ import im.vector.app.features.settings.devtools.KeyRequestsFragment
 import im.vector.app.features.settings.devtools.OutgoingKeyRequestListFragment
 import im.vector.app.features.settings.homeserver.HomeserverSettingsFragment
 import im.vector.app.features.settings.ignored.VectorSettingsIgnoredUsersFragment
+import im.vector.app.features.settings.legals.LegalsFragment
 import im.vector.app.features.settings.locale.LocalePickerFragment
 import im.vector.app.features.settings.notifications.VectorSettingsAdvancedNotificationPreferenceFragment
 import im.vector.app.features.settings.notifications.VectorSettingsNotificationPreferenceFragment
@@ -699,6 +700,11 @@ interface FragmentModule {
     @FragmentKey(DiscoverySettingsFragment::class)
     fun bindDiscoverySettingsFragment(fragment: DiscoverySettingsFragment): Fragment
 
+    @Binds
+    @IntoMap
+    @FragmentKey(LegalsFragment::class)
+    fun bindLegalsFragment(fragment: LegalsFragment): Fragment
+
     @Binds
     @IntoMap
     @FragmentKey(ReviewTermsFragment::class)

diff --git a/vector/src/main/java/im/vector/app/core/di/MavericksViewModelModule.kt b/vector/src/main/java/im/vector/app/core/di/MavericksViewModelModule.kt
@@ -85,6 +85,7 @@ import im.vector.app.features.settings.devtools.KeyRequestListViewModel
 import im.vector.app.features.settings.devtools.KeyRequestViewModel
 import im.vector.app.features.settings.homeserver.HomeserverSettingsViewModel
 import im.vector.app.features.settings.ignored.IgnoredUsersViewModel
+import im.vector.app.features.settings.legals.LegalsViewModel
 import im.vector.app.features.settings.locale.LocalePickerViewModel
 import im.vector.app.features.settings.push.PushGatewaysViewModel
 import im.vector.app.features.settings.threepids.ThreePidsSettingsViewModel
@@ -504,6 +505,11 @@ interface MavericksViewModelModule {
     @MavericksViewModelKey(DiscoverySettingsViewModel::class)
     fun discoverySettingsViewModelFactory(factory: DiscoverySettingsViewModel.Factory): MavericksAssistedViewModelFactory<*, *>
 
+    @Binds
+    @IntoMap
+    @MavericksViewModelKey(LegalsViewModel::class)
+    fun legalsViewModelFactory(factory: LegalsViewModel.Factory): MavericksAssistedViewModelFactory<*, *>
+
     @Binds
     @IntoMap
     @MavericksViewModelKey(RoomDetailViewModel::class)

diff --git a/vector/src/main/java/im/vector/app/core/utils/Dialogs.kt b/vector/src/main/java/im/vector/app/core/utils/Dialogs.kt
@@ -23,7 +23,7 @@ import android.webkit.WebViewClient
 import android.widget.TextView
 import com.google.android.material.dialog.MaterialAlertDialogBuilder
 import im.vector.app.R
-import im.vector.app.features.discovery.IdentityServerWithTerms
+import im.vector.app.features.discovery.ServerAndPolicies
 import me.gujun.android.span.link
 import me.gujun.android.span.span
 
@@ -45,7 +45,7 @@ fun Context.displayInWebView(url: String) {
             .show()
 }
 
-fun Context.showIdentityServerConsentDialog(identityServerWithTerms: IdentityServerWithTerms?,
+fun Context.showIdentityServerConsentDialog(identityServerWithTerms: ServerAndPolicies?,
                                             consentCallBack: (() -> Unit)) {
     // Build the message
     val content = span {

diff --git a/vector/src/main/java/im/vector/app/features/contactsbook/ContactsBookViewEvents.kt b/vector/src/main/java/im/vector/app/features/contactsbook/ContactsBookViewEvents.kt
@@ -17,9 +17,9 @@
 package im.vector.app.features.contactsbook
 
 import im.vector.app.core.platform.VectorViewEvents
-import im.vector.app.features.discovery.IdentityServerWithTerms
+import im.vector.app.features.discovery.ServerAndPolicies
 
 sealed class ContactsBookViewEvents : VectorViewEvents {
     data class Failure(val throwable: Throwable) : ContactsBookViewEvents()
-    data class OnPoliciesRetrieved(val identityServerWithTerms: IdentityServerWithTerms?) : ContactsBookViewEvents()
+    data class OnPoliciesRetrieved(val identityServerWithTerms: ServerAndPolicies?) : ContactsBookViewEvents()
 }
diff --git a/vector/src/main/java/im/vector/app/features/discovery/DiscoveryPolicyItem.kt b/vector/src/main/java/im/vector/app/features/discovery/DiscoveryPolicyItem.kt
@@ -24,6 +24,7 @@ import im.vector.app.R
 import im.vector.app.core.epoxy.ClickListener
 import im.vector.app.core.epoxy.VectorEpoxyHolder
 import im.vector.app.core.epoxy.onClick
+import im.vector.app.core.extensions.setTextOrHide
 
 @EpoxyModelClass(layout = R.layout.item_discovery_policy)
 abstract class DiscoveryPolicyItem : EpoxyModelWithHolder<DiscoveryPolicyItem.Holder>() {
@@ -40,7 +41,7 @@ abstract class DiscoveryPolicyItem : EpoxyModelWithHolder<DiscoveryPolicyItem.Ho
     override fun bind(holder: Holder) {
         super.bind(holder)
         holder.title.text = name
-        holder.url.text = url
+        holder.url.setTextOrHide(url)
         holder.view.onClick(clickListener)
     }
 

diff --git a/vector/src/main/java/im/vector/app/features/discovery/DiscoverySettingsController.kt b/vector/src/main/java/im/vector/app/features/discovery/DiscoverySettingsController.kt
@@ -433,6 +433,6 @@ class DiscoverySettingsController @Inject constructor(
         fun onTapUpdateUserConsent(newValue: Boolean)
         fun onTapRetryToRetrieveBindings()
         fun onPolicyUrlsExpandedStateToggled(newExpandedState: Boolean)
-        fun onPolicyTapped(policy: IdentityServerPolicy)
+        fun onPolicyTapped(policy: ServerPolicy)
     }
 }
diff --git a/vector/src/main/java/im/vector/app/features/discovery/DiscoverySettingsFragment.kt b/vector/src/main/java/im/vector/app/features/discovery/DiscoverySettingsFragment.kt
@@ -167,10 +167,11 @@ class DiscoverySettingsFragment @Inject constructor(
             val pidList = state.emailList().orEmpty() + state.phoneNumbersList().orEmpty()
             val hasBoundIds = pidList.any { it.isShared() == SharedState.SHARED }
 
+            val serverUrl = state.identityServer()?.serverUrl.orEmpty()
             val message = if (hasBoundIds) {
-                getString(R.string.settings_discovery_disconnect_with_bound_pid, state.identityServer(), state.identityServer())
+                getString(R.string.settings_discovery_disconnect_with_bound_pid, serverUrl, serverUrl)
             } else {
-                getString(R.string.disconnect_identity_server_dialog_content, state.identityServer())
+                getString(R.string.disconnect_identity_server_dialog_content, serverUrl)
             }
 
             MaterialAlertDialogBuilder(requireActivity())
@@ -203,7 +204,7 @@ class DiscoverySettingsFragment @Inject constructor(
         viewModel.handle(DiscoverySettingsAction.SetPoliciesExpandState(expanded = newExpandedState))
     }
 
-    override fun onPolicyTapped(policy: IdentityServerPolicy) {
+    override fun onPolicyTapped(policy: ServerPolicy) {
         openUrlInChromeCustomTab(requireContext(), null, policy.url)
     }
 

diff --git a/vector/src/main/java/im/vector/app/features/discovery/DiscoverySettingsState.kt b/vector/src/main/java/im/vector/app/features/discovery/DiscoverySettingsState.kt
@@ -21,7 +21,7 @@ import com.airbnb.mvrx.MavericksState
 import com.airbnb.mvrx.Uninitialized
 
 data class DiscoverySettingsState(
-        val identityServer: Async<IdentityServerWithTerms?> = Uninitialized,
+        val identityServer: Async<ServerAndPolicies?> = Uninitialized,
         val emailList: Async<List<PidInfo>> = Uninitialized,
         val phoneNumbersList: Async<List<PidInfo>> = Uninitialized,
         // Can be true if terms are updated

diff --git a/vector/src/main/java/im/vector/app/features/discovery/DiscoverySettingsViewModel.kt b/vector/src/main/java/im/vector/app/features/discovery/DiscoverySettingsViewModel.kt
@@ -78,7 +78,7 @@ class DiscoverySettingsViewModel @AssistedInject constructor(
     init {
         setState {
             copy(
-                    identityServer = Success(identityService.getCurrentIdentityServerUrl()?.let { IdentityServerWithTerms(it, emptyList()) }),
+                    identityServer = Success(identityService.getCurrentIdentityServerUrl()?.let { ServerAndPolicies(it, emptyList()) }),
                     userConsent = identityService.getUserConsent()
             )
         }
@@ -151,7 +151,7 @@ class DiscoverySettingsViewModel @AssistedInject constructor(
                 val data = session.identityService().setNewIdentityServer(action.url)
                 setState {
                     copy(
-                            identityServer = Success(IdentityServerWithTerms(data, emptyList())),
+                            identityServer = Success(ServerAndPolicies(data, emptyList())),
                             userConsent = false
                     )
                 }
@@ -401,7 +401,7 @@ class DiscoverySettingsViewModel @AssistedInject constructor(
         }
     }
 
-    private suspend fun fetchIdentityServerWithTerms(): IdentityServerWithTerms? {
+    private suspend fun fetchIdentityServerWithTerms(): ServerAndPolicies? {
         return session.fetchIdentityServerWithTerms(stringProvider.getString(R.string.resources_language))
     }
 }
diff --git a/vector/src/main/java/im/vector/app/features/discovery/Extensions.kt b/vector/src/main/java/im/vector/app/features/discovery/Extensions.kt
@@ -19,22 +19,35 @@ package im.vector.app.features.discovery
 import im.vector.app.core.utils.ensureProtocol
 import org.matrix.android.sdk.api.session.Session
 import org.matrix.android.sdk.api.session.terms.TermsService
+import org.matrix.android.sdk.internal.session.terms.TermsResponse
 
-suspend fun Session.fetchIdentityServerWithTerms(userLanguage: String): IdentityServerWithTerms? {
-    val identityServerUrl = identityService().getCurrentIdentityServerUrl()
-    return identityServerUrl?.let {
-        val terms = getTerms(TermsService.ServiceType.IdentityService, identityServerUrl.ensureProtocol())
-                .serverResponse
-                .getLocalizedTerms(userLanguage)
-        val policyUrls = terms.mapNotNull {
-            val name = it.localizedName ?: it.policyName
-            val url = it.localizedUrl
-            if (name == null || url == null) {
-                null
-            } else {
-                IdentityServerPolicy(name = name, url = url)
+suspend fun Session.fetchIdentityServerWithTerms(userLanguage: String): ServerAndPolicies? {
+    return identityService().getCurrentIdentityServerUrl()
+            ?.let { identityServerUrl ->
+                val termsResponse = getTerms(TermsService.ServiceType.IdentityService, identityServerUrl.ensureProtocol())
+                        .serverResponse
+                buildServerAndPolicies(identityServerUrl, termsResponse, userLanguage)
             }
+}
+
+suspend fun Session.fetchHomeserverWithTerms(userLanguage: String): ServerAndPolicies {
+    val homeserverUrl = sessionParams.homeServerUrl
+    val terms = getHomeserverTerms(homeserverUrl.ensureProtocol())
+    return buildServerAndPolicies(homeserverUrl, terms, userLanguage)
+}
+
+private fun buildServerAndPolicies(serviceUrl: String,
+                                   termsResponse: TermsResponse,
+                                   userLanguage: String): ServerAndPolicies {
+    val terms = termsResponse.getLocalizedTerms(userLanguage)
+    val policyUrls = terms.mapNotNull {
+        val name = it.localizedName ?: it.policyName
+        val url = it.localizedUrl
+        if (name == null || url == null) {
+            null
+        } else {
+            ServerPolicy(name = name, url = url)
         }
-        IdentityServerWithTerms(identityServerUrl, policyUrls)
     }
+    return ServerAndPolicies(serviceUrl, policyUrls)
 }
diff --git a/...ures/discovery/IdentityServerWithTerms.kt → ...p/features/discovery/ServerAndPolicies.kt b/...ures/discovery/IdentityServerWithTerms.kt → ...p/features/discovery/ServerAndPolicies.kt
@@ -16,12 +16,12 @@
 
 package im.vector.app.features.discovery
 
-data class IdentityServerWithTerms(
+data class ServerAndPolicies(
         val serverUrl: String,
-        val policies: List<IdentityServerPolicy>
+        val policies: List<ServerPolicy>
 )
 
-data class IdentityServerPolicy(
+data class ServerPolicy(
         val name: String,
         val url: String
 )
diff --git a/vector/src/main/java/im/vector/app/features/settings/VectorPreferences.kt b/vector/src/main/java/im/vector/app/features/settings/VectorPreferences.kt
@@ -35,20 +35,16 @@ import javax.inject.Inject
 class VectorPreferences @Inject constructor(private val context: Context) {
 
     companion object {
+        const val SETTINGS_HELP_PREFERENCE_KEY = "SETTINGS_HELP_PREFERENCE_KEY"
         const val SETTINGS_CHANGE_PASSWORD_PREFERENCE_KEY = "SETTINGS_CHANGE_PASSWORD_PREFERENCE_KEY"
         const val SETTINGS_VERSION_PREFERENCE_KEY = "SETTINGS_VERSION_PREFERENCE_KEY"
         const val SETTINGS_SDK_VERSION_PREFERENCE_KEY = "SETTINGS_SDK_VERSION_PREFERENCE_KEY"
         const val SETTINGS_OLM_VERSION_PREFERENCE_KEY = "SETTINGS_OLM_VERSION_PREFERENCE_KEY"
         const val SETTINGS_LOGGED_IN_PREFERENCE_KEY = "SETTINGS_LOGGED_IN_PREFERENCE_KEY"
         const val SETTINGS_HOME_SERVER_PREFERENCE_KEY = "SETTINGS_HOME_SERVER_PREFERENCE_KEY"
         const val SETTINGS_IDENTITY_SERVER_PREFERENCE_KEY = "SETTINGS_IDENTITY_SERVER_PREFERENCE_KEY"
-        const val SETTINGS_APP_TERM_CONDITIONS_PREFERENCE_KEY = "SETTINGS_APP_TERM_CONDITIONS_PREFERENCE_KEY"
-        const val SETTINGS_PRIVACY_POLICY_PREFERENCE_KEY = "SETTINGS_PRIVACY_POLICY_PREFERENCE_KEY"
         const val SETTINGS_DISCOVERY_PREFERENCE_KEY = "SETTINGS_DISCOVERY_PREFERENCE_KEY"
 
-        const val SETTINGS_THIRD_PARTY_NOTICES_PREFERENCE_KEY = "SETTINGS_THIRD_PARTY_NOTICES_PREFERENCE_KEY"
-        const val SETTINGS_OTHER_THIRD_PARTY_NOTICES_PREFERENCE_KEY = "SETTINGS_OTHER_THIRD_PARTY_NOTICES_PREFERENCE_KEY"
-        const val SETTINGS_COPYRIGHT_PREFERENCE_KEY = "SETTINGS_COPYRIGHT_PREFERENCE_KEY"
         const val SETTINGS_CLEAR_CACHE_PREFERENCE_KEY = "SETTINGS_CLEAR_CACHE_PREFERENCE_KEY"
         const val SETTINGS_CLEAR_MEDIA_CACHE_PREFERENCE_KEY = "SETTINGS_CLEAR_MEDIA_CACHE_PREFERENCE_KEY"
         const val SETTINGS_USER_SETTINGS_PREFERENCE_KEY = "SETTINGS_USER_SETTINGS_PREFERENCE_KEY"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Create a legal screen in the setting to group all the different policies.