PHPackages performancehorizongroup/ua-parser - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. performancehorizongroup/ua-parser ActiveLibrary[Utility & Helpers](/categories/utility) performancehorizongroup/ua-parser ================================= A multi-language port of Browserscope's user agent parser. v0.3.4(11y ago)078.2k2MITJava Since Jan 27Pushed 11y ago27 watchersCompare [ Source](https://github.com/performanceHorizonGroup/ua-parser)[ Packagist](https://packagist.org/packages/performancehorizongroup/ua-parser)[ RSS](/packages/performancehorizongroup-ua-parser/feed)WikiDiscussions master Synced yesterday READMEChangelog (2)Dependencies (5)Versions (3)Used By (0) ua-parser [![Build Status](https://camo.githubusercontent.com/aafc169b92de9b7deff5b39e55a32ffa542e157dcaaa41809e5c218e9c4a9a1b/68747470733a2f2f7365637572652e7472617669732d63692e6f72672f746f6269652f75612d7061727365722e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/tobie/ua-parser) ==================================================================================================================================================================================================================================================================================================== [](#ua-parser-) `ua-parser` is a multi-language port of [BrowserScope](http://www.browserscope.org)'s [user agent string parser](http://code.google.com/p/ua-parser/). The crux of the original parser--the data collected by [Steve Souders](http://stevesouders.com/) over the years--has been extracted into a separate [YAML file](https://raw.github.com/tobie/ua-parser/master/regexes.yaml) so as to be reusable *as is* by implementations in other programming languages. `ua-parser` is just a small wrapper around this data. Maintainers ----------- [](#maintainers) - C#: [Søren Enemærke](https://github.com/enemaerke) ([@sorenenemaerke](https://twitter.com/sorenenemaerke)) - D: [Shripad K](https://github.com/shripadk) ([@24shri](https://twitter.com/24shri)) - Go: [Yihuan Zhou](https://github.com/yihuanz) ([@yihuanz](https://twitter.com/yihuanz)) - Haskell: [Ozgun Ataman](https://github.com/ozataman) ([@ozataman](https://twitter.com/ozataman)) - Java: [Steve Jiang](https://github.com/sjiang) ([@sjiang](https://twitter.com/sjiang)) - JavaScript: [Tobie Langel](https://github.com/tobie) ([@tobie](https://twitter.com/tobie)) - Perl: [Mamod Mehyar](https://github.com/mamod) ([@mamod](https://twitter.com/mamod)) - PHP: [Lars Strojny](https://github.com/lstrojny) ([@lstrojny](https://twitter.com/lstrojny)) - Pig: [Niels Basjes](https://github.com/nielsbasjes) ([@nielsbasjes](https://twitter.com/nielsbasjes)) - Python: [Lindsey Simon](https://github.com/elsigh) ([@elsigh](https://twitter.com/elsigh)) - `regexes.yaml`: Lindsey Simon & Tobie Langel irc channel ----------- [](#irc-channel) \#ua-parser on freenode. Contributing Changes to regexes.yaml ------------------------------------ [](#contributing-changes-to-regexesyaml) Please read the [contributors' guide](https://github.com/tobie/ua-parser/blob/master/CONTRIBUTING.md) Other ua-parser Libraries ------------------------- [](#other-ua-parser-libraries) There are a few other libraries which make use of ua-parser's patterns. These include: - Ruby - [user\_agent\_parser](https://github.com/toolmantim/user_agent_parser) Usage :: [node.js](http://nodejs.org) ------------------------------------- [](#usage--nodejs) ``` var r = require('ua-parser').parse(navigator.userAgent); console.log(r.ua.toString()); // -> "Safari 5.0.1" console.log(r.ua.toVersionString()); // -> "5.0.1" console.log(r.ua.family) // -> "Safari" console.log(r.ua.major); // -> "5" console.log(r.ua.minor); // -> "0" console.log(r.ua.patch); // -> "1" console.log(r.os.toString()); // -> "iOS 5.1" console.log(r.os.toVersionString()); // -> "5.1" console.log(r.os.family) // -> "iOS" console.log(r.os.major); // -> "5" console.log(r.os.minor); // -> "1" console.log(r.os.patch); // -> null console.log(r.device.family); // -> "iPhone" ``` Note if you're only interested in one of the `ua`, `device` or `os` objects, you will getter better performance by using the more specific methods (`uaParser.parseUA`, `uaParser.parseOS` and `uaParser.parseDevice` respectively), e.g.: ``` var p = require('ua-parser'); console.log(p.parseUA(navigator.userAgent).toString()); // -> "Safari 5.0.1" console.log(p.parseOS(navigator.userAgent).toString()); // -> "iOS 5.1" console.log(p.parseDevice(navigator.userAgent).toString()); // -> "iPhone" ``` Usage :: python --------------- [](#usage--python) You can install `ua-parser` by running: ``` pip install pyyaml ua-parser ``` And here's how to use it: ``` from ua_parser import user_agent_parser # On the server, you could use a WebOB request object. user_agent_string = request.META.get('HTTP_USER_AGENT') # For demonstration purposes, though an iPhone ... user_agent_string = 'Mozilla/5.0 (iPhone; CPU iPhone OS 5_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B179 Safari/7534.48.3' # Get back a big dictionary of all the goodies. result_dict = user_agent_parser.Parse(user_agent_string) print result_dict['user_agent'] # {'major': '5', 'minor': '1', 'family': 'Mobile Safari', 'patch': None} print result_dict['os'] # {'major': '5', 'patch_minor': None, 'minor': '1', 'family': 'iOS', 'patch': None} print result_dict['device'] # {'family': 'iPhone'} ``` Usage :: java ------------- [](#usage--java) ``` import ua_parser.Parser; import ua_parser.Client; ... String uaString = "Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B206 Safari/7534.48.3"; Parser uaParser = new Parser(); Client c = uaParser.parse(uaString); System.out.println(c.userAgent.family); // => "Mobile Safari" System.out.println(c.userAgent.major); // => "5" System.out.println(c.userAgent.minor); // => "1" System.out.println(c.os.family); // => "iOS" System.out.println(c.os.major); // => "5" System.out.println(c.os.minor); // => "1" System.out.println(c.device.family); // => "iPhone" ``` Usage :: Pig ------------ [](#usage--pig) For Pig there are UDFs for getting a single value and UDFs for getting a tuple with all values for either Device, Os of UserAgent. For most usecases the tuple UDFs will be the most useful. ``` REGISTER ua-parser-pig-0.1-SNAPSHOT-job.jar DEFINE Device ua_parser.pig.Device; DEFINE Os ua_parser.pig.Os; DEFINE UserAgent ua_parser.pig.UserAgent; UserAgents = Load 'useragents.txt' AS (useragent:chararray); AgentSpecs = FOREACH UserAgents GENERATE Device(useragent) AS Device, Os(useragent) AS Os, UserAgent(useragent) AS UserAgent, useragent AS Useragent; DESCRIBE AgentSpecs; DUMP AgentSpecs; ``` The versions that return only a single value: ``` REGISTER ua-parser-pig-0.1-SNAPSHOT-job.jar DEFINE DeviceFamily ua_parser.pig.device.Family; DEFINE OsFamily ua_parser.pig.os.Family; DEFINE OsMajor ua_parser.pig.os.Major; DEFINE OsMinor ua_parser.pig.os.Minor; DEFINE OsPatch ua_parser.pig.os.Patch; DEFINE OsPatchMinor ua_parser.pig.os.PatchMinor; DEFINE UseragentFamily ua_parser.pig.useragent.Family; DEFINE UseragentMajor ua_parser.pig.useragent.Major; DEFINE UseragentMinor ua_parser.pig.useragent.Minor; DEFINE UseragentPatch ua_parser.pig.useragent.Patch; UserAgents = Load 'useragents.txt' AS (useragent:chararray); AgentSpecs = FOREACH UserAgents GENERATE DeviceFamily(useragent) AS DeviceFamily:chararray, OsFamily(useragent) AS OsFamily:chararray, OsMajor(useragent) AS OsMajor:chararray, OsMinor(useragent) AS OsMinor:chararray, OsPatch(useragent) AS OsPatch:chararray, OsPatchMinor(useragent) AS OsPatchMinor:chararray, UseragentFamily(useragent) AS UseragentFamily:chararray, UseragentMajor(useragent) AS UseragentMajor:chararray, UseragentMinor(useragent) AS UseragentMinor:chararray, UseragentPatch(useragent) AS UseragentPatch:chararray, useragent AS Useragent; DUMP AgentSpecs; ``` Usage :: php ------------ [](#usage--php) ``` require_once 'vendor/autoload.php'; use UAParser\Parser; $ua = "Mozilla/5.0 (Macintosh; Intel Ma..."; $parser = Parser::create(); $result = $parser->parse($ua); print $result->ua->family; // Safari print $result->ua->major; // 6 print $result->ua->minor; // 0 print $result->ua->patch; // 2 print $result->ua->toString(); // Safari 6.0.2 print $result->ua->toVersion(); // 6.0.2 print $result->os->family; // Mac OS X print $result->os->major; // 10 print $result->os->minor; // 7 print $result->os->patch; // 5 print $result->os->patchMinor; // [null] print $result->os->toString(); // Mac OS X 10.7.5 print $result->os->toVersion(); // 10.7.5 print $result->device->family; // Other print $result->toString(); // Safari 6.0.2/Mac OS X 10.7.5 print $result->uaOriginal; // Mozilla/5.0 (Macintosh; Intel Ma... ``` [More information is available in the README](https://github.com/tobie/ua-parser/tree/master/php) in the PHP directory Usage :: D ---------- [](#usage--d) ``` import UaParser; import std.stdio; void main() { auto agent = UaParser.parse("Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B206 Safari/7534.48.3"); std.stdio.writeln(agent.browser.family); // Mobile Safari std.stdio.writeln(agent.browser.major); // 5 std.stdio.writeln(agent.browser.minor); // 1 std.stdio.writeln(agent.browser.patch); // 0 std.stdio.writeln(agent.browser.toString); // Mobile Safari 5.1.0 std.stdio.writeln(agent.browser.toVersionString); // 5.1.0 std.stdio.writeln(agent.os.family); // iOS std.stdio.writeln(agent.os.major); // 5 std.stdio.writeln(agent.os.minor); // 1 std.stdio.writeln(agent.os.patch); // 1 std.stdio.writeln(agent.os.toString); // iOS 5.1.1 std.stdio.writeln(agent.os.toVersionString); // 5.1.1 std.stdio.writeln(agent.toFullString); // Mobile Safari 5.1.0/iOS 5.1.1 std.stdio.writeln(agent.device.family); // iPhone std.stdio.writeln(agent.isMobile); // true std.stdio.writeln(agent.isSpider); // false } ``` Usage :: C# ----------- [](#usage--c) Install the NuGet package ``` Install-Package UAParser ``` Sample Usage: ``` using System; namespace UAParser.ConsoleApp { class Program { static void Main(string[] args) { String uaString = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_5; en-us) AppleWebKit/533.18.1 (KHTML, like Gecko) Version/5.0.2 Safari/533.18.5"; Parser uaParser = Parser.GetDefault(); ClientInfo c = uaParser.Parse(uaString); Console.WriteLine(c.UserAgent); //Safari 5.0.2 Console.WriteLine(c.OS); // Mac OS X 10.6.5 Console.WriteLine(c.Device); // Console.ReadLine(); } } } ``` Usage :: Perl ------------- [](#usage--perl) ``` use HTTP::UA::Parser; my $r = HTTP::UA::Parser->new(); print $r->ua->toString(); # -> "Safari 5.0.1" print $r->ua->toVersionString(); # -> "5.0.1" print $r->ua->family; # -> "Safari" print $r->ua->major; # -> "5" print $r->ua->minor; # -> "0" print $r->ua->patch; # -> "1" print $r->os->toString(); # -> "iOS 5.1" print $r->os->toVersionString(); # -> "5.1" print $r->os->family # -> "iOS" print $r->os->major; # -> "5" print $r->os->minor; # -> "1" print $r->os->patch; # -> undef print $r->device->family; # -> "iPhone" More information is available in the README in the perl directory ``` Usage :: Haskell ---------------- [](#usage--haskell) ``` {- Install via Hackage and cabal like so: cabal update cabal install ua-parser Now you're good to go. -} {-# LANGUAGE OverloadedStrings #-} module Main where import Web.UAParser -- A test string test_string = "Mozilla/5.0 (iPhone; CPU iPhone OS 5_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B179 Safari/7534.48.3" -- Main entry point for Haskell main = do ua