Add Google translator API key support

Airsaid · Airsaid · commit d89a742015ae · 2025-11-16T14:30:22.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@
 
 ## [Unreleased]
 
+### Added
+
+- Allow configuring a Google Cloud Translation API key for the Google translator, including secure credential storage and Compose UI controls.
+
 ## [4.1.0] - 2025-10-11
 
 ### Added
diff --git a/src/main/kotlin/com/airsaid/localization/translate/impl/google/AbsGoogleTranslator.kt b/src/main/kotlin/com/airsaid/localization/translate/impl/google/AbsGoogleTranslator.kt
@@ -31,7 +31,7 @@ abstract class AbsGoogleTranslator : AbstractTranslator() {
 
   override val icon: Icon = PluginIcons.GOOGLE_ICON
 
-  override val credentialDefinitions: List<TranslatorCredentialDescriptor> = emptyList()
+  override val credentialDefinitions: List<TranslatorCredentialDescriptor> = listOf(API_KEY_DESCRIPTOR)
 
   override val supportedLanguages: List<Lang> by lazy {
     Languages.allSupportedLanguages()
@@ -46,4 +46,14 @@ abstract class AbsGoogleTranslator : AbstractTranslator() {
         }
       }
   }
+
+  companion object {
+    val API_KEY_DESCRIPTOR = TranslatorCredentialDescriptor(
+      id = "apiKey",
+      label = "API Key",
+      isSecret = true,
+      required = false,
+      description = "Optional Google Cloud Translation API key"
+    )
+  }
 }
diff --git a/src/main/kotlin/com/airsaid/localization/translate/impl/google/GoogleTranslator.kt b/src/main/kotlin/com/airsaid/localization/translate/impl/google/GoogleTranslator.kt
@@ -24,11 +24,21 @@ class GoogleTranslator : AbsGoogleTranslator() {
 
   private val log = Logger.getInstance(GoogleTranslator::class.java)
 
+  private val useCustomApiKey: Boolean
+    get() = GoogleTranslatorSettings.getInstance().useCustomApiKey
+
   override val key: String = KEY
 
   override val icon: Icon = PluginIcons.GOOGLE_ICON
 
   override fun getRequestUrl(fromLang: Lang, toLang: Lang, text: String): String {
+    if (useCustomApiKey) {
+      val apiKey = credentialValue(API_KEY_DESCRIPTOR.id)
+      return UrlBuilder(CLOUD_TRANSLATE_V2_URL)
+        .addQueryParameter("key", apiKey)
+        .build()
+    }
+
     val source = if (fromLang.code.equals(Languages.AUTO.code, ignoreCase = true)) "auto" else fromLang.translationCode
     val builder = UrlBuilder(googleApiUrl(TRANSLATE_PATH))
       .addQueryParameter("client", "gtx")
@@ -44,17 +54,51 @@ class GoogleTranslator : AbsGoogleTranslator() {
   }
 
   override fun getRequestParams(fromLang: Lang, toLang: Lang, text: String): List<Pair<String, String>> {
+    if (useCustomApiKey) return emptyList()
+
     return listOf(Pair.create("q", text))
   }
 
   override fun configureRequestBuilder(requestBuilder: RequestBuilder) {
-    requestBuilder.withGoogleHeaders()
+    if (!useCustomApiKey) {
+      requestBuilder.withGoogleHeaders()
+    }
+  }
+
+  override val requestContentType: String
+    get() = if (useCustomApiKey) JSON_CONTENT_TYPE else super.requestContentType
+
+  override fun getRequestBody(fromLang: Lang, toLang: Lang, text: String): String {
+    if (!useCustomApiKey) return ""
+
+    val request = GoogleCloudTranslationRequest(
+      q = listOf(text),
+      target = toLang.translationCode,
+      format = "text",
+      source = fromLang.takeUnless { it.code.equals(Languages.AUTO.code, ignoreCase = true) }?.translationCode
+    )
+    return GsonUtil.getInstance().gson.toJson(request)
   }
 
   /**
    * Parses the JSON payload and surfaces API errors as `TranslationException`.
    */
   override fun parsingResult(fromLang: Lang, toLang: Lang, text: String, resultText: String): String {
+    return if (useCustomApiKey) {
+      parseCloudResponse(fromLang, toLang, text, resultText)
+    } else {
+      parseWebResponse(fromLang, toLang, text, resultText)
+    }
+  }
+
+  companion object {
+    private const val KEY = "Google"
+    private const val TRANSLATE_PATH = "/translate_a/single"
+    private const val CLOUD_TRANSLATE_V2_URL = "https://translation.googleapis.com/language/translate/v2"
+    private const val JSON_CONTENT_TYPE = "application/json; charset=UTF-8"
+  }
+
+  private fun parseWebResponse(fromLang: Lang, toLang: Lang, text: String, resultText: String): String {
     val response = GsonUtil.getInstance().gson.fromJson(resultText, GoogleTranslationResponse::class.java)
     response.error?.message?.let { message ->
       throw TranslationException(fromLang, toLang, text, message)
@@ -73,8 +117,36 @@ class GoogleTranslator : AbsGoogleTranslator() {
     return translation
   }
 
-  companion object {
-    private const val KEY = "Google"
-    private const val TRANSLATE_PATH = "/translate_a/single"
+  private fun parseCloudResponse(fromLang: Lang, toLang: Lang, text: String, resultText: String): String {
+    val response = GsonUtil.getInstance().gson.fromJson(resultText, GoogleCloudTranslationResponse::class.java)
+    response.error?.message?.let { message ->
+      throw TranslationException(fromLang, toLang, text, message)
+    }
+    val translation = response.data?.translations
+      ?.mapNotNull { it.translatedText }
+      ?.joinToString(separator = "")
+      ?.trim()
+      .orEmpty()
+    if (translation.isEmpty()) {
+      log.warn("Empty translation from Google Cloud Translation API: $resultText")
+      return ""
+    }
+    return translation
   }
 }
+
+private data class GoogleCloudTranslationRequest(
+  val q: List<String>,
+  val target: String,
+  val format: String,
+  val source: String?
+)
+
+private data class GoogleCloudTranslationResponse(
+  val data: TranslationData?,
+  val error: CloudError?
+) {
+  data class TranslationData(val translations: List<TranslationEntry>?)
+  data class TranslationEntry(val translatedText: String?)
+  data class CloudError(val message: String?)
+}
diff --git a/src/main/kotlin/com/airsaid/localization/translate/impl/google/GoogleTranslatorSettings.kt b/src/main/kotlin/com/airsaid/localization/translate/impl/google/GoogleTranslatorSettings.kt
@@ -17,7 +17,8 @@ class GoogleTranslatorSettings : PersistentStateComponent<GoogleTranslatorSettin
 
   data class State(
     var useCustomServer: Boolean = false,
-    var serverUrl: String = DEFAULT_SERVER_URL
+    var serverUrl: String = DEFAULT_SERVER_URL,
+    var useCustomApiKey: Boolean = false,
   )
 
   private var state = State()
@@ -34,6 +35,12 @@ class GoogleTranslatorSettings : PersistentStateComponent<GoogleTranslatorSettin
       state = state.copy(serverUrl = value.ifBlank { DEFAULT_SERVER_URL })
     }
 
+  var useCustomApiKey: Boolean
+    get() = state.useCustomApiKey
+    set(value) {
+      state = state.copy(useCustomApiKey = value)
+    }
+
   override fun getState(): State = state
 
   override fun loadState(state: State) {
diff --git a/src/main/kotlin/com/airsaid/localization/translate/impl/google/GoogleTranslatorSettingsDialog.kt b/src/main/kotlin/com/airsaid/localization/translate/impl/google/GoogleTranslatorSettingsDialog.kt
@@ -4,10 +4,10 @@ import androidx.compose.foundation.layout.Arrangement
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.fillMaxWidth
 import androidx.compose.foundation.layout.padding
-import androidx.compose.foundation.text.selection.SelectionContainer
 import androidx.compose.runtime.*
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
+import com.airsaid.localization.config.SettingsState
 import com.airsaid.localization.ui.ComposeDialog
 import com.airsaid.localization.ui.components.IdeCheckBox
 import com.airsaid.localization.ui.components.IdeTextField
@@ -22,9 +22,11 @@ import org.jetbrains.jewel.ui.component.Text
 class GoogleTranslatorSettingsDialog : ComposeDialog() {
 
   override val defaultPreferredSize
-    get() = 400 to 160
+    get() = 500 to 260
 
   private val settings = GoogleTranslatorSettings.getInstance()
+  private val state = SettingsState.getInstance()
+  private val apiKeyDescriptor = AbsGoogleTranslator.API_KEY_DESCRIPTOR
 
   init {
     title = "Google Translator Settings"
@@ -34,6 +36,8 @@ class GoogleTranslatorSettingsDialog : ComposeDialog() {
   override fun Content() {
     var useCustomServer by remember { mutableStateOf(settings.useCustomServer) }
     var serverUrl by remember { mutableStateOf(settings.serverUrl) }
+    var useCustomApiKey by remember { mutableStateOf(settings.useCustomApiKey) }
+    var apiKey by remember { mutableStateOf(state.getCredential("Google", apiKeyDescriptor)) }
 
     Column(
       modifier = Modifier
@@ -44,11 +48,12 @@ class GoogleTranslatorSettingsDialog : ComposeDialog() {
         checked = useCustomServer,
         onCheckedChange = {
           useCustomServer = it
-          if (!it) {
-            serverUrl = settings.serverUrl
+          if (useCustomServer) {
+            useCustomApiKey = false
           }
         },
         title = "Use custom server",
+        subTitle = "Defaults to translate.googleapis.com unless a custom server is used."
       )
 
       Column(verticalArrangement = Arrangement.spacedBy(6.dp)) {
@@ -71,20 +76,47 @@ class GoogleTranslatorSettingsDialog : ComposeDialog() {
         )
       }
 
-      SelectionContainer {
+      IdeCheckBox(
+        checked = useCustomApiKey,
+        onCheckedChange = {
+          useCustomApiKey = it
+          if (useCustomApiKey) {
+            useCustomServer = false
+          }
+        },
+        title = "Use custom API key",
+        subTitle = "Disable to fall back to the public web endpoint."
+      )
+
+      Column(verticalArrangement = Arrangement.spacedBy(6.dp)) {
         Text(
-          text = "Defaults to translate.googleapis.com when not specified.",
+          text = "API Key",
           color = JewelTheme.globalColors.text.info
         )
+        IdeTextField(
+          value = apiKey,
+          onValueChange = { apiKey = it },
+          modifier = Modifier.fillMaxWidth(),
+          enabled = useCustomApiKey,
+          secureInput = true,
+          placeholder = {
+            Text(
+              text = "Enter your Google Cloud Translation API key",
+              color = JewelTheme.globalColors.text.info
+            )
+          }
+        )
       }
     }
 
     OnClickOK {
-      // Persist the selected endpoint and toggle when the user accepts the dialog.
       settings.useCustomServer = useCustomServer
       if (useCustomServer) {
         settings.serverUrl = serverUrl.ifBlank { GoogleTranslatorSettings.DEFAULT_SERVER_URL }
       }
+      settings.useCustomApiKey = useCustomApiKey
+      val normalizedKey = if (useCustomApiKey) apiKey.trim() else ""
+      state.setCredential("Google", apiKeyDescriptor, normalizedKey)
     }
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ abstract class AbsGoogleTranslator : AbstractTranslator() {`
`31`	`31`
`32`	`32`	`override val icon: Icon = PluginIcons.GOOGLE_ICON`
`33`	`33`
`34`		`- override val credentialDefinitions: List<TranslatorCredentialDescriptor> = emptyList()`
	`34`	`+ override val credentialDefinitions: List<TranslatorCredentialDescriptor> = listOf(API_KEY_DESCRIPTOR)`
`35`	`35`
`36`	`36`	`override val supportedLanguages: List<Lang> by lazy {`
`37`	`37`	`Languages.allSupportedLanguages()`
`@@ -46,4 +46,14 @@ abstract class AbsGoogleTranslator : AbstractTranslator() {`
`46`	`46`	`}`
`47`	`47`	`}`
`48`	`48`	`}`
	`49`	`+`
	`50`	`+ companion object {`
	`51`	`+ val API_KEY_DESCRIPTOR = TranslatorCredentialDescriptor(`
	`52`	`+ id = "apiKey",`
	`53`	`+ label = "API Key",`
	`54`	`+ isSecret = true,`
	`55`	`+ required = false,`
	`56`	`+ description = "Optional Google Cloud Translation API key"`
	`57`	`+ )`
	`58`	`+ }`
`49`	`59`	`}`