Fix #4002: Profiles cant have internationalised names

domain/src/main/java/org/oppia/android/domain/profile/ProfileManagementController.kt

@@ -26,6 +26,7 @@ import org.oppia.android.util.data.DataProviders.Companion.transform
 import org.oppia.android.util.data.DataProviders.Companion.transformAsync
 import org.oppia.android.util.locale.OppiaLocale
 import org.oppia.android.util.profile.DirectoryManagementUtil
+import org.oppia.android.util.profile.NameValidator
 import org.oppia.android.util.system.OppiaClock
 import java.io.File
 import java.io.FileOutputStream
@@ -68,7 +69,8 @@ class ProfileManagementController @Inject constructor(
   private val directoryManagementUtil: DirectoryManagementUtil,
   private val exceptionsController: ExceptionsController,
   private val oppiaClock: OppiaClock,
-  private val machineLocale: OppiaLocale.MachineLocale
+  private val machineLocale: OppiaLocale.MachineLocale,
+  private val nameValidator: NameValidator
 ) {
   private var currentProfileId: Int = -1
   private val profileDataStore =
@@ -197,7 +199,7 @@ class ProfileManagementController @Inject constructor(
     val deferred = profileDataStore.storeDataWithCustomChannelAsync(
       updateInMemoryCache = true
     ) {
-      if (!onlyLetters(name)) {
+      if (!nameValidator.isNameValid(name)) {
         return@storeDataWithCustomChannelAsync Pair(it, ProfileActionStatus.INVALID_PROFILE_NAME)
       }
       if (!isNameUnique(name, it)) {
@@ -309,7 +311,7 @@ class ProfileManagementController @Inject constructor(
     val deferred = profileDataStore.storeDataWithCustomChannelAsync(
       updateInMemoryCache = true
     ) {
-      if (!onlyLetters(newName)) {
+      if (!nameValidator.isNameValid(newName)) {
         return@storeDataWithCustomChannelAsync Pair(it, ProfileActionStatus.INVALID_PROFILE_NAME)
       }
       if (!isNameUnique(newName, it)) {
@@ -721,10 +723,6 @@ class ProfileManagementController @Inject constructor(
     return imageFile.absolutePath
   }
 
-  private fun onlyLetters(name: String): Boolean {
-    return name.matches(Regex("^[ A-Za-z]+\$"))
-  }
-
   private fun rotateAndCompressBitmap(uri: Uri, bitmap: Bitmap, cropSize: Int): Bitmap {
     val croppedBitmap = ThumbnailUtils.extractThumbnail(bitmap, cropSize, cropSize)
     val inputStream = context.contentResolver.openInputStream(uri)!!

domain/src/test/java/org/oppia/android/domain/profile/ProfileManagementControllerTest.kt

@@ -111,6 +111,10 @@ class ProfileManagementControllerTest {
     Profile.newBuilder().setName("Veena").setPin("567").setAllowDownloadAccess(true).build()
   )
 
+  private val allowedNames = listOf<String>("जिष्णु", "Ben-Henning", "Rajat.T", "جيشنو")
+
+  private val disallowedNames = listOf<String>("जिष्णु7", "Ben_Henning", "Rajat..T", "جيشنو^&&")
+
   @Before
   fun setUp() {
     setUpTestApplicationComponent()
@@ -167,23 +171,43 @@ class ProfileManagementControllerTest {
   }
 
   @Test
-  fun testAddProfile_addProfileWithNumberInName_checkResultIsFailure() {
+  fun testAddProfile_addProfilesWithDisallowedNames_checkResultIsFailure() {
     addTestProfiles()
     testCoroutineDispatchers.runCurrent()
 
-    profileManagementController.addProfile(
-      name = "James034",
-      pin = "321",
-      avatarImagePath = null,
-      allowDownloadAccess = false,
-      colorRgb = -10710042,
-      isAdmin = true
-    ).toLiveData().observeForever(mockUpdateResultObserver)
+    disallowedNames.forEach {
+      profileManagementController.addProfile(
+        name = it,
+        pin = "321",
+        avatarImagePath = null,
+        allowDownloadAccess = false,
+        colorRgb = -10710042,
+        isAdmin = true
+      ).toLiveData().observeForever(mockUpdateResultObserver)
+      testCoroutineDispatchers.runCurrent()
+
+      verifyUpdateFailed()
+      assertThat(updateResultCaptor.value.getErrorOrNull()).hasMessageThat()
+        .contains("$it does not contain only letters")
+    }
+  }
+
+  @Test
+  fun testAddProfiles_addProfilesWithAllowedNames_checkAllProfilesAreAdded() {
+    addAllowedNameProfiles()
     testCoroutineDispatchers.runCurrent()
 
-    verifyUpdateFailed()
-    assertThat(updateResultCaptor.value.getErrorOrNull()).hasMessageThat()
-      .contains("James034 does not contain only letters")
+    val profileDatabase = readProfileDatabase()
+    verifyUpdateSucceeded()
+
+    val profiles = profileDatabase.profilesMap
+
+    profiles.forEach { index, profile ->
+      assertThat(profile.name).isEqualTo(allowedNames[index])
+      assertThat(File(getAbsoluteDirPath("$index")).isDirectory).isTrue()
+    }
+
+    assertThat(profiles.size).isEqualTo(allowedNames.size)
   }
 
   @Test
@@ -1003,6 +1027,19 @@ class ProfileManagementControllerTest {
     }
   }
 
+  private fun addAllowedNameProfiles() {
+    allowedNames.forEach {
+      profileManagementController.addProfile(
+        name = it,
+        pin = "314",
+        avatarImagePath = null,
+        allowDownloadAccess = false,
+        colorRgb = -10710042,
+        isAdmin = false
+      ).toLiveData().observeForever(mockUpdateResultObserver)
+    }
+  }
+
   private fun checkTestProfilesArePresent(resultList: List<Profile>) {
     PROFILES_LIST.forEachIndexed { idx, profile ->
       assertThat(resultList[idx].name).isEqualTo(profile.name)

utility/src/main/java/org/oppia/android/util/profile/BUILD.bazel

@@ -14,3 +14,11 @@ kt_android_library(
         "//third_party:javax_inject_javax_inject",
     ],
 )
+
+kt_android_library(
+    name = "name_validator",
+    srcs = [
+        "NameValidator.kt",
+    ],
+    visibility = ["//domain:__subpackages__","//utility:__subpackages__"],
+)

utility/src/main/java/org/oppia/android/util/profile/NameValidator.kt

@@ -0,0 +1,32 @@
+package org.oppia.android.util.profile
+
+import javax.inject.Inject
+import javax.inject.Singleton
+
+/** Utility to validate profile names */
+@Singleton
+class NameValidator @Inject constructor() {
+  private val letterAndSymbolsRegex by lazy {
+    Regex("^.[${NameValidatorUtil.lettersAndSymbolsRegexString}]+\$")
+  }
+
+  private val noRepeatedAllowedSymbolsRegex by lazy { Regex("[.'-]{2}") }
+
+  /**
+   * Validates names for a profile
+   *
+   * @param name name of the profile
+   * @return if the profile name is allowed or not
+   */
+  fun isNameValid(name: String): Boolean {
+    return (onlyLettersAndAllowedSymbols(name) && noRepeatedUseOfAllowedSymbols(name))
+  }
+
+  private fun onlyLettersAndAllowedSymbols(name: String): Boolean {
+    return name.matches(letterAndSymbolsRegex)
+  }
+
+  private fun noRepeatedUseOfAllowedSymbols(name: String): Boolean {
+    return !name.contains(noRepeatedAllowedSymbolsRegex)
+  }
+}

utility/src/main/java/org/oppia/android/util/profile/NameValidatorUtil.kt

@@ -0,0 +1,20 @@
+package org.oppia.android.util.profile
+
+/** Utility class for [NameValidator]. */
+object NameValidatorUtil {
+  /**
+   * Some languages may not be detected properly by [allLanguageLettersRegex].
+   * In that case, the range of the Unicode character set will have to be added separately
+   * for that language to be processed by Regex.
+   *
+   * To add a language,
+   * create a variable containing Unicode range and add to the end of [lettersAndSymbolsRegexString]
+   */
+
+  private const val allLanguageLettersRegex = "\\p{L}"
+  private const val allowedSymbolsRegex = ".'\\-"
+
+  private const val hindiRegex = "\\u0900-\\u097F"
+
+  const val lettersAndSymbolsRegexString = "$allLanguageLettersRegex$hindiRegex$allowedSymbolsRegex"
+}

utility/src/test/java/org/oppia/android/util/profile/NameValidatorTest.kt

@@ -0,0 +1,36 @@
+package org.oppia.android.util.profile
+
+import com.google.common.truth.Truth.assertThat
+import org.junit.Before
+import org.junit.Test
+import javax.inject.Inject
+
+class NameValidatorTest {
+
+  @Inject
+  lateinit var nameValidator: NameValidator
+
+  private val allowedNames = listOf<String>("जिष्णु", "Ben-Henning", "Rajat.T", "جيشنو")
+
+  private val disallowedNames =
+    listOf<String>("जिष्णु7", "Ben_Henning", "Rajat..T", "جيشنو^&&", " ", ".", "Ben Henning")
+
+  @Before
+  fun setup() {
+    nameValidator = NameValidator()
+  }
+
+  @Test
+  fun testNameValidator_addDisallowedName_returnFalse() {
+    disallowedNames.forEach {
+      assertThat(nameValidator.isNameValid(it)).isEqualTo(false)
+    }
+  }
+
+  @Test
+  fun testNameValidator_addAllowedName_returnTrue() {
+    allowedNames.forEach {
+      assertThat(nameValidator.isNameValid(it)).isEqualTo(true)
+    }
+  }
+}