useragent

When using the package, keep the following behaviors in mind:

• Bots and Mobile: If a bot (like Googlebot) is detected using a mobile crawler, both ua.Bot and ua.Mobile will be set to true.
• Opera vs Opera Mini: These are treated as two distinct browsers because they operate differently.
• Unknown User Agents: The package uses a deterministic detection method. If a user agent string provides insufficient information, ua.IsUnknown() will return true. Note that even if unknown, fields like Name or OS might still contain partial information.
• Deterministic Detection: The package attempts to identify the agent even if the string does not follow common formats.

To use this package in your Go project, install it using go get:

go get github.com/mileusna/useragent

Instead of manually comparing string values for ua.OS or ua.Name, you can use shorthand methods for common checks. This makes your code cleaner and less error-prone.

Example comparison:

Instead of:

if ua.OS == "Android" && ua.Name == "Chrome" {
    // do something
}

Use:

if ua.IsAndroid() && ua.IsChrome() {
    // do something
}

ua := useragent.Parse(userAgentString)
if ua.IsAndroid() && ua.IsChrome() {
    // do something
}

The package provides a VersionNo struct that parses raw version strings (like 100.0.4896.127) into individual components (Major, Minor, Patch). This allows for precise version comparisons.

Version Comparison

You can perform logic based on specific version segments:

if ua.IsChrome() && ua.VersionNo.Major < 100 {
    log.Println("Error, browser is too old")
}

Formatting Version Strings

You can print prettified versions using the following methods:

• Browser Versions: VersionNoShort() and VersionNoFull()
• OS Versions: OSVersionNoShort() and OSVersionNoFull()

Example Output:

Chrome 100.0
Chrome 100.0.4896

fmt.Println(ua.Name, ua.VersionNoShort())
fmt.Println(ua.Name, ua.VersionNoFull())

The UserAgent type provides shorthand boolean methods to quickly identify the operating system of a parsed user agent. These methods check the ua.OS field against known constants.

Available OS checks:

• IsWindows(): Returns true if OS is Windows.
• IsAndroid(): Returns true if OS is Android.
• IsMacOS(): Returns true if OS is MacOS.
• IsIOS(): Returns true if OS is IOS.
• IsLinux(): Returns true if OS is Linux.
• IsChromeOS(): Returns true if OS is ChromeOS or CrOS.
• IsBlackberryOS(): Returns true if OS is BlackBerry.

// Assuming ua is an instance of UserAgent
if ua.IsWindows() {
    // Handle Windows logic
}

if ua.IsAndroid() {
    // Handle Android logic
}

The IsUnknown() method returns true if the package cannot reliably determine the device category. Specifically, it returns true if the user agent is not identified as Mobile, Tablet, Desktop, or Bot.

if ua.IsUnknown() {
    // Handle cases where device type is unreliable
}

The UserAgent type provides methods to format the parsed software version into short or full semantic version strings. If the version components (Major, Minor, Patch) are all zero, these methods return an empty string "".

// Returns <Major>.<Minor>
short := ua.VersionNoShort()

// Returns <Major>.<Minor>.<Patch>
full := ua.VersionNoFull()

Use the Parse function to convert a raw user agent string into a structured UserAgent struct. This struct contains extracted information about the operating system, browser name, version, device type (mobile, tablet, desktop), and whether the agent is a bot.

package main

import (
	"fmt"
	"github.com/mileusna/mileusna/useragent"
)

func main() {
	ua := useragent.Parse("Mozilla/5.0 (iPhone; CPU iPhone OS 14_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Mobile/15E148 Safari/604.1")
	fmt.Printf("OS: %s, Browser: %s, Mobile: %v\n", ua.OS, ua.Name, ua.Mobile)
}

The UserAgent type provides methods to format the parsed operating system version into short or full semantic version strings. If the OS version components (Major, Minor, Patch) are all zero, these methods return an empty string "".

// Returns <Major>.<Minor>
short := ua.OSVersionNoShort()

// Returns <Major>.<Minor>.<Patch>
full := ua.OSVersionNoFull()