init (#1)

* init

* handle empty case

Author: Ninroot

.gitignore

@@ -1,3 +1,11 @@
-*~
+# Editors
 *#
-*.dat
+*~
+.idea
+.vscode
+
+# OS
+.DS_Store
+
+# Database
+*.dat

LICENCE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [year] [fullname]
+Copyright (c) 2023 Dailymotion
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,33 +1,19 @@
-# Udger golang (format V3):
+# Udger Golang
 
-This package is a fork of github.com/udger/udger with the following changes:
-- Using golang regexp instead of github.com/glenn-brown/golang-pkg-pcre
-- Supporting partial UA parsing by constructor flags (device, browser, os)
+This package reads in memory all the database from [Udger](https://udger.com/) and lets you lookup for user agent's metadata. The parsing only relies on the golang standard library regex. Only the **Udger Data v3 - Sqlite3 format** is supported.   
 
-# Usage:
+This package is a fork of https://github.com/yoavfeld/udger itself forked from https://github.com/udger/udger.
 
-```
-package main
-
-import (
-  "github.com/yoavfeld/udger"
-)
-
-func main() {
-  client, err := udger.New("udgerDBv3FilePath", &udger.Flags{Device: true})
-  if err != nil {
-     log.Fatal(err)
-  }
-  ua := "Mozilla/5.0 (Linux; Android 4.4.4; MI PAD Build/KTU84P) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/33.0.0.0 Safari/537.36"
-  res,err := client.Lookup(ua)
-  if err != nil {
-    log.Fatal(err)
-  }
-}
+## Tests / Benchmarks
 
+To run tests and benchmarks you need to have the Udger database `udgerdb_v3.dat` located in this folder.
 
+To run unit tests  and run:
+```shell
+go tests ./...
 ```
 
-# Open issues:
-
-- Browser version is not supported since using golang regexp. it require a fix in findData func to support findDataWithVersion func
+To run tests with benchmarks:
+```shell
+go test -bench=.
+```

example/main.go

@@ -0,0 +1,14 @@
+module github.com/dailymotion-oss/udger
+
+go 1.20
+
+require (
+	github.com/mattn/go-sqlite3 v1.14.18
+	github.com/smartystreets/goconvey v1.8.1
+)
+
+require (
+	github.com/gopherjs/gopherjs v1.17.2 // indirect
+	github.com/jtolds/gls v4.20.0+incompatible // indirect
+	github.com/smarty/assertions v1.15.0 // indirect
+)

go.mod

@@ -0,0 +1,10 @@
+github.com/gopherjs/gopherjs v1.17.2 h1:fQnZVsXk8uxXIStYb0N4bGk7jeyTalG/wsZjQ25dO0g=
+github.com/gopherjs/gopherjs v1.17.2/go.mod h1:pRRIvn/QzFLrKfvEz3qUuEhtE/zLCWfreZ6J5gM2i+k=
+github.com/jtolds/gls v4.20.0+incompatible h1:xdiiI2gbIgH/gLH7ADydsJ1uDOEzR8yvV7C0MuV77Wo=
+github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU=
+github.com/mattn/go-sqlite3 v1.14.18 h1:JL0eqdCOq6DJVNPSvArO/bIV9/P7fbGrV00LZHc+5aI=
+github.com/mattn/go-sqlite3 v1.14.18/go.mod h1:2eHXhiwb8IkHr+BDWZGa96P6+rkvnG63S2DGjv9HUNg=
+github.com/smarty/assertions v1.15.0 h1:cR//PqUBUiQRakZWqBiFFQ9wb8emQGDb0HeGdqGByCY=
+github.com/smarty/assertions v1.15.0/go.mod h1:yABtdzeQs6l1brC900WlRNwj6ZR55d7B+E8C6HtKdec=
+github.com/smartystreets/goconvey v1.8.1 h1:qGjIddxOk4grTu9JPOU31tVfq3cNdBlNa5sSznIX1xY=
+github.com/smartystreets/goconvey v1.8.1/go.mod h1:+/u4qLyY6x1jReYOp7GOM2FSt8aP9CzCZL03bI28W60=

go.sum

@@ -18,7 +18,6 @@ type Udger struct {
 	Browsers     map[int]Browser
 	OS           map[int]OS
 	Devices      map[int]Device
-	Flags        *Flags
 }
 
 // Info is the struct returned by the Lookup(ua string) function, contains everything about the UA
@@ -28,7 +27,7 @@ type Info struct {
 	Device  Device  `json:"device"`
 }
 
-// Browser contains information about the browser type, engine and off course it's name
+// Browser contains information about the browser type, engine and off course its name
 type Browser struct {
 	Name    string `json:"name"`
 	Family  string `json:"family"`

types.go

@@ -8,29 +8,14 @@ import (
 	"strings"
 )
 
-type Flags struct {
-	browser bool
-	Device  bool
-	os      bool
-}
-
-// New creates a new instance of Udger and load all the database in memory to allow fast lookup
-// you need to pass the sqlite database in parameter
-func New(dbPath string, flags *Flags) (*Udger, error) {
-	if flags == nil {
-		flags = &Flags{
-			browser: true,
-			Device:  true,
-			os:      true,
-		}
-	}
+// New creates a new instance of Udger from the dbPath database loaded in memory for fast lookup.
+func New(dbPath string) (*Udger, error) {
 	u := &Udger{
 		Browsers:     make(map[int]Browser),
 		OS:           make(map[int]OS),
 		Devices:      make(map[int]Device),
 		browserTypes: make(map[int]string),
 		browserOS:    make(map[int]int),
-		Flags:        flags,
 	}
 	var err error
 
@@ -52,66 +37,57 @@ func New(dbPath string, flags *Flags) (*Udger, error) {
 	return u, nil
 }
 
-// Lookup one user agent and return a Info struct who contains all the metadata possible for the UA.
+// Lookup returns all the metadata possible for the given user agent string ua.
 func (udger *Udger) Lookup(ua string) (*Info, error) {
 	info := &Info{}
-	f := udger.Flags
 
-	var browserID int
-	if f.browser {
-		browserID, version, err := udger.findDataWithVersion(ua, udger.rexBrowsers, true)
-		if err != nil {
-			return nil, err
-		}
-		info.Browser = udger.Browsers[browserID]
+	browserID, browserVersion := udger.findDataWithVersion(ua, udger.rexBrowsers, true)
+	if browser, found := udger.Browsers[browserID]; found {
+		info.Browser = browser
 		if info.Browser.Family != "" {
-			info.Browser.Name = info.Browser.Family + " " + version
+			info.Browser.Name = browser.Family + " " + browserVersion
 		}
-		info.Browser.Version = version
-		info.Browser.Type = udger.browserTypes[info.Browser.typ]
+		info.Browser.Version = browserVersion
+		info.Browser.Type = udger.browserTypes[browser.typ]
+	} else {
+		info.Browser.typ = -1
 	}
 
-	if f.os {
-		if val, ok := udger.browserOS[browserID]; ok {
-			info.OS = udger.OS[val]
-		} else {
-			osID, _, err := udger.findData(ua, udger.rexOS, false)
-			if err != nil {
-				return nil, err
-			}
-			info.OS = udger.OS[osID]
-		}
+	if val, ok := udger.browserOS[browserID]; ok {
+		info.OS = udger.OS[val]
+	} else {
+		osID, _ := udger.findDataWithVersion(ua, udger.rexOS, false)
+		info.OS = udger.OS[osID]
 	}
 
-	if f.Device {
-		deviceID, _, err := udger.findData(ua, udger.rexDevices, false)
-		if err != nil {
-			return nil, err
+	deviceID, _ := udger.findDataWithVersion(ua, udger.rexDevices, false)
+
+	if val, ok := udger.Devices[deviceID]; ok {
+		info.Device = val
+	} else if info.Browser.typ == -1 { // empty
+		// pass
+	} else if info.Browser.typ == 3 { // if browser is mobile, we can guess it's a mobile
+		info.Device = Device{
+			Name: "Smartphone",
+			Icon: "phone.png",
 		}
-		if val, ok := udger.Devices[deviceID]; ok {
-			info.Device = val
-		} else if info.Browser.typ == 3 { // if browser is mobile, we can guess its a mobile
-			info.Device = Device{
-				Name: "Smartphone",
-				Icon: "phone.png",
-			}
-		} else if info.Browser.typ == 5 || info.Browser.typ == 10 || info.Browser.typ == 20 || info.Browser.typ == 50 {
-			info.Device = Device{
-				Name: "Other",
-				Icon: "other.png",
-			}
-		} else {
-			//nothing so personal computer
-			info.Device = Device{
-				Name: "Personal computer",
-				Icon: "desktop.png",
-			}
+	} else if info.Browser.typ == 5 || info.Browser.typ == 10 || info.Browser.typ == 20 || info.Browser.typ == 50 {
+		info.Device = Device{
+			Name: "Other",
+			Icon: "other.png",
+		}
+	} else {
+		//nothing so personal computer
+		info.Device = Device{
+			Name: "Personal computer",
+			Icon: "desktop.png",
 		}
 	}
 	return info, nil
 }
 
 func (udger *Udger) cleanRegex(r string) string {
+	// removes single-line and case-insensitive modifiers
 	if strings.HasSuffix(r, "/si") {
 		r = r[:len(r)-3]
 	}
@@ -122,47 +98,35 @@ func (udger *Udger) cleanRegex(r string) string {
 	return r
 }
 
-func (udger *Udger) findDataWithVersion(ua string, data []rexData, withVersion bool) (idx int, value string, err error) {
-	defer func() {
-		if r := recover(); r != nil {
-			idx, value, err = udger.findData(ua, data, false)
-		}
-	}()
-	idx, value, err = udger.findData(ua, data, withVersion)
-	return idx, value, err
-}
-
-func (udger *Udger) findData(ua string, data []rexData, withVersion bool) (idx int, value string, err error) {
+func (udger *Udger) findDataWithVersion(ua string, data []rexData, withVersion bool) (int, string) {
+	index := -1
+	version := ""
 	for i := 0; i < len(data); i++ {
 		r := data[i].RegexCompiled
 		if !r.MatchString(ua) {
 			continue
 		}
-		//TODO: implement with regexp lib for support browser version & name
-		//if withVersion && matcher.Present(1) {
-		//	return data[i].ID, matcher.GroupString(1), nil
-		//}
-		return data[i].ID, "", nil
+		index = data[i].ID
+		if withVersion {
+			sub := r.FindStringSubmatch(ua)
+			if len(sub) >= 2 {
+				version = sub[1]
+			}
+		}
+		break
 	}
-	return -1, "", nil
+	return index, version
 }
 
 func (udger *Udger) init() error {
-	f := udger.Flags
-	if f.browser {
-		if err := udger.initBrowsers(); err != nil {
-			return err
-		}
+	if err := udger.initBrowsers(); err != nil {
+		return err
 	}
-	if f.Device {
-		if err := udger.initDevices(); err != nil {
-			return err
-		}
+	if err := udger.initDevices(); err != nil {
+		return err
 	}
-	if f.os {
-		if err := udger.initOS(); err != nil {
-			return err
-		}
+	if err := udger.initOS(); err != nil {
+		return err
 	}
 	return nil
 }
@@ -176,6 +140,7 @@ func (udger *Udger) initBrowsers() error {
 		var d rexData
 		rows.Scan(&d.ID, &d.Regex)
 		d.Regex = udger.cleanRegex(d.Regex)
+		// set case-insensitive flag withing current group
 		r, err := regexp.Compile("(?i)" + d.Regex)
 		if err != nil {
 			return err
@@ -185,6 +150,7 @@ func (udger *Udger) initBrowsers() error {
 	}
 	rows.Close()
 
+	// Chrome, Safari, Firefox, etc.
 	rows, err = udger.db.Query("SELECT id, class_id, name,engine,vendor,icon FROM udger_client_list")
 	if err != nil {
 		return err
@@ -197,6 +163,7 @@ func (udger *Udger) initBrowsers() error {
 	}
 	rows.Close()
 
+	// browser, mobile, crawler, etc.
 	rows, err = udger.db.Query("SELECT id, client_classification FROM udger_client_class")
 	if err != nil {
 		return err