Merge branch 'master' into gh-pages

package.json

@@ -1,7 +1,7 @@
 {
   "title"       : "UA-Parser.js",
   "name"        : "ua-parser-js",
-  "version"     : "0.1.0",
+  "version"     : "0.3.0",
   "author"      : {
       "name"      : "Faisal Salman",
       "email"     : "fyzlman@gmail.com",
@@ -11,7 +11,10 @@
   "keywords"    : [
     "user-agent",
     "parser",
-    "browser"
+    "browser",
+    "engine",
+    "os",
+    "device"
   ],
   "homepage"    : "http://faisalman.github.com/ua-parser-js",
   "contributors": [
@@ -37,4 +40,4 @@
       "url"     : "http://www.opensource.org/licenses/mit-license.php" 
     }
   ]
-}
+}

readme.md

@@ -2,30 +2,45 @@
 
 JavaScript-based user-agent parser
 
-* Author	: Faisalman <<fyzlman@gmail.com>>
+* Author    : Faisalman <<fyzlman@gmail.com>>
-* Home	    : http://faisalman.github.com/ua-parser-js
+* Home      : http://faisalman.github.com/ua-parser-js
-* Source	: http://github.com/faisalman/ua-parser-js
+* Source	: https://github.com/faisalman/ua-parser-js
-* License	: GPLv2
+* License	: GPLv2 & MIT
 
 ## Features
 
-Get detailed type and version of web browser, layout engine, and operating system.
+Get detailed type and version of web browser, layout engine, operating system, and device.
+
+## Methods
+
+* `getBrowser([uastring])`
+* `getDevice([uastring])`
+* `getEngine([uastring])`
+* `getOS([uastring])`
+* `setUA(uastring)`
+
+## Properties
+
+* `result`
 
 ## Example
 
 ```html
 <script type="text/javascript" src="ua-parser.js"></script>
 <script type="text/javascript">
-
-    var parser = new uaparser(); // if no string given as parameter, by default it takes ua string from current window.navigator
     
-    console.log(parser);
+    // by default it takes ua string from current browser's window.navigator
+    console.log(UAParser.result);
     /*
         /// this will print an object structured like this:
         {
             browser: {
                 name: "",
-                major: "",
+                version: "",
+                major: ""
+            },
+            device: {
+                name: "",
                 version: ""
             },
             engine: {
@@ -35,24 +50,42 @@ Get detailed type and version of web browser, layout engine, and operating syste
             os: {
                 name: "",
                 version: ""
+            },
+            device: {
+                name: "",
+                version: ""
             }
         }
     */
 
     // let's test a custom user-agent string as an example
-    parser.ua = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.2 (KHTML, like Gecko) Ubuntu/11.10 Chromium/15.0.874.106 Chrome/15.0.874.106 Safari/535.2";
+    var uastr = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.2 (KHTML, like Gecko) Ubuntu/11.10 Chromium/15.0.874.106 Chrome/15.0.874.106 Safari/535.2";
+    UAParser.setUA(uastr);
     
-    var browser = parser.getBrowser();
+    console.log(UAParser.result.browser);  // {name: "Chromium", major: "15", version: "15.0.874.106"}
-    var engine = parser.getEngine();
+    console.log(UAParser.result.engine);   // {name: "AppleWebKit", version: "535.2"}
-    var os = parser.getOS();
+    console.log(UAParser.result.os);       // {name: "Ubuntu", version: "11.10"}
-    
-    console.log(browser); // {name: "Chromium", major: "15", version: "15.0.874.106"}
-    console.log(engine); // {name: "AppleWebKit", version: "535.2"}
-    console.log(os); // {name: "Ubuntu", version: "11.10"}
     
+    // let's take another test please
+    UAParser.setUA("Mozilla/5.0 (compatible; Konqueror/4.1; OpenBSD) KHTML/4.1.4 (like Gecko)").getOS().name; // prints "OpenBSD"
 </script>
 ```
 
+## Using node.js
+
+```js
+var parser = require('ua-parser');
+
+var ua1 = 'Mozilla/5.0 (PlayBook; U; RIM Tablet OS 1.0.0; en-US) AppleWebKit/534.11 (KHTML, like Gecko) Version/7.1.0.7 Safari/534.11';
+var ua2 = 'Midori/0.2 (X11; Linux; U; cs-cz) WebKit/531.2+';
+
+parser.setUA(ua1).getDevice().name; // prints "PlayBook"
+parser.getOS()                      // prints {name: "RIM Tablet OS", version: "1.0.0"}
+parser.getOS(ua2)                   // prints {name: "Linux", version: undefined}
+parser.getOS()                      // prints {name: "RIM Tablet OS", version: "1.0.0"}
+parser.getEngine().name;            // prints "AppleWebKit"
+```
+
 ## License
 
 Copyright © 2012 Faisalman <<fyzlman@gmail.com>>

ua-parser.js

@@ -1,167 +1,235 @@
-// UA-Parser.js v0.1.1
+// UA-Parser.js v0.3.0
 // Lightweight JavaScript-based user-agent parser
 // https://github.com/faisalman/ua-parser-js
 //
 // Copyright © 2012 Faisalman
-// Licensed under GPLv2
+// Licensed under GPLv2 & MIT
 
-function uaparser (uastring) {
+(function () {
+    function UAParser (uastring) {
 
-    // regexp mapper
+        var ua = uastring || typeof window !== 'undefined' ? window.navigator.userAgent : "";
-    var regxMap = function (ua) {
+
-        var result;
+        // regexp mapper
-        var i, j, k, l;
+        var regxMap = function (ua) {
-        for (i = 1; i < arguments.length; i += 2) {
+            var result;
-            var regex = arguments[i];
+            var i, j, k, l;
-            var props = arguments[i + 1];
+            for (i = 1; i < arguments.length; i += 2) {
-            var isMatch = false;
+                var regex = arguments[i];
-            for (j = 0; j < regex.length; j++) {
+                var props = arguments[i + 1];
-                var match = regex[j].exec(ua);
+                var isMatchFound = false;
-                //console.log(match);
+                for (j = 0; j < regex.length; j++) {
-                if (!!match) {
+                    var match = regex[j].exec(ua);
-                    result = {};
+                    //console.log(match);
-                    l = 1;
+                    if (!!match) {
-                    for (k = 0; k < props.length; k++) {
+                        result = {};
-                        if (typeof props[k] === 'object' && props[k].length === 2) {
+                        l = 1;
-                            result[props[k][0]] = props[k][1];
+                        for (k = 0; k < props.length; k++) {
-                            l -= 1;
+                            if (typeof props[k] === 'object' && props[k].length === 2) {
-                        } else if (typeof props[k] === 'object' && props[k].length === 3) {
+                                result[props[k][0]] = props[k][1];
-                            result[props[k][0]] = (!!match[k + l]) ? match[k + l].replace(props[k][1], props[k][2]) : 'unknown';
+                                l -= 1;
-                        } else {
+                            } else if (typeof props[k] === 'object' && props[k].length === 3) {
-                            result[props[k]] = (!!match[k + l]) ? match[k + l] : 'unknown';
+                                result[props[k][0]] = (!!match[k + l]) ? match[k + l].replace(props[k][1], props[k][2]) : undefined;
+                            } else {
+                                result[props[k]] = (!!match[k + l]) ? match[k + l] : undefined;
+                            }
                         }
-                    };
+                        isMatchFound = true;
-                    isMatch = true;
+                        break;
-                    break;
-                }
-            };
-            if (!isMatch) {
-                result = {};
-                for (j in props) {
-                    if (props.hasOwnProperty(j)) {
-                    result[props[j]] = 'unknown';
                     }
-                };
+                }
-            } else {
+                if (!isMatchFound) {
-                break;
+                    result = {};
+                    for (k in props) {
+                        if (props.hasOwnProperty(k)) {
+                            if (typeof props[k] == 'object') {
+                                result[props[k][0]] = undefined;
+                            } else {
+                                result[props[k]] = undefined;
+                            }
+                        }
+                    }
+                } else {
+                    return result;
+                }
+            }
+            return result;
+        };
+
+        var mapper = {
+            os : {        
+                win: function (str, match) {
+                    switch (match.toLowerCase()) {
+                        case 'nt 5.0':
+                            return '2000';
+                        case 'nt 5.1':
+                        case 'nt 5.2':
+                            return 'XP';
+                        case 'nt 6.0':
+                            return 'Vista';
+                        case 'nt 6.1':
+                            return '7';
+                        case 'nt 6.2':
+                            return '8';
+                        default:
+                            return match;
+                    };
+                }
             }
         };
-        return result;
-    };
 
-    var mapper = {
+        this.getBrowser = function (uastring) {
-        win: function (str, match) {
+
-            switch (match.toLowerCase()) {
+            return regxMap(uastring || ua, [
-                case 'nt 5.0':
+
-                    return '2000';
+                // Mixed
-                case 'nt 5.1':
+                /(kindle)\/((\d+)?[\w\.]+)/i,                                       // Kindle
-                case 'nt 5.2':
+                /(lunascape|maxthon|netfront|jasmine)[\/\s]?((\d+)?[\w\.]+)/i,      // Lunascape/Maxthon/Netfront/Jasmine
-                    return 'XP';
+                
-                case 'nt 6.0':
+                // Presto based
-                    return 'Vista';
+                /(opera\smini)\/((\d+)?[\w\.-]+)/i,                                 // Opera Mini
-                case 'nt 6.1':
+                /(opera\smobi)\/((\d+)?[\w\.-]+)/i,                                 // Opera Mobile
-                    return '7';
+                /(opera).*\/((\d+)?[\w\.]+)/i,                                      // Opera
-                case 'nt 6.2':
+
-                    return '8';
+                // Trident based
-                default:
+                /(avant\sbrowser|iemobile|slimbrowser)[\/\s]?((\d+)?[\w\.]*)/i,     // Avant/IEMobile/SlimBrowser
-                    return match;
+                /ms(ie)\s((\d+)?[\w\.]+)/i,                                         // Internet Explorer
+
+                // Webkit/KHTML based
+                /(chromium|flock|rockmelt|midori|epiphany)\/((\d+)?[\w\.]+)/i,      // Chromium/Flock/RockMelt/Midori/Epiphany
+                /(chrome|omniweb|arora|dolfin)\/((\d+)?[\w\.]+)/i,                  // Chrome/OmniWeb/Arora/Dolphin
+                ], ['name', 'version', 'major'], [
+                /(?:android.+crmo|crios)\/((\d+)?[\w\.]+)/i,                        // Chrome for Android/iOS
+                ], [['name', 'Chrome'], 'version', 'major'], [
+                /(mobile\ssafari|safari|konqueror)\/((\d+)?[\w\.]+)/i,              // Safari/Konqueror
+                /(applewebkit|khtml)\/((\d+)?[\w\.]+)/i,
+
+                // Gecko based
+                /(iceweasel|camino|fennec|maemo|minimo)[\/\s]?((\d+)?[\w\.\+]+)/i,  // Iceweasel/Camino/Fennec/Maemo/Minimo
+                /(firefox|seamonkey|netscape|navigator|k-meleon|icecat|iceape)\/((\d+)?[\w\.]+)/i,
+                                                                                    // Firefox/SeaMonkey/Netscape/K-Meleon/IceCat/IceApe
+                /(mozilla)\/([\w\.]+).+rv\:.+gecko\/\d+/i,                          // Mozilla
+
+                // Other
+                /(lynx|dillo|icab)[\/\s]?((\d+)?[\w\.]+)/i,                         // Lynx/Dillo/iCab
+                ], ['name', 'version', 'major']);  
+        };
+
+        this.getEngine = function (uastring) {
+
+            return regxMap(uastring || ua, [
+
+                /(presto)\/([\w\.]+)/i,                                             // Presto
+                /([aple]*webkit|trident)\/([\w\.]+)/i,                              // Webkit/Trident
+                /(khtml)\/([\w\.]+)/i                                               // KHTML
+                ], ['name', 'version'], [
+
+                /rv\:([\w\.]+).*(gecko)/i                                           // Gecko
+                ], ['version', 'name']);
+        };
+
+        this.getOS = function (uastring) { 
+
+            return regxMap(uastring || ua, [
+
+                // Windows based
+                /(windows\sphone\sos|windows)\s+([\w\.\s]+)*/i,                     // Windows
+                ], ['name', ['version', /(nt\s[\d\.]+)/gi, mapper.os.win]], [
+
+                // Mobile/Embedded OS
+                /(blackberry).+version\/([\w\.]+)/i,                                // Blackberry
+                /(android|symbianos|symbos|webos|palm\os|qnx|bada|rim\stablet\sos)[\/\s-]?([\w\.]+)*/i,
+                                                                                    // Android/Symbian/WebOS/Palm/QNX/Bada/RIM
+                /(nintendo|playstation)\s([wids3portable]+)/i,                      // Nintendo/Playstation
+
+                // GNU/Linux based
+                /(mint)[\/\s\(]?(\w+)*/i,                                           // Mint
+                /(joli|[kxln]?ubuntu|debian|[open]*suse|gentoo|arch|slackware|fedora|mandriva|centos|pclinuxos|redhat|zenwalk)[\/\s-]?([\w\.-]+)*/i,
+                                                                                    // Joli/Ubuntu/Debian/SUSE/Gentoo/Arch/Slackware
+                                                                                    // Fedora/Mandriva/CentOS/PCLinuxOS/RedHat/Zenwalk
+                /(gnu|linux)\s?([\w\.]+)*/i                                         // Other GNU/Linux
+                ], ['name', 'version'], [
+
+                /cros\s([\w\.\s]+)/i                                                // Chromium OS
+                ], [['name', 'Chromium OS'], 'version'],[
+
+                // Solaris
+                /sunos\s?([\w\.\s]+)*/i                                             // Solaris
+                ], [['name', 'Solaris'], 'version'], [
+
+                // BSD based
+                /\s(\w*bsd|dragonfly)\s?([\w\.]+)*/i,                               // FreeBSD/NetBSD/OpenBSD/DragonFly
+                ], ['name', 'version'],[
+
+                /(ip[honead]+).*os\s*([\w]+)*\slike\smac/i                          // iOS
+                ], [['name', /.+/g, 'iOS'], ['version', /_/g, '.']], [
+
+                /(mac\sos)\sx\s([\w\s\.]+)/i,                                       // Mac OS
+                ], ['name', ['version', /_/g, '.']], [
+
+                // Other
+                /(macintosh|unix|minix|beos)[\/\s]?()*/i
+                ], ['name', 'version']);
+        };
+
+        this.getDevice = function (uastring) { 
+
+            return regxMap(uastring || ua, [
+
+                /\((ip[honead]+|playbook);/i,                                       // iPod/iPhone/iPad/PlayBook
+                /(blackberry)[\s-]?(\w+)/i,                                         // BlackBerry
+                /(blackberry|benq|nokia|palm(?=\-)|sonyericsson|acer|asus|dell|nexus|zte)[\s_-]?([\w-]+)*/i,  
+                                                                                    // BenQ/Nokia/Palm/Sony-Ericsson/Acer/Asus/Dell/Nexus/ZTE
+                /(hp)\s([\w\s]+)/i,                                                 // HP iPAQ
+                /(hp).+(touchpad)/i,                                                // HP TouchPad
+                /(kindle)\/([\w\.]+)/i,                                             // Kindle
+                /(lg)[e;\s-]+(\w+)*/i,                                              // LG
+                /(nintendo|playstation)\s([wids3portable]+)/i                       // Nintendo/Playstation
+                ], ['name', 'version'], [
+                
+                /(htc)[;_\s-]+([\w\s]+(?=\))|[\w]+)*/i,                             // HTC
+                /(zte)-([\w]+)*/i
+                ], ['name', ['version', /_/g, ' ']], [
+                            
+                /\s(milestone|mz601|droid[2x]?|xoom)[globa\s]*\sbuild\//i,          // Motorola
+                /mot[\s-]?(\w+)*/i
+                ], [['name', 'Motorola'], 'version'], [
+                
+                /(s[cgp]h-\w+|gt-\w+|galaxy\snexus)/i,                              // Samsung
+                /sam[sung]*[\s-]*(\w+-?[\w-]*)*/i,
+                /sec-(sgh\w+)/i
+                ], [['name', 'Samsung'], 'version'], [
+                
+                /(transfo[prime\s]{4,10}\s\w+|(?:android).*eeepc)/i                 // Asus
+                ], [['name', 'Asus'], 'version'], [
+
+                /sie-(\w+)*/i                                                       // Siemens
+                ], [['name', 'Siemens'], 'version']);
+        };
+
+        this.setUA = function (uastring) {
+            ua = uastring || ua;
+            this.result = {
+                browser : this.getBrowser(),
+                engine  : this.getEngine(),
+                os      : this.getOS(),
+                device  : this.getDevice()
             };
+            return this;
+        };
+
+        this.setUA(ua);
+    };
+    
+    var parser = new UAParser();
+    
+    // check whether script is running inside node.js export as module
+    if (typeof exports !== 'undefined' && this.toString() !== '[object DOMWindow]') {
+        if (typeof module !== 'undefined' && module.exports) {
+            exports = module.exports = parser;
         }
-    };
+        exports.UAParser = parser;
-
+    } else {
-    this.ua = uastring || window.navigator.userAgent;
+        this['UAParser'] = parser;
-
+    }
-    this.getBrowser = function() {
+})();
-
-        return regxMap(this.ua, [
-
-            // Mixed
-            /(kindle)\/((\d+)?[\w\.]+)/i,                                       // Kindle
-            /(lunpropsape|maxthon|netfront|jasmine)[\/\s]?((\d+)?[\w\.]+)/i,    // Lunpropsape/Maxthon/Netfront/Jasmine
-            
-            // Presto based
-            /(opera\smini)\/((\d+)?[\w\.-]+)/i,                                 // Opera Mini
-            /(opera\smobi)\/((\d+)?[\w\.-]+)/i,                                 // Opera Mobile
-            /(opera).*\/((\d+)?[\w\.]+)/i,                                      // Opera
-
-            // Trident based
-            /(avant\sbrowser|iemobile|slimbrowser)[\/\s]?((\d+)?[\w\.]*)/i,     // Avant/IEMobile/SlimBrowser
-            /ms(ie)\s((\d+)?[\w\.]+)/i,                                         // Internet Explorer
-
-            // Webkit/KHTML based
-            /(chromium|flock|rockmelt|midori|epiphany)\/((\d+)?[\w\.]+)/i,      // Chromium/Flock/RockMelt/Midori/Epiphany
-            /(chrome|omniweb|arora|dolfin)\/((\d+)?[\w\.]+)/i,                  // Chrome/OmniWeb/Arora/Dolphin
-            ], ['name', 'version', 'major'], [
-            /android.+(crmo)\/((\d+)?[\w\.]+)/i,                                // Chrome for Android
-            ], [['name', /.+/g, 'Chrome'], 'version', 'major'], [
-            /(mobile\ssafari|safari|konqueror)\/((\d+)?[\w\.]+)/i,              // Safari/Konqueror
-            /(applewebkit|khtml)\/((\d+)?[\w\.]+)/i,
-
-            // Gecko based
-            /(iceweasel|camino|fennec|maemo|minimo)[\/\s]?((\d+)?[\w\.\+]+)/i,  // Iceweasel/Camino/Fennec/Maemo/Minimo
-            /(firefox|seamonkey|netscape|navigator|k-meleon|icecat|iceape)\/((\d+)?[\w\.]+)/i,
-                                                                                // Firefox/SeaMonkey/Netscape/K-Meleon/IceCat/IceApe
-            /(mozilla)\/([\w\.]+).+rv\:.+gecko\/\d+/i,                          // Mozilla
-
-            // Other
-            /(lynx|dillo|icab)[\/\s]?((\d+)?[\w\.]+)/i,                         // Lynx/Dillo/iCab
-            ], ['name', 'version', 'major']);  
-    };
-
-    this.getEngine = function() {
-
-        return regxMap(this.ua, [
-
-            /(presto)\/([\w\.]+)/i,                                             // Presto
-            /([aple]*webkit|trident)\/([\w\.]+)/i,                              // Webkit/Trident
-            /(khtml)\/([\w\.]+)/i                                               // KHTML
-            ], ['name', 'version'], [
-
-            /rv\:([\w\.]+).*(gecko)/i                                           // Gecko
-            ], ['version', 'name']);
-    };
-
-    this.getOS = function() { 
-
-        return regxMap(this.ua, [
-
-            // Windows based
-            /(windows\sphone\sos|windows)\s+([\w\.\s]+)*/i,                     // Windows
-            ], ['name', ['version', /(nt\s[\d\.]+)/gi, mapper.win]], [
-
-            // Mobile/Embedded OS
-            /(blackberry).+version\/([\w\.]+)/i,                                // Blackberry
-            /(android|symbianos|symbos|webos|palm\os|qnx|bada|rim\stablet\sos)[\/\s-]?([\w\.]+)*/i,
-                                                                                // Android/Symbian/WebOS/Palm/QNX/Bada/RIM
-            /(nintendo|playstation)\s([wids3portable]+)/i,                      // Nintendo/Playstation
-
-            // GNU/Linux based
-            /(mint)[\/\s\(]?(\w+)*/i,                                           // Mint
-            /(joli|[kxln]?ubuntu|debian|[open]*suse|gentoo|arch|slackware|fedora|mandriva|centos|pclinuxos|redhat|zenwalk)[\/\s-]?([\w\.-]+)*/i,
-                                                                                // Joli/Ubuntu/Debian/SUSE/Gentoo/Arch/Slackware
-                                                                                // Fedora/Mandriva/CentOS/PCLinuxOS/RedHat/Zenwalk
-            /(gnu|linux)\s?([\w\.]+)*/i                                         // Other GNU/Linux
-            ], ['name', 'version'], [
-
-            /cros\s([\w\.\s]+)/i                                                // Chromium OS
-            ], [['name', 'Chromium OS'], 'version'],[
-
-            // Solaris
-            /sunos\s?([\w\.\s]+)*/i                                             // Solaris
-            ], [['name', 'Solaris'], 'version'], [
-
-            // BSD based
-            /\s(\w*bsd|dragonfly)\s?([\w\.]+)*/i,                               // FreeBSD/NetBSD/OpenBSD/DragonFly
-            ], ['name', 'version'],[
-
-            /(ip[honead]+).*os\s*([\w]+)*\slike\smac/i                          // iOS
-            ], [['name', /.+/g, 'iOS'], ['version', /_/g, '.']], [
-
-            /(mac\sos)\sx\s([\w\s\.]+)/i,                                       // Mac OS
-            ], ['name', ['version', /_/g, '.']], [
-
-            // Other
-            /(macintosh|unix|minix|beos)[\/\s]?()*/i
-            ], ['name', 'version']);
-    };
-};