Revision control
Copy as Markdown
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
import Common
import WebKit
import UIKit
open class UserAgent {
public static let uaBitSafari = "Safari/605.1.15"
public static let uaBitMobile = "Mobile/15E148"
public static let uaBitFx = "FxiOS/\(AppInfo.appVersion)"
public static let product = "Mozilla/5.0"
public static let platform = "AppleWebKit/605.1.15"
public static let platformDetails = "(KHTML, like Gecko)"
// For iPad, we need to append this to the default UA for google.com to show correct page
public static let uaBitGoogleIpad = "Version/13.0.3"
private static var defaults = UserDefaults(suiteName: AppInfo.sharedContainerIdentifier)!
private static func clientUserAgent(prefix: String) -> String {
let versionStr: String
if AppInfo.buildNumber != "1" {
versionStr = "\(AppInfo.appVersion)b\(AppInfo.buildNumber)"
} else {
versionStr = "dev"
}
return "\(prefix)/\(versionStr) (\(DeviceInfo.deviceModel()); iPhone OS \(UIDevice.current.systemVersion)) (\(AppInfo.displayName))"
}
public static var syncUserAgent: String {
return clientUserAgent(prefix: "Firefox-iOS-Sync")
}
public static var tokenServerClientUserAgent: String {
return clientUserAgent(prefix: "Firefox-iOS-Token")
}
public static var fxaUserAgent: String {
return clientUserAgent(prefix: "Firefox-iOS-FxA")
}
public static var defaultClientUserAgent: String {
return clientUserAgent(prefix: "Firefox-iOS")
}
public static func isDesktop(ua: String) -> Bool {
return ua.lowercased().contains("intel mac")
}
public static func desktopUserAgent() -> String {
// swiftlint:disable line_length
return "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.0 Safari/605.1.15"
// swiftlint:enable line_length
}
public static func mobileUserAgent() -> String {
return UserAgentBuilder.defaultMobileUserAgent().userAgent()
}
public static func oppositeUserAgent(domain: String) -> String {
let isDefaultUADesktop = UserAgent.isDesktop(ua: UserAgent.getUserAgent(domain: domain))
if isDefaultUADesktop {
return UserAgent.getUserAgent(domain: domain, platform: .Mobile)
} else {
return UserAgent.getUserAgent(domain: domain, platform: .Desktop)
}
}
public static func getUserAgent(domain: String, platform: UserAgentPlatform) -> String {
switch platform {
case .Desktop:
return desktopUserAgent()
case .Mobile:
if let customUA = CustomUserAgentConstant.customUAFor[domain] {
return customUA
} else {
return mobileUserAgent()
}
}
}
public static func getUserAgent(domain: String = "") -> String {
// As of iOS 13 using a hidden webview method does not return the correct UA on
// iPad (it returns mobile UA). We should consider that method no longer reliable.
if UIDevice.current.userInterfaceIdiom == .pad {
return getUserAgent(domain: domain, platform: .Desktop)
} else {
return getUserAgent(domain: domain, platform: .Mobile)
}
}
}
public enum UserAgentPlatform {
case Desktop
case Mobile
}
public struct CustomUserAgentConstant {
private static let defaultMobileUA = UserAgentBuilder.defaultMobileUserAgent().userAgent()
private static let customDesktopUA = UserAgentBuilder.defaultDesktopUserAgent().clone(extensions: "Version/\(AppInfo.appVersion) \(UserAgent.uaBitSafari)")
public static let customUAFor = [
"paypal.com": defaultMobileUA,
"yahoo.com": defaultMobileUA,
"disneyplus.com": customDesktopUA]
}
public struct UserAgentBuilder {
// User agent components
fileprivate var product = ""
fileprivate var systemInfo = ""
fileprivate var platform = ""
fileprivate var platformDetails = ""
fileprivate var extensions = ""
init(
product: String,
systemInfo: String,
platform: String,
platformDetails: String,
extensions: String
) {
self.product = product
self.systemInfo = systemInfo
self.platform = platform
self.platformDetails = platformDetails
self.extensions = extensions
}
public func userAgent() -> String {
let userAgentItems = [product, systemInfo, platform, platformDetails, extensions]
return removeEmptyComponentsAndJoin(uaItems: userAgentItems)
}
public func clone(
product: String? = nil,
systemInfo: String? = nil,
platform: String? = nil,
platformDetails: String? = nil,
extensions: String? = nil
) -> String {
let userAgentItems = [
product ?? self.product,
systemInfo ?? self.systemInfo,
platform ?? self.platform,
platformDetails ?? self.platformDetails,
extensions ?? self.extensions
]
return removeEmptyComponentsAndJoin(uaItems: userAgentItems)
}
/// Helper method to remove the empty components from user agent string that contain
/// only whitespaces or are just empty
private func removeEmptyComponentsAndJoin(uaItems: [String]) -> String {
return uaItems.filter { !$0.isEmptyOrWhitespace() }.joined(separator: " ")
}
public static func defaultMobileUserAgent() -> UserAgentBuilder {
return UserAgentBuilder(
product: UserAgent.product,
systemInfo: "(\(UIDevice.current.model); CPU iPhone OS \(UIDevice.current.systemVersion.replacingOccurrences(of: ".", with: "_")) like Mac OS X)",
platform: UserAgent.platform,
platformDetails: UserAgent.platformDetails,
extensions: "FxiOS/\(AppInfo.appVersion) \(UserAgent.uaBitMobile) \(UserAgent.uaBitSafari)")
}
public static func defaultDesktopUserAgent() -> UserAgentBuilder {
return UserAgentBuilder(
product: UserAgent.product,
systemInfo: "(Macintosh; Intel Mac OS X 10.15)",
platform: UserAgent.platform,
platformDetails: UserAgent.platformDetails,
extensions: "FxiOS/\(AppInfo.appVersion) \(UserAgent.uaBitSafari)")
}
}