user_agent

README

UserAgent

UserAgent is a Go library that parses HTTP User Agents.

Usage

package main

import (
    "fmt"

    "github.com/mssola/user_agent"
)

func main() {
    // The "New" function will create a new UserAgent object and it will parse
    // the given string. If you need to parse more strings, you can re-use
    // this object and call: ua.Parse("another string")
    ua := user_agent.New("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.11 (KHTML, like Gecko) Chrome/23.0.1271.97 Safari/537.11")

    fmt.Printf("%v\n", ua.Mobile())   // => false
    fmt.Printf("%v\n", ua.Bot())      // => false
    fmt.Printf("%v\n", ua.Mozilla())  // => "5.0"

    fmt.Printf("%v\n", ua.Platform()) // => "X11"
    fmt.Printf("%v\n", ua.OS())       // => "Linux x86_64"

    name, version := ua.Engine()
    fmt.Printf("%v\n", name)          // => "AppleWebKit"
    fmt.Printf("%v\n", version)       // => "537.11"

    name, version = ua.Browser()
    fmt.Printf("%v\n", name)          // => "Chrome"
    fmt.Printf("%v\n", version)       // => "23.0.1271.97"

    // Let's see an example with a bot.

    ua.Parse("Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)")

    fmt.Printf("%v\n", ua.Bot())      // => true

    name, version = ua.Browser()
    fmt.Printf("%v\n", name)          // => Googlebot
    fmt.Printf("%v\n", version)       // => 2.1
}

Copyright © 2012-2018 Miquel Sabaté Solà, released under the MIT License.

Documentation

Overview

Package user_agent implements an HTTP User Agent string parser. It defines the type UserAgent that contains all the information from the parsed string. It also implements the Parse function and getters for all the relevant information that has been extracted from a parsed User Agent string.

Index

• type Browser
• type OSInfo
• type UserAgent
  • func New(ua string) *UserAgent
  • func (p *UserAgent) Bot() bool
  • func (p *UserAgent) Browser() (string, string)
  • func (p *UserAgent) Engine() (string, string)
  • func (p *UserAgent) Localization() string
  • func (p *UserAgent) Mobile() bool
  • func (p *UserAgent) Mozilla() string
  • func (p *UserAgent) OS() string
  • func (p *UserAgent) OSInfo() OSInfo
  • func (p *UserAgent) Parse(ua string)
  • func (p *UserAgent) Platform() string
  • func (p *UserAgent) UA() string

Types

type Browser

type Browser struct {
	// The name of the browser's engine.
	Engine string

	// The version of the browser's engine.
	EngineVersion string

	// The name of the browser.
	Name string

	// The version of the browser.
	Version string
}

A struct containing all the information that we might be interested from the browser.

type OSInfo

type OSInfo struct {
	// Full name of the operating system. This is identical to the output of ua.OS()
	FullName string

	// Name of the operating system. This is sometimes a shorter version of the
	// operating system name, e.g. "Mac OS X" instead of "Intel Mac OS X"
	Name string

	// Operating system version, e.g. 7 for Windows 7 or 10.8 for Max OS X Mountain Lion
	Version string
}

Represents full information on the operating system extracted from the user agent.

type UserAgent

type UserAgent struct {
	// contains filtered or unexported fields
}

The UserAgent struct contains all the info that can be extracted from the User-Agent string.

func New

func New(ua string) *UserAgent

Parse the given User-Agent string and get the resulting UserAgent object.

Returns an UserAgent object that has been initialized after parsing the given User-Agent string.

func (*UserAgent) Bot

func (p *UserAgent) Bot() bool

Returns true if it's a bot, false otherwise.

func (*UserAgent) Browser

func (p *UserAgent) Browser() (string, string)

Returns two strings. The first string is the name of the browser and the second one is the version of the browser.

func (*UserAgent) Engine

func (p *UserAgent) Engine() (string, string)

Returns two strings. The first string is the name of the engine and the second one is the version of the engine.

func (*UserAgent) Localization

func (p *UserAgent) Localization() string

Returns a string containing the localization.

func (*UserAgent) Mobile

func (p *UserAgent) Mobile() bool

Returns true if it's a mobile device, false otherwise.

func (*UserAgent) Mozilla

func (p *UserAgent) Mozilla() string

Returns the mozilla version (it's how the User Agent string begins: "Mozilla/5.0 ...", unless we're dealing with Opera, of course).

func (*UserAgent) OS

func (p *UserAgent) OS() string

Returns a string containing the name of the Operating System.

func (*UserAgent) OSInfo

func (p *UserAgent) OSInfo() OSInfo

Returns combined information for the operating system.

func (*UserAgent) Parse

func (p *UserAgent) Parse(ua string)

Parse the given User-Agent string. After calling this function, the receiver will be setted up with all the information that we've extracted.

func (*UserAgent) Platform

func (p *UserAgent) Platform() string

Returns a string containing the platform..

func (*UserAgent) UA

func (p *UserAgent) UA() string

Returns the original given user agent.