feat: agreement urls (#174)

* feat: agreement urls * fix: tests * fix: according to comments * fix: data sell button text
openedx · Jan 4, 2024 · 591932d · 591932d
1 parent 3953d0d
commit 591932d
Show file tree

Hide file tree

Showing 18 changed files with 329 additions and 105 deletions.
diff --git a/app/src/main/java/org/openedx/app/AnalyticsManager.kt b/app/src/main/java/org/openedx/app/AnalyticsManager.kt
@@ -171,6 +171,14 @@ class AnalyticsManager(
         logEvent(Event.COOKIE_POLICY_CLICKED)
     }
 
+    override fun dataSellClickedEvent() {
+        logEvent(Event.DATE_SELL_CLICKED)
+    }
+
+    override fun faqClickedEvent() {
+        logEvent(Event.FAQ_CLICKED)
+    }
+
     override fun emailSupportClickedEvent() {
         logEvent(Event.EMAIL_SUPPORT_CLICKED)
     }
@@ -421,6 +429,8 @@ private enum class Event(val eventName: String) {
     PRIVACY_POLICY_CLICKED("Privacy_Policy_Clicked"),
     TERMS_OF_USE_CLICKED("Terms_Of_Use_Clicked"),
     COOKIE_POLICY_CLICKED("Cookie_Policy_Clicked"),
+    DATE_SELL_CLICKED("Data_Sell_Clicked"),
+    FAQ_CLICKED("FAQ_Clicked"),
     EMAIL_SUPPORT_CLICKED("Email_Support_Clicked"),
     COURSE_ENROLL_CLICKED("Course_Enroll_Clicked"),
     COURSE_ENROLL_SUCCESS("Course_Enroll_Success"),

diff --git a/app/src/main/java/org/openedx/app/di/AppModule.kt b/app/src/main/java/org/openedx/app/di/AppModule.kt
@@ -134,15 +134,7 @@ val appModule = module {
         DownloadWorkerController(get(), get(), get())
     }
 
-    single {
-        val config = get<Config>()
-        AppData(
-            BuildConfig.VERSION_NAME,
-            config.getFeedbackEmailAddress(),
-            config.getAgreementUrlsConfig().tosUrl,
-            config.getAgreementUrlsConfig().privacyPolicyUrl
-        )
-    }
+    single { AppData(versionName = BuildConfig.VERSION_NAME) }
     factory { (activity: AppCompatActivity) -> AppReviewManager(activity, get(), get()) }
 
     single { TranscriptManager(get()) }

diff --git a/core/src/main/java/org/openedx/core/config/AgreementUrlsConfig.kt b/core/src/main/java/org/openedx/core/config/AgreementUrlsConfig.kt
@@ -1,14 +1,57 @@
 package org.openedx.core.config
 
+import android.net.Uri
 import com.google.gson.annotations.SerializedName
+import org.openedx.core.domain.model.Agreement
+import org.openedx.core.domain.model.AgreementUrls
 
-data class AgreementUrlsConfig(
+internal data class AgreementUrlsConfig(
     @SerializedName("PRIVACY_POLICY_URL")
-    val privacyPolicyUrl: String = "",
-
+    private val privacyPolicyUrl: String = "",
+    @SerializedName("COOKIE_POLICY_URL")
+    private val cookiePolicyUrl: String = "",
+    @SerializedName("DATA_SELL_CONSENT_URL")
+    private val dataSellConsentUrl: String = "",
     @SerializedName("TOS_URL")
-    val tosUrl: String = "",
+    private val tosUrl: String = "",
+    @SerializedName("EULA_URL")
+    private val eulaUrl: String = "",
+    @SerializedName("SUPPORTED_LANGUAGES")
+    private val supportedLanguages: List<String> = emptyList(),
+) {
+    fun mapToDomain(): Agreement {
+        val defaultAgreementUrls = AgreementUrls(
+            privacyPolicyUrl = privacyPolicyUrl,
+            cookiePolicyUrl = cookiePolicyUrl,
+            dataSellConsentUrl = dataSellConsentUrl,
+            tosUrl = tosUrl,
+            eulaUrl = eulaUrl,
+            supportedLanguages = supportedLanguages,
+        )
+        val agreementUrls = if (supportedLanguages.isNotEmpty()) {
+            supportedLanguages.associateWith {
+                AgreementUrls(
+                    privacyPolicyUrl = privacyPolicyUrl.appendLocale(it),
+                    cookiePolicyUrl = cookiePolicyUrl.appendLocale(it),
+                    dataSellConsentUrl = dataSellConsentUrl.appendLocale(it),
+                    tosUrl = tosUrl.appendLocale(it),
+                    eulaUrl = eulaUrl.appendLocale(it),
+                    supportedLanguages = supportedLanguages,
+                )
+            }
+        } else {
+            mapOf()
+        }
+        return Agreement(agreementUrls, defaultAgreementUrls)
+    }
 
-    @SerializedName("CONTACT_US_URL")
-    val contactUsUrl: String = "",
-)
+    private fun String.appendLocale(locale: String): String {
+        if (this.isBlank()) return this
+        val uri = Uri.parse(this)
+        return Uri.Builder().scheme(uri.scheme)
+            .authority(uri.authority)
+            .appendPath(locale + uri.encodedPath)
+            .build()
+            .toString()
+    }
+}
diff --git a/core/src/main/java/org/openedx/core/config/Config.kt b/core/src/main/java/org/openedx/core/config/Config.kt
@@ -5,6 +5,7 @@ import com.google.gson.Gson
 import com.google.gson.JsonElement
 import com.google.gson.JsonObject
 import com.google.gson.JsonParser
+import org.openedx.core.domain.model.AgreementUrls
 import java.io.InputStreamReader
 
 class Config(context: Context) {
@@ -34,12 +35,18 @@ class Config(context: Context) {
         return getString(TOKEN_TYPE, "")
     }
 
+    fun getFaqUrl(): String {
+        return getString(FAQ_URL, "")
+    }
+
     fun getFeedbackEmailAddress(): String {
         return getString(FEEDBACK_EMAIL_ADDRESS, "")
     }
 
-    fun getAgreementUrlsConfig(): AgreementUrlsConfig {
-        return getObjectOrNewInstance(AGREEMENT_URLS, AgreementUrlsConfig::class.java)
+    fun getAgreement(locale: String): AgreementUrls {
+        val agreement =
+            getObjectOrNewInstance(AGREEMENT_URLS, AgreementUrlsConfig::class.java).mapToDomain()
+        return agreement.getAgreementForLocale(locale)
     }
 
     fun getFirebaseConfig(): FirebaseConfig {
@@ -126,6 +133,7 @@ class Config(context: Context) {
         private const val API_HOST_URL = "API_HOST_URL"
         private const val OAUTH_CLIENT_ID = "OAUTH_CLIENT_ID"
         private const val TOKEN_TYPE = "TOKEN_TYPE"
+        private const val FAQ_URL = "FAQ_URL"
         private const val FEEDBACK_EMAIL_ADDRESS = "FEEDBACK_EMAIL_ADDRESS"
         private const val AGREEMENT_URLS = "AGREEMENT_URLS"
         private const val WHATS_NEW_ENABLED = "WHATS_NEW_ENABLED"

diff --git a/core/src/main/java/org/openedx/core/domain/model/AgreementUrls.kt b/core/src/main/java/org/openedx/core/domain/model/AgreementUrls.kt
@@ -0,0 +1,25 @@
+package org.openedx.core.domain.model
+
+/**
+ * Data class with information about user agreements URLs
+ *
+ * @param agreementUrls Map with keys from SUPPORTED_LANGUAGES config
+ * @param defaultAgreementUrls AgreementUrls for default language ('en')
+ */
+internal data class Agreement(
+    private val agreementUrls: Map<String, AgreementUrls> = mapOf(),
+    private val defaultAgreementUrls: AgreementUrls
+) {
+    fun getAgreementForLocale(locale: String): AgreementUrls {
+        return agreementUrls.getOrDefault(locale, defaultAgreementUrls)
+    }
+}
+
+data class AgreementUrls(
+    val privacyPolicyUrl: String = "",
+    val cookiePolicyUrl: String = "",
+    val dataSellConsentUrl: String = "",
+    val tosUrl: String = "",
+    val eulaUrl: String = "",
+    val supportedLanguages: List<String> = emptyList(),
+)
diff --git a/core/src/main/java/org/openedx/core/presentation/global/AppData.kt b/core/src/main/java/org/openedx/core/presentation/global/AppData.kt
@@ -2,7 +2,4 @@ package org.openedx.core.presentation.global
 
 data class AppData(
     val versionName: String,
-    val feedbackEmailAddress: String,
-    val tosUrl: String,
-    val privacyPolicyUrl: String,
-)
+)
diff --git a/core/src/main/java/org/openedx/core/presentation/global/webview/WebContentFragment.kt b/core/src/main/java/org/openedx/core/presentation/global/webview/WebContentFragment.kt
@@ -3,15 +3,21 @@ package org.openedx.core.presentation.global.webview
 import android.os.Bundle
 import android.view.LayoutInflater
 import android.view.ViewGroup
+import android.webkit.CookieManager
 import androidx.compose.ui.platform.ComposeView
 import androidx.compose.ui.platform.ViewCompositionStrategy
 import androidx.core.os.bundleOf
 import androidx.fragment.app.Fragment
+import org.koin.android.ext.android.inject
+import org.openedx.core.config.Config
 import org.openedx.core.ui.WebContentScreen
 import org.openedx.core.ui.rememberWindowSize
 import org.openedx.core.ui.theme.OpenEdXTheme
 
 class WebContentFragment : Fragment() {
+
+    private val config: Config by inject()
+
     override fun onCreateView(
         inflater: LayoutInflater,
         container: ViewGroup?,
@@ -22,6 +28,7 @@ class WebContentFragment : Fragment() {
             OpenEdXTheme {
                 val windowSize = rememberWindowSize()
                 WebContentScreen(
+                    apiHostUrl = config.getApiHostURL(),
                     windowSize = windowSize,
                     title = requireArguments().getString(ARG_TITLE, ""),
                     contentUrl = requireArguments().getString(ARG_URL, ""),
@@ -32,6 +39,11 @@ class WebContentFragment : Fragment() {
         }
     }
 
+    override fun onDestroy() {
+        super.onDestroy()
+        CookieManager.getInstance().flush()
+    }
+
     companion object {
         private const val ARG_TITLE = "argTitle"
         private const val ARG_URL = "argUrl"

diff --git a/core/src/main/res/values/strings.xml b/core/src/main/res/values/strings.xml
@@ -8,6 +8,9 @@
     <string name="core_error_unknown_error">Something went wrong</string>
     <string name="core_error_try_again">Try again</string>
     <string name="core_privacy_policy">Privacy policy</string>
+    <string name="core_cookie_policy" translatable="false">Cookie policy</string>
+    <string name="core_data_sell" translatable="false">Do not sell my personal information</string>
+    <string name="core_faq" translatable="false">View FAQ</string>
     <string name="core_terms_of_use">Terms of use</string>
     <string name="core_profile">Profile</string>
     <string name="core_cancel">Cancel</string>

diff --git a/default_config/dev/config.yaml b/default_config/dev/config.yaml
@@ -2,12 +2,17 @@ API_HOST_URL: 'http://localhost:8000'
 APPLICATION_ID: 'org.openedx.app'
 ENVIRONMENT_DISPLAY_NAME: 'Localhost'
 FEEDBACK_EMAIL_ADDRESS: '[email protected]'
+FAQ_URL: ''
 OAUTH_CLIENT_ID: 'OAUTH_CLIENT_ID'
 
+# Keep empty to hide setting
 AGREEMENT_URLS:
-  PRIVACY_POLICY_URL: 'https://example.com/privacy'
-  TOS_URL: 'https://example.com/tos'
-  CONTACT_US_URL: 'https://example.com/contact'
+  PRIVACY_POLICY_URL: ''
+  COOKIE_POLICY_URL: ''
+  DATA_SELL_CONSENT_URL: ''
+  TOS_URL: ''
+  EULA_URL: ''
+  SUPPORTED_LANGUAGES: [ ] #en is defalut language
 
 DISCOVERY:
   TYPE: 'native'

diff --git a/default_config/prod/config.yaml b/default_config/prod/config.yaml
@@ -2,12 +2,17 @@ API_HOST_URL: 'http://localhost:8000'
 APPLICATION_ID: 'org.openedx.app'
 ENVIRONMENT_DISPLAY_NAME: 'Localhost'
 FEEDBACK_EMAIL_ADDRESS: '[email protected]'
+FAQ_URL: ''
 OAUTH_CLIENT_ID: 'OAUTH_CLIENT_ID'
 
+# Keep empty to hide setting
 AGREEMENT_URLS:
-  PRIVACY_POLICY_URL: 'https://example.com/privacy'
-  TOS_URL: 'https://example.com/tos'
-  CONTACT_US_URL: 'https://example.com/contact'
+  PRIVACY_POLICY_URL: ''
+  COOKIE_POLICY_URL: ''
+  DATA_SELL_CONSENT_URL: ''
+  TOS_URL: ''
+  EULA_URL: ''
+  SUPPORTED_LANGUAGES: [ ] #en is defalut language
 
 DISCOVERY:
   TYPE: 'native'

diff --git a/default_config/stage/config.yaml b/default_config/stage/config.yaml
@@ -2,12 +2,17 @@ API_HOST_URL: 'http://localhost:8000'
 APPLICATION_ID: 'org.openedx.app'
 ENVIRONMENT_DISPLAY_NAME: 'Localhost'
 FEEDBACK_EMAIL_ADDRESS: '[email protected]'
+FAQ_URL: ''
 OAUTH_CLIENT_ID: 'OAUTH_CLIENT_ID'
 
+# Keep empty to hide setting
 AGREEMENT_URLS:
-  PRIVACY_POLICY_URL: 'https://example.com/privacy'
-  TOS_URL: 'https://example.com/tos'
-  CONTACT_US_URL: 'https://example.com/contact'
+  PRIVACY_POLICY_URL: ''
+  COOKIE_POLICY_URL: ''
+  DATA_SELL_CONSENT_URL: ''
+  TOS_URL: ''
+  EULA_URL: ''
+  SUPPORTED_LANGUAGES: [ ] #en is defalut language
 
 DISCOVERY:
   TYPE: 'native'

diff --git a/profile/src/main/java/org/openedx/profile/domain/model/Configuration.kt b/profile/src/main/java/org/openedx/profile/domain/model/Configuration.kt
@@ -0,0 +1,16 @@
+package org.openedx.profile.domain.model
+
+import org.openedx.core.domain.model.AgreementUrls
+
+/**
+ * @param agreementUrls User agreement urls
+ * @param faqUrl FAQ url
+ * @param supportEmail Email address of support
+ * @param versionName Version of the application (1.0.0)
+ */
+data class Configuration(
+    val agreementUrls: AgreementUrls,
+    val faqUrl: String,
+    val supportEmail: String,
+    val versionName: String,
+)
diff --git a/profile/src/main/java/org/openedx/profile/presentation/ProfileAnalytics.kt b/profile/src/main/java/org/openedx/profile/presentation/ProfileAnalytics.kt
@@ -8,6 +8,8 @@ interface ProfileAnalytics {
     fun privacyPolicyClickedEvent()
     fun termsOfUseClickedEvent()
     fun cookiePolicyClickedEvent()
+    fun dataSellClickedEvent()
+    fun faqClickedEvent()
     fun emailSupportClickedEvent()
     fun logoutEvent(force: Boolean)
-}
+}
diff --git a/profile/src/main/java/org/openedx/profile/presentation/profile/ProfileFragment.kt b/profile/src/main/java/org/openedx/profile/presentation/profile/ProfileFragment.kt
@@ -68,6 +68,20 @@ class ProfileFragment : Fragment() {
                                 )
                             }
 
+                            ProfileViewAction.CookiePolicyClick -> {
+                                viewModel.cookiePolicyClicked(
+                                    requireParentFragment().parentFragmentManager
+                                )
+                            }
+
+                            ProfileViewAction.DataSellClick -> {
+                                viewModel.dataSellClicked(
+                                    requireParentFragment().parentFragmentManager
+                                )
+                            }
+
+                            ProfileViewAction.FaqClick -> viewModel.faqClicked()
+
                             ProfileViewAction.SupportClick -> {
                                 viewModel.emailSupportClicked(requireContext())
                             }

diff --git a/profile/src/main/java/org/openedx/profile/presentation/profile/ProfileUIState.kt b/profile/src/main/java/org/openedx/profile/presentation/profile/ProfileUIState.kt
@@ -1,15 +1,16 @@
 package org.openedx.profile.presentation.profile
 
 import org.openedx.profile.domain.model.Account
+import org.openedx.profile.domain.model.Configuration
 
 sealed class ProfileUIState {
     /**
      * @param account User account data
-     * @param versionName Version of the application (1.0.0)
+     * @param configuration Configuration data
      */
     data class Data(
         val account: Account,
-        val versionName: String,
+        val configuration: Configuration,
     ) : ProfileUIState()
 
     object Loading : ProfileUIState()