user_agent

package module
Version: v0.5.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 19, 2021 License: MIT Imports: 2 Imported by: 238

README

Build Status for master branch godoc.org page MIT


UserAgent is a Go library that parses HTTP User Agents. As an example:

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
}

If you want to read the full API documentation simply check godoc.

Installation

go get -u github.com/mssola/user_agent

Contributing

Do you want to contribute with code, or to report an issue you are facing? Read the CONTRIBUTING.md file.

Changelog

Read the CHANGELOG.md file.

License

Copyright (c) 2012-2021 Miquel Sabaté Solà

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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
}

Browser is a struct containing all the information that we might be interested from the browser.

type OSInfo added in v0.5.0

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
}

OSInfo 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 added in v0.2.1

func New(ua string) *UserAgent

New parses 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

Bot returns true if it's a bot, false otherwise.

func (*UserAgent) Browser

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

Browser 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)

Engine 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

Localization returns a string containing the localization.

func (*UserAgent) Mobile

func (p *UserAgent) Mobile() bool

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

func (*UserAgent) Mozilla

func (p *UserAgent) Mozilla() string

Mozilla 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

OS returns a string containing the name of the Operating System.

func (*UserAgent) OSInfo added in v0.5.0

func (p *UserAgent) OSInfo() 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

Platform returns a string containing the platform..

func (*UserAgent) UA added in v0.5.0

func (p *UserAgent) UA() string

UA returns the original given user agent.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL