browscap_go

README

Golang Client for Browser Capabilities Project

Browscap provides regularly updated rules for parsing user agents.

For more info check the officall PHP client.

Example:

import (
	"fmt"
	bgo "github.com/digitalcrab/browscap_go"
)

func main() {
	if err := bgo.InitBrowsCap("browscap.ini", false); err != nil {
		panic(err)
	}
	
	browser, ok := bgo.GetBrowser("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/37.0.2062.120 Safari/537.36")
	if !ok || browser == nil {
    	panic("Browser not found")
	} else {
    	fmt.Printf("Browser = %s [%s] v%s\n", browser.Browser, browser.BrowserType, browser.BrowserVersion)
    	fmt.Printf("Platform = %s v%s\n", browser.Platform, browser.PlatformVersion)
    	fmt.Printf("Device = %s [%s] %s\n", browser.DeviceName, browser.DeviceType, browser.DeviceBrand)
    	fmt.Printf("IsCrawler = %t\n", browser.IsCrawler())
    	fmt.Printf("IsMobile = %t\n", browser.IsMobile())
	}
}

Browser object fields

Browser         string
BrowserVersion  string
BrowserMajorVer string
BrowserMinorVer string
// Browser, Application, Bot/Crawler, Useragent Anonymizer, Offline Browser,
// Multimedia Player, Library, Feed Reader, Email Client or unknown
BrowserType string

Platform        string
PlatformShort   string
PlatformVersion string

// Mobile Phone, Mobile Device, Tablet, Desktop, TV Device, Console,
// FonePad, Ebook Reader, Car Entertainment System or unknown
DeviceType  string
DeviceName  string
DeviceBrand string

Crawler string

Cookies    string
JavaScript string

RenderingEngineName    string
RenderingEngineVersion string

Benchmark

BenchmarkInit-4         	       1	2256895168 ns/op	346136904 B/op	 5700912 allocs/op
BenchmarkGetBrowser-4   	   10000	    140975 ns/op	      37 B/op	       1 allocs/op

My Benchmark

goos: linux
goarch: amd64
BenchmarkInit-12          	       1	2479319848 ns/op	711650336 B/op	11695215 allocs/op
BenchmarkGetBrowser-12    	   15080	     76580 ns/op	      32 B/op	       1 allocs/op

License

The MIT License (MIT)

Copyright (c) 2015 Maksim Naumov

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

Index

• Constants
• func DownloadFile(saveAs string) error
• func InitBrowsCap(path string, force bool) error
• func InitializedVersion() string
• func LastVersion() (string, error)
• type BrowsCap
  • func NewBrowsCapFromFile(path string) (*BrowsCap, error)
  • func NewBrowsCapFromReader(reader io.Reader) (*BrowsCap, error)
  • func (browscap *BrowsCap) GetBrowser(userAgent string) (browser *Browser, ok bool)
  • func (browscap *BrowsCap) InitializedVersion() string
• type Browser
  • func GetBrowser(userAgent string) (browser *Browser, ok bool)
  • func (browser *Browser) IsAndroid() bool
  • func (browser *Browser) IsConsole() bool
  • func (browser *Browser) IsCrawler() bool
  • func (browser *Browser) IsDesktop() bool
  • func (browser *Browser) IsIPad() bool
  • func (browser *Browser) IsIPhone() bool
  • func (browser *Browser) IsMobile() bool
  • func (browser *Browser) IsTablet() bool
  • func (browser *Browser) IsTv() bool
  • func (browser *Browser) IsWinPhone() bool
• type Expression
  • func CompileExpression(s []byte) Expression
• type ExpressionTree
  • func NewExpressionTree() *ExpressionTree
  • func (r *ExpressionTree) Add(name string, lineNum int)
  • func (r *ExpressionTree) Find(userAgent []byte) string
• type Token
  • func (t *Token) Equal(t1 Token) bool
  • func (t *Token) Fuzzy() bool
  • func (t *Token) MatchOne(r []byte) (bool, []byte)
  • func (t *Token) Shard() byte
  • func (t *Token) String() string
• type Tokens

Constants

const (
	DownloadUrl     = "http://browscap.org/stream?q=PHP_BrowsCapINI"
	CheckVersionUrl = "http://browscap.org/version-number"
)

const (
	TOKEN_MULTI  rune = '*'
	TOKEN_SINGLE rune = '?'

	MODE_MULTI  int = 3
	MODE_SINGLE int = 2
	MODE_STATIC int = 1
)

Functions

func DownloadFile

func DownloadFile(saveAs string) error

func InitBrowsCap

func InitBrowsCap(path string, force bool) error

Deprecated: Use NewBrowsCapFromFile

func InitializedVersion

func InitializedVersion() string

Deprecated: Use BrowsCap.InitializedVersion

func LastVersion

func LastVersion() (string, error)

Types

type BrowsCap

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

func NewBrowsCapFromFile

func NewBrowsCapFromFile(path string) (*BrowsCap, error)

func NewBrowsCapFromReader

func NewBrowsCapFromReader(reader io.Reader) (*BrowsCap, error)

func (*BrowsCap) GetBrowser

func (browscap *BrowsCap) GetBrowser(userAgent string) (browser *Browser, ok bool)

func (*BrowsCap) InitializedVersion

func (browscap *BrowsCap) InitializedVersion() string

type Browser

type Browser struct {
	Section string

	Browser         string
	BrowserVersion  string
	BrowserMajorVer string
	BrowserMinorVer string
	// Browser, Application, Bot/Crawler, Useragent Anonymizer, Offline Browser,
	// Multimedia Player, Library, Feed Reader, Email Client or unknown
	BrowserType string

	Platform        string
	PlatformShort   string
	PlatformVersion string

	// Mobile Phone, Mobile Device, Tablet, Desktop, TV Device, Console,
	// FonePad, Ebook Reader, Car Entertainment System or unknown
	DeviceType  string
	DeviceName  string
	DeviceBrand string

	Crawler string

	Cookies    string
	JavaScript string

	RenderingEngineName    string
	RenderingEngineVersion string
	// contains filtered or unexported fields
}

func GetBrowser

func GetBrowser(userAgent string) (browser *Browser, ok bool)

Deprecated: Use BrowsCap.GetBrowser

func (*Browser) IsAndroid

func (browser *Browser) IsAndroid() bool

func (*Browser) IsConsole

func (browser *Browser) IsConsole() bool

func (*Browser) IsCrawler

func (browser *Browser) IsCrawler() bool

func (*Browser) IsDesktop

func (browser *Browser) IsDesktop() bool

func (*Browser) IsIPad

func (browser *Browser) IsIPad() bool

func (*Browser) IsIPhone

func (browser *Browser) IsIPhone() bool

func (*Browser) IsMobile

func (browser *Browser) IsMobile() bool

func (*Browser) IsTablet

func (browser *Browser) IsTablet() bool

func (*Browser) IsTv

func (browser *Browser) IsTv() bool

func (*Browser) IsWinPhone

func (browser *Browser) IsWinPhone() bool

type Expression

type Expression []Token

func CompileExpression

func CompileExpression(s []byte) Expression

type ExpressionTree

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

func NewExpressionTree

func NewExpressionTree() *ExpressionTree

func (*ExpressionTree) Add

func (r *ExpressionTree) Add(name string, lineNum int)

func (*ExpressionTree) Find

func (r *ExpressionTree) Find(userAgent []byte) string

type Token

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

func (*Token) Equal

func (t *Token) Equal(t1 Token) bool

func (*Token) Fuzzy

func (t *Token) Fuzzy() bool

func (*Token) MatchOne

func (t *Token) MatchOne(r []byte) (bool, []byte)

func (*Token) Shard

func (t *Token) Shard() byte

func (*Token) String

func (t *Token) String() string

type Tokens

type Tokens []Token