HCaptcha support.

app/build.gradle

@@ -197,6 +197,7 @@ dependencies {
     implementation libs.drawerlayout
     implementation libs.swiperefreshlayout
     implementation libs.work.runtime.ktx
+    implementation libs.hcaptcha
     implementation libs.metrics.platform
 
     implementation libs.okhttp.tls

app/src/main/java/org/wikipedia/captcha/HCaptchaHelper.kt

@@ -0,0 +1,101 @@
+package org.wikipedia.captcha
+
+import androidx.core.net.toUri
+import androidx.fragment.app.FragmentActivity
+import com.hcaptcha.sdk.HCaptcha
+import com.hcaptcha.sdk.HCaptchaConfig
+import com.hcaptcha.sdk.HCaptchaDialogFragment
+import com.hcaptcha.sdk.HCaptchaTheme
+import com.hcaptcha.sdk.HCaptchaTokenResponse
+import org.wikipedia.WikipediaApp
+import org.wikipedia.settings.RemoteConfig
+import org.wikipedia.util.log.L
+import kotlin.String
+
+class HCaptchaHelper(
+    private val activity: FragmentActivity,
+    private val callback: Callback
+) {
+    interface Callback {
+        fun onSuccess(token: String)
+        fun onError(e: Exception)
+    }
+
+    private var hCaptcha: HCaptcha? = null
+    private var tokenResponse: HCaptchaTokenResponse? = null
+
+    private val configDefault get() = RemoteConfig.RemoteConfigHCaptcha(
+        baseURL = "https://meta.wikimedia.org",
+        jsSrc = "https://assets-hcaptcha.wikimedia.org/1/api.js",
+        endpoint = "https://hcaptcha.wikimedia.org",
+        assetHost = "https://assets-hcaptcha.wikimedia.org",
+        imgHost = "https://imgs-hcaptcha.wikimedia.org",
+        reportApi = "https://report-hcaptcha.wikimedia.org",
+        sentry = false,
+        siteKey = "e11698d6-51ca-4980-875c-72309c6678cc"
+    )
+
+    private val dialogCancelableRunnable = MakeHCaptchaDialogCancelable()
+
+    fun show() {
+        if (hCaptcha == null) {
+            val config = RemoteConfig.config.androidv1?.hCaptcha ?: configDefault
+            hCaptcha = HCaptcha.getClient(activity)
+            hCaptcha?.setup(
+                HCaptchaConfig.builder()
+                    .theme(if (WikipediaApp.instance.currentTheme.isDark) HCaptchaTheme.DARK else HCaptchaTheme.LIGHT)
+                    .siteKey(config.siteKey)
+                    .host(config.baseURL.toUri().host)
+                    .jsSrc(config.jsSrc)
+                    .endpoint(config.endpoint)
+                    .assethost(config.assetHost)
+                    .imghost(config.imgHost)
+                    .reportapi(config.reportApi)
+                    .sentry(config.sentry)
+                    .loading(false)
+                    .build()
+            )
+
+            hCaptcha?.addOnSuccessListener { response ->
+                tokenResponse = response
+                callback.onSuccess(response.tokenResult)
+            }?.addOnFailureListener { e ->
+                tokenResponse = null
+                L.e("hCaptcha failed: ${e.message} (${e.statusCode})")
+                callback.onError(e)
+            }?.addOnOpenListener {
+                L.d("hCaptcha opened")
+            }
+        }
+        hCaptcha?.verifyWithHCaptcha()
+
+        // This works around an issue in the hCaptcha library where the "loading" dialog, even when
+        // it's not visible, still allows itself to be "canceled" by touching anywhere outside its
+        // bounds. We work around this by explicitly finding its DialogFragment and setting it to
+        // be non-cancelable, and then setting it back to cancelable after a short delay, so that
+        // the user doesn't accidentally tap the screen while hCaptcha is loading.
+        activity.window.decorView.post(MakeHCaptchaDialogCancelable(false))
+        activity.window.decorView.postDelayed(dialogCancelableRunnable, 10000)
+    }
+
+    fun cleanup() {
+        if (!activity.isDestroyed) {
+            activity.window.decorView.removeCallbacks(dialogCancelableRunnable)
+        }
+        hCaptcha?.removeAllListeners()
+        hCaptcha?.reset()
+        hCaptcha = null
+    }
+
+    inner class MakeHCaptchaDialogCancelable(val cancelable: Boolean = true) : Runnable {
+        override fun run() {
+            if (!activity.isDestroyed) {
+                activity.supportFragmentManager.fragments.forEach {
+                    if (it is HCaptchaDialogFragment) {
+                        it.isCancelable = cancelable
+                    }
+                }
+            }
+        }
+    }
+}

app/src/main/java/org/wikipedia/createaccount/CreateAccountActivity.kt

@@ -28,6 +28,7 @@ import org.wikipedia.analytics.eventplatform.YearInReviewEvent
 import org.wikipedia.auth.AccountUtil
 import org.wikipedia.captcha.CaptchaHandler
 import org.wikipedia.captcha.CaptchaResult
+import org.wikipedia.captcha.HCaptchaHelper
 import org.wikipedia.databinding.ActivityCreateAccountBinding
 import org.wikipedia.login.LoginActivity
 import org.wikipedia.util.DeviceUtil
@@ -51,6 +52,18 @@ class CreateAccountActivity : BaseActivity() {
     private var requestSource: String = ""
     private val viewModel: CreateAccountActivityViewModel by viewModels()
 
+    private val hCaptchaHelper = HCaptchaHelper(this, object : HCaptchaHelper.Callback {
+        override fun onSuccess(token: String) {
+            showProgressBar(false)
+            doCreateAccount(viewModel.token.orEmpty(), hCaptchaToken = token)
+        }
+
+        override fun onError(e: Exception) {
+            showProgressBar(false)
+            FeedbackUtil.showMessage(this@CreateAccountActivity, e.message.orEmpty())
+        }
+    })
+
     public override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         binding = ActivityCreateAccountBinding.inflate(layoutInflater)
@@ -97,6 +110,11 @@ class CreateAccountActivity : BaseActivity() {
                             is CreateAccountActivityViewModel.AccountInfoState.DoCreateAccount -> {
                                 doCreateAccount(it.token)
                             }
+                            is CreateAccountActivityViewModel.AccountInfoState.HandleHCaptcha -> {
+                                showProgressBar(true)
+                                hCaptchaHelper.cleanup()
+                                hCaptchaHelper.show()
+                            }
                             is CreateAccountActivityViewModel.AccountInfoState.HandleCaptcha -> {
                                 captchaHandler.handleCaptcha(it.token, CaptchaResult(it.captchaId))
                             }
@@ -207,13 +225,15 @@ class CreateAccountActivity : BaseActivity() {
         L.w("Account creation failed with result $message")
     }
 
-    private fun doCreateAccount(token: String) {
+    private fun doCreateAccount(token: String, hCaptchaToken: String? = null) {
         showProgressBar(true)
         val email = getText(binding.createAccountEmail).ifEmpty { null }
         val password = getText(binding.createAccountPasswordInput)
         val repeat = getText(binding.createAccountPasswordRepeat)
         val userName = getText(binding.createAccountUsername)
-        viewModel.doCreateAccount(token, captchaHandler.captchaId().toString(), captchaHandler.captchaWord().toString(), userName, password, repeat, email)
+        viewModel.doCreateAccount(token, captchaHandler.captchaId(),
+            if (hCaptchaToken.isNullOrEmpty()) captchaHandler.captchaWord() else hCaptchaToken,
+            userName, password, repeat, email)
     }
 
     public override fun onStop() {
@@ -222,6 +242,7 @@ class CreateAccountActivity : BaseActivity() {
     }
 
     public override fun onDestroy() {
+        hCaptchaHelper.cleanup()
         captchaHandler.dispose()
         userNameTextWatcher?.let { binding.createAccountUsername.editText?.removeTextChangedListener(it) }
         super.onDestroy()
@@ -305,7 +326,7 @@ class CreateAccountActivity : BaseActivity() {
     }
 
     private fun showProgressBar(enable: Boolean) {
-        binding.viewProgressBar.visibility = if (enable) View.VISIBLE else View.GONE
+        binding.viewProgressBar.isVisible = enable
         binding.captchaContainer.captchaSubmitButton.isEnabled = !enable
         binding.captchaContainer.captchaSubmitButton.setText(if (enable) R.string.dialog_create_account_checking_progress else R.string.create_account_button)
     }

app/src/main/java/org/wikipedia/createaccount/CreateAccountActivityViewModel.kt

@@ -26,26 +26,30 @@ class CreateAccountActivityViewModel : ViewModel() {
     private val _verifyUserNameState = MutableSharedFlow<UserNameState>()
     val verifyUserNameState = _verifyUserNameState.asSharedFlow()
 
+    var token: String? = null
+
     private var verifyUserNameJob: Job? = null
 
     fun createAccountInfo() {
         viewModelScope.launch(CoroutineExceptionHandler { _, throwable ->
             _createAccountInfoState.value = AccountInfoState.Error(throwable)
         }) {
             val response = ServiceFactory.get(WikipediaApp.instance.wikiSite).getAuthManagerInfo()
-            val token = response.query?.createAccountToken()
+            token = response.query?.createAccountToken()
             val captchaId = response.query?.captchaId()
             if (token.isNullOrEmpty()) {
                 _createAccountInfoState.value = AccountInfoState.InvalidToken
+            } else if (response.query?.hasHCaptchaRequest() == true) {
+                _createAccountInfoState.value = AccountInfoState.HandleHCaptcha(token!!)
             } else if (!captchaId.isNullOrEmpty()) {
-                _createAccountInfoState.value = AccountInfoState.HandleCaptcha(token, captchaId)
+                _createAccountInfoState.value = AccountInfoState.HandleCaptcha(token!!, captchaId)
             } else {
-                _createAccountInfoState.value = AccountInfoState.DoCreateAccount(token)
+                _createAccountInfoState.value = AccountInfoState.DoCreateAccount(token!!)
             }
         }
     }
 
-    fun doCreateAccount(token: String, captchaId: String, captchaWord: String, userName: String, password: String, repeat: String, email: String?) {
+    fun doCreateAccount(token: String, captchaId: String?, captchaWord: String?, userName: String, password: String, repeat: String, email: String?) {
         viewModelScope.launch(CoroutineExceptionHandler { _, throwable ->
             _doCreateAccountState.value = CreateAccountState.Error(throwable)
         }) {
@@ -84,7 +88,8 @@ class CreateAccountActivityViewModel : ViewModel() {
 
     open class AccountInfoState {
         data class DoCreateAccount(val token: String) : AccountInfoState()
-        data class HandleCaptcha(val token: String?, val captchaId: String) : AccountInfoState()
+        data class HandleCaptcha(val token: String, val captchaId: String) : AccountInfoState()
+        data class HandleHCaptcha(val token: String) : AccountInfoState()
         data object InvalidToken : AccountInfoState()
         data class Error(val throwable: Throwable) : AccountInfoState()
     }

app/src/main/java/org/wikipedia/dataclient/mwapi/MwAuthManagerInfo.kt

@@ -11,7 +11,7 @@ internal class MwAuthManagerInfo {
     internal class Request(val id: String? = null,
                            private val metadata: Map<String, String>? = null,
                            private val required: String? = null,
-                           private val provider: String? = null,
+                           val provider: String? = null,
                            private val account: String? = null,
                            val fields: Map<String, Field>? = null)
 

app/src/main/java/org/wikipedia/dataclient/mwapi/MwQueryResult.kt

@@ -79,6 +79,10 @@ class MwQueryResult {
         return amInfo?.requests?.find { it.fields?.containsKey(key) == true }?.fields?.get(key)?.value
     }
 
+    fun hasHCaptchaRequest(): Boolean {
+        return amInfo?.requests?.find { it.provider.orEmpty().lowercase().contains("hcaptcha") } != null
+    }
+
     fun getUserResponse(userName: String): UserInfo? {
         // MediaWiki user names are case sensitive, but the first letter is always capitalized.
         return users?.find { StringUtil.capitalize(userName) == it.name }

gradle/libs.versions.toml

@@ -16,6 +16,7 @@ googlePayVersion = "19.5.0"
 googleServices = "4.4.4"
 gradle = "8.13.1"
 hamcrest = "3.0"
+hcaptcha = "4.4.0"
 installreferrer = "2.2"
 jsoup = "1.21.2"
 junit = "4.13.2"
@@ -84,6 +85,7 @@ fragment-ktx = { module = "androidx.fragment:fragment-ktx", version.ref = "fragm
 google-services = { module = "com.google.gms:google-services", version.ref = "googleServices" }
 gradle = { module = "com.android.tools.build:gradle", version.ref = "gradle" }
 hamcrest = { module = "org.hamcrest:hamcrest", version.ref = "hamcrest" }
+hcaptcha = { module = "com.github.hCaptcha.hcaptcha-android-sdk:sdk", version.ref = "hcaptcha" }
 installreferrer = { module = "com.android.installreferrer:installreferrer", version.ref = "installreferrer" }
 jsoup = { module = "org.jsoup:jsoup", version.ref = "jsoup" }
 junit = { module = "junit:junit", version.ref = "junit" }

settings.gradle.kts

@@ -11,6 +11,7 @@ dependencyResolutionManagement {
         google()
         mavenCentral()
         mavenLocal()
+        maven { setUrl("https://jitpack.io") }
     }
 }