Extend user agent by adding device manufacturer and model to the beginning.

This commit is contained in:
Onuray Sahin 2022-09-22 15:18:20 +03:00
parent e98bfe5c9b
commit b2e7cc2208
1 changed files with 41 additions and 36 deletions

View File

@ -17,10 +17,11 @@
package org.matrix.android.sdk.internal.network
import android.content.Context
import android.os.Build
import org.matrix.android.sdk.BuildConfig
import org.matrix.android.sdk.api.MatrixConfiguration
import org.matrix.android.sdk.api.extensions.tryOrNull
import org.matrix.android.sdk.internal.di.MatrixScope
import timber.log.Timber
import javax.inject.Inject
@MatrixScope
@ -38,51 +39,55 @@ internal class UserAgentHolder @Inject constructor(
/**
* Create an user agent with the application version.
* Ex: Element/1.0.0 (Linux; U; Android 6.0.1; SM-A510F Build/MMB29; Flavour GPlay; MatrixAndroidSdk2 1.0)
* Ex: Element/1.5.0 (Xiaomi; Mi 9T; Android 11; RKQ1.200826.002; Flavour GooglePlay; MatrixAndroidSdk2 1.5.0)
*
* @param flavorDescription the flavor description
*/
private fun setApplicationFlavor(flavorDescription: String) {
var appName = ""
var appVersion = ""
val appPackageName = context.applicationContext.packageName
val pm = context.packageManager
try {
val appPackageName = context.applicationContext.packageName
val pm = context.packageManager
val appInfo = pm.getApplicationInfo(appPackageName, 0)
appName = pm.getApplicationLabel(appInfo).toString()
val appName = tryOrNull { pm.getApplicationLabel(pm.getApplicationInfo(appPackageName, 0)).toString() }
?.takeIf {
it.matches("\\A\\p{ASCII}*\\z".toRegex())
}
?: run {
// Use appPackageName instead of appName if appName contains any non-ASCII character
appPackageName
}
val appVersion = tryOrNull { pm.getPackageInfo(context.applicationContext.packageName, 0).versionName }
val pkgInfo = pm.getPackageInfo(context.applicationContext.packageName, 0)
appVersion = pkgInfo.versionName ?: ""
val deviceManufacturer = Build.MANUFACTURER
val deviceModel = Build.MODEL
val androidVersion = Build.VERSION.RELEASE
val deviceBuildId = Build.DISPLAY
val matrixSdkVersion = BuildConfig.SDK_VERSION
// Use appPackageName instead of appName if appName contains any non-ASCII character
if (!appName.matches("\\A\\p{ASCII}*\\z".toRegex())) {
appName = appPackageName
}
} catch (e: Exception) {
Timber.e(e, "## initUserAgent() : failed")
}
val systemUserAgent = System.getProperty("http.agent")
// cannot retrieve the application version
if (appName.isEmpty() || appVersion.isEmpty()) {
if (null == systemUserAgent) {
userAgent = "Java" + System.getProperty("java.version")
}
if (appName.isNullOrEmpty() || appVersion.isNullOrEmpty()) {
userAgent = tryOrNull { System.getProperty("http.agent") } ?: ("Java" + System.getProperty("java.version"))
return
}
// if there is no user agent or cannot parse it
if (null == systemUserAgent || systemUserAgent.lastIndexOf(")") == -1 || !systemUserAgent.contains("(")) {
userAgent = (appName + "/" + appVersion + " ( Flavour " + flavorDescription +
"; MatrixAndroidSdk2 " + BuildConfig.SDK_VERSION + ")")
} else {
// update
userAgent = appName + "/" + appVersion + " " +
systemUserAgent.substring(systemUserAgent.indexOf("("), systemUserAgent.lastIndexOf(")") - 1) +
"; Flavour " + flavorDescription +
"; MatrixAndroidSdk2 " + BuildConfig.SDK_VERSION + ")"
userAgent = buildString {
append(appName)
append("/")
append(appVersion)
append(" (")
append(deviceManufacturer)
append("; ")
append(deviceModel)
append("; ")
append("Android ")
append(androidVersion)
append("; ")
append(deviceBuildId)
append("; ")
append("Flavour ")
append(flavorDescription)
append("; ")
append("MatrixAndroidSdk2 ")
append(matrixSdkVersion)
append(")")
}
}
}