Compare commits

..

6 Commits

Author SHA1 Message Date
Faisal Salman
65703e7c1a Move regexMapper & maps outside UAParser class 2012-09-15 01:33:38 +07:00
Faisal Salman
064d52255f Remove optional argument from all getters 2012-09-15 01:15:02 +07:00
Faisal Salman
71b5300080 Replace UAParser.result object with UAParser.getResult() 2012-09-15 01:09:28 +07:00
Faisal Salman
e41fa1c829 Modify mapper method 2012-09-14 05:11:08 +07:00
Faisal Salman
7cd76a3fba Fix Opera, Add match for replacement 2012-09-14 04:23:48 +07:00
Faisal Salman
ac1f92d3c6 Change license paragraph in readme from GPL2 to MIT 2012-09-14 02:42:11 +07:00
3 changed files with 143 additions and 125 deletions

View File

@@ -1,7 +1,7 @@
{ {
"title": "UA-Parser.js", "title": "UA-Parser.JS",
"name": "ua-parser-js", "name": "ua-parser-js",
"version": "0.3.2", "version": "0.3.4",
"author": "Faisal Salman <fyzlman@gmail.com> (http://faisalman.com)", "author": "Faisal Salman <fyzlman@gmail.com> (http://faisalman.com)",
"description": "Lightweight JavaScript-based user-agent string parser", "description": "Lightweight JavaScript-based user-agent string parser",
"keywords": [ "keywords": [

View File

@@ -1,6 +1,6 @@
# UA-Parser.js # UA-Parser.JS
Light-weight JavaScript-based all-in-one user-agent parser Lightweight JavaScript-based User-Agent string 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
@@ -9,20 +9,18 @@ Light-weight JavaScript-based all-in-one user-agent parser
## Features ## Features
Get detailed type and version of web browser, layout engine, operating system, and device. Extract detailed type of web browser, layout engine, operating system, and device purely from user-agent string.
## Methods ## Methods
* `getBrowser([uastring])` * `getBrowser()`
* `getDevice([uastring])` * `getDevice()`
* `getEngine([uastring])` * `getEngine()`
* `getOS([uastring])` * `getOS()`
* `getResult()`
* `getUA()`
* `setUA(uastring)` * `setUA(uastring)`
## Properties
* `result`
## Example ## Example
```html ```html
@@ -31,8 +29,8 @@ Get detailed type and version of web browser, layout engine, operating system, a
var parser = new UAParser(); var parser = new UAParser();
// by default it takes ua string from current browser's window.navigator // by default it takes ua string from current browser's window.navigator.userAgent
console.log(parser.result); console.log(parser.getResult());
/* /*
/// this will print an object structured like this: /// this will print an object structured like this:
{ {
@@ -60,9 +58,9 @@ Get detailed type and version of web browser, layout engine, operating system, a
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"; 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";
parser.setUA(uastr); parser.setUA(uastr);
console.log(parser.result.browser); // {name: "Chromium", major: "15", version: "15.0.874.106"} console.log(parser.getResult().browser); // {name: "Chromium", major: "15", version: "15.0.874.106"}
console.log(parser.result.engine); // {name: "AppleWebKit", version: "535.2"} console.log(parser.getResult().engine); // {name: "AppleWebKit", version: "535.2"}
console.log(parser.result.os); // {name: "Ubuntu", version: "11.10"} console.log(parser.getResult().os); // {name: "Ubuntu", version: "11.10"}
// let's take another test please // let's take another test please
console.log(parser.setUA("Mozilla/5.0 (compatible; Konqueror/4.1; OpenBSD) KHTML/4.1.4 (like Gecko)").getOS().name); // "OpenBSD" console.log(parser.setUA("Mozilla/5.0 (compatible; Konqueror/4.1; OpenBSD) KHTML/4.1.4 (like Gecko)").getOS().name); // "OpenBSD"
@@ -77,23 +75,23 @@ var parser = new UAParser();
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 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+'; var ua2 = 'Midori/0.2 (X11; Linux; U; cs-cz) WebKit/531.2+';
parser.setUA(ua1).getDevice().name; // "PlayBook" console.log(parser.setUA(ua1).getDevice().name); // "PlayBook"
parser.getOS() // {name: "RIM Tablet OS", version: "1.0.0"} console.log(parser.getOS()) // {name: "RIM Tablet OS", version: "1.0.0"}
parser.getOS(ua2) // {name: "Linux", version: undefined} console.log(parser.getOS(ua2)) // {name: "Linux", version: undefined}
parser.getOS() // {name: "RIM Tablet OS", version: "1.0.0"} console.log(parser.getOS()) // {name: "RIM Tablet OS", version: "1.0.0"}
parser.getEngine().name; // "AppleWebKit" console.log(parser.getEngine().name); // "AppleWebKit"
``` ```
## License ## License
Copyright © 2012 Faisalman <<fyzlman@gmail.com>> Copyright © 2012 Faisalman <<fyzlman@gmail.com>>
This program is free software; you can redistribute it and/or Permission is hereby granted, free of charge, to any person obtaining a copy of
modify it under the terms of the GNU General Public License this software and associated documentation files (the "Software"), to deal in
as published by the Free Software Foundation; either version 2 the Software without restriction, including without limitation the rights to use,
of the License, or (at your option) any later version. 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:
This program is distributed in the hope that it will be useful, The above copyright notice and this permission notice shall be included in all
but WITHOUT ANY WARRANTY; without even the implied warranty of copies or substantial portions of the Software.
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

View File

@@ -1,4 +1,4 @@
// UA-Parser.js v0.3.2 // UA-Parser.JS v0.3.4
// Lightweight JavaScript-based User-Agent string parser // Lightweight JavaScript-based User-Agent string parser
// https://github.com/faisalman/ua-parser-js // https://github.com/faisalman/ua-parser-js
// //
@@ -6,75 +6,91 @@
// Dual licensed under GPLv2 & MIT // Dual licensed under GPLv2 & MIT
(function (undefined) { (function (undefined) {
var parser = function UAParser (uastring) {
var regexMapper = function (ua, args) {
var result = {}, i, j, k, l, m;
// loop through all regexes maps
for (i = 1; i < arguments.length; i += 2) {
var regex = arguments[i], // even sequence (1,3,5,..)
props = arguments[i + 1]; // odd sequence (2,4,6,..)
// build object barebones
for (k = 0; k < props.length; k++) {
if (typeof props[k] == 'object') {
result[props[k][0]] = undefined;
} else {
result[props[k]] = undefined;
}
}
// try matching uastring with regexes
for (j = 0; j < regex.length; j++) {
l = regex[j].exec(ua);
if (!!l) {
for (k = 0; k < props.length; k++) {
m = l[k + 1];
if (typeof props[k] === 'object' && props[k].length === 2) {
result[props[k][0]] = props[k][1];
} else if (typeof props[k] === 'object' && props[k].length === 3) {
result[props[k][0]] = m ? m.replace(props[k][1], props[k][2]) : undefined;
} else {
result[props[k]] = m ? m : undefined;
}
}
break;
}
}
if(!!l) break; // break the loop immediately if match found
}
return result;
};
var maps = {
check : function(str, map){
for (var i in map){
if (map.hasOwnProperty(i)) {
if (typeof map[i] === 'object' && map[i].length > 0) {
for (var j = 0; j < map[i].length; j++) {
if (str.toLowerCase().indexOf(map[i][j]) !== -1) {
return i;
}
}
} else if (str.toLowerCase().indexOf(map[i]) !== -1) {
return i;
}
}
}
return str;
},
os : {
win : function (match, str1) {
return maps.check(str1, {
'ME' : '4.90',
'NT 3.11' : 'nt3.51',
'NT 4.0' : 'nt4.0',
'2000' : 'nt 5.0',
'XP' : ['nt 5.1', 'nt 5.2'],
'Vista' : 'nt 6.0',
'7' : 'nt 6.1',
'8' : 'nt 6.2'
});
}
}
};
var UAParser = function UAParser (uastring) {
var ua = uastring || (typeof window !== 'undefined' ? window.navigator.userAgent : ""); var ua = uastring || (typeof window !== 'undefined' ? window.navigator.userAgent : "");
// regexp mapper this.getBrowser = function () {
var regxMap = function (ua) {
var result = {}, i, j, k, l;
for (i = 1; i < arguments.length; i += 2) {
var regex = arguments[i], // odd sequence (2,4,6,..)
props = arguments[i + 1]; // even sequence (3,5,7,..)
for (k = 0; k < props.length; k++) {
if (typeof props[k] == 'object') {
result[props[k][0]] = undefined;
} else {
result[props[k]] = undefined;
}
}
for (j = 0; j < regex.length; j++) {
var match = regex[j].exec(ua);
if (!!match) {
l = 1;
for (k = 0; k < props.length; k++) {
if (typeof props[k] === 'object' && props[k].length === 2) {
result[props[k][0]] = props[k][1];
l -= 1;
} else if (typeof props[k] === 'object' && props[k].length === 3) {
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;
}
}
break;
}
}
if(!!l) break; // break the loop if match found
}
return result;
};
var mapper = { return regexMapper(ua, [
check: function(str, map){
for (var i = 0; i < map.length; i++) {
if (str.toLowerCase().indexOf(map[i][0]) !== -1) {
return map[i][1];
}
}
return str;
},
os : {
win: function (match, str1) {
var map = [
['4.90', 'ME'],
['nt3.51', 'NT 3.11'],
['nt4.0', 'NT 4.0'],
['nt 5.0', '2000'],
['nt 5.1', 'XP'],
['nt 5.2', 'XP'],
['nt 6.0', 'Vista'],
['nt 6.1', '7'],
['nt 6.2', '8'],
];
return mapper.check(str1, map);
}
}
};
this.getBrowser = function (uastring) {
return regxMap(uastring || ua, [
// Mixed // Mixed
/(kindle)\/((\d+)?[\w\.]+)/i, // Kindle /(kindle)\/((\d+)?[\w\.]+)/i, // Kindle
@@ -83,8 +99,9 @@
// Presto based // Presto based
/(opera\smini)\/((\d+)?[\w\.-]+)/i, // Opera Mini /(opera\smini)\/((\d+)?[\w\.-]+)/i, // Opera Mini
/(opera\smobi)\/((\d+)?[\w\.-]+)/i, // Opera Mobile /(opera\smobi)\/((\d+)?[\w\.-]+)/i, // Opera Mobile
/(opera).*\/((\d+)?[\w\.]+)/i, // Opera /(opera).+version\/((\d+)?[\w\.]+)/i, // Opera
/(opera)[\/\s]+((\d+)?[\w\.]+)/i,
// Trident based // Trident based
/(avant\sbrowser|iemobile|slimbrowser)[\/\s]?((\d+)?[\w\.]*)/i, // Avant/IEMobile/SlimBrowser /(avant\sbrowser|iemobile|slimbrowser)[\/\s]?((\d+)?[\w\.]*)/i, // Avant/IEMobile/SlimBrowser
/ms(ie)\s((\d+)?[\w\.]+)/i, // Internet Explorer /ms(ie)\s((\d+)?[\w\.]+)/i, // Internet Explorer
@@ -94,7 +111,7 @@
/(chrome|omniweb|arora|dolfin|[tizenaok]{5}\s?browser)\/((\d+)?[\w\.]+)/i, /(chrome|omniweb|arora|dolfin|[tizenaok]{5}\s?browser)\/((\d+)?[\w\.]+)/i,
// Chrome/OmniWeb/Arora/Dolphin/Tizen/Nokia // Chrome/OmniWeb/Arora/Dolphin/Tizen/Nokia
], ['name', 'version', 'major'], [ ], ['name', 'version', 'major'], [
/(?:android.+crmo|crios)\/((\d+)?[\w\.]+)/i, // Chrome for Android/iOS /(?:android.+(crmo|crios))\/((\d+)?[\w\.]+)/i, // Chrome for Android/iOS
], [['name', 'Chrome'], 'version', 'major'], [ ], [['name', 'Chrome'], 'version', 'major'], [
/(mobile\ssafari|safari|konqueror)\/((\d+)?[\w\.]+)/i, // Safari/Konqueror /(mobile\ssafari|safari|konqueror)\/((\d+)?[\w\.]+)/i, // Safari/Konqueror
/(applewebkit|khtml)\/((\d+)?[\w\.]+)/i, /(applewebkit|khtml)\/((\d+)?[\w\.]+)/i,
@@ -111,9 +128,9 @@
], ['name', 'version', 'major']); ], ['name', 'version', 'major']);
}; };
this.getEngine = function (uastring) { this.getEngine = function () {
return regxMap(uastring || ua, [ return regexMapper(ua, [
/(presto)\/([\w\.]+)/i, // Presto /(presto)\/([\w\.]+)/i, // Presto
/([aple]*webkit|trident)\/([\w\.]+)/i, // Webkit/Trident /([aple]*webkit|trident)\/([\w\.]+)/i, // Webkit/Trident
@@ -124,15 +141,15 @@
], ['version', 'name']); ], ['version', 'name']);
}; };
this.getOS = function (uastring) { this.getOS = function () {
return regxMap(uastring || ua, [ return regexMapper(ua, [
// Windows based // Windows based
/(windows\sphone\sos|windows)\s?([nt\d\.\s]+\d)/i // Windows /(windows\sphone\sos|windows)\s?([nt\d\.\s]+\d)/i // Windows
], ['name', ['version', /(.+)/gi, mapper.os.win]], [ ], ['name', ['version', /(.+)/gi, maps.os.win]], [
/(win(?=3|9|n)|win\s9x\s)([nt\d\.]+)/i /(win(?=3|9|n)|win\s9x\s)([nt\d\.]+)/i
], [['name', 'Windows'], ['version', /(.+)/gi, mapper.os.win]], [ ], [['name', 'Windows'], ['version', /(.+)/gi, maps.os.win]], [
// Mobile/Embedded OS // Mobile/Embedded OS
/(blackberry).+version\/([\w\.]+)/i, // Blackberry /(blackberry).+version\/([\w\.]+)/i, // Blackberry
@@ -149,11 +166,11 @@
/(gnu|linux)\s?([\w\.]+)*/i // Other GNU/Linux /(gnu|linux)\s?([\w\.]+)*/i // Other GNU/Linux
], ['name', 'version'], [ ], ['name', 'version'], [
/cros\s([\w\.\s]+\d)/i // Chromium OS /(cros)\s([\w\.\s]+\d)/i // Chromium OS
], [['name', 'Chromium OS'], 'version'],[ ], [['name', 'Chromium OS'], 'version'],[
// Solaris // Solaris
/sunos\s?([\w\.\s]+\d)*/i // Solaris /(sunos)\s?([\w\.\s]+\d)*/i // Solaris
], [['name', 'Solaris'], 'version'], [ ], [['name', 'Solaris'], 'version'], [
// BSD based // BSD based
@@ -172,9 +189,9 @@
], ['name', 'version']); ], ['name', 'version']);
}; };
this.getDevice = function (uastring) { this.getDevice = function () {
return regxMap(uastring || ua, [ return regexMapper(ua, [
/\((ip[honead]+|playbook);/i, // iPod/iPhone/iPad/PlayBook /\((ip[honead]+|playbook);/i, // iPod/iPhone/iPad/PlayBook
/(blackberry)[\s-]?(\w+)/i, // BlackBerry /(blackberry)[\s-]?(\w+)/i, // BlackBerry
@@ -191,23 +208,23 @@
/(zte)-([\w]+)*/i /(zte)-([\w]+)*/i
], ['name', ['version', /_/g, ' ']], [ ], ['name', ['version', /_/g, ' ']], [
/\s(milestone|mz601|droid[2x]?|xoom)[globa\s]*\sbuild\//i, // Motorola /\s((milestone|mz601|droid[2x]?|xoom))[globa\s]*\sbuild\//i, // Motorola
/mot[\s-]?(\w+)*/i /(mot)[\s-]?(\w+)*/i
], [['name', 'Motorola'], 'version'], [ ], [['name', 'Motorola'], 'version'], [
/(s[cgp]h-\w+|gt-\w+|galaxy\snexus)/i, // Samsung /((s[cgp]h-\w+|gt-\w+|galaxy\snexus))/i, // Samsung
/sam[sung]*[\s-]*(\w+-?[\w-]*)*/i, /(sam[sung]*)[\s-]*(\w+-?[\w-]*)*/i,
/sec-(sgh\w+)/i /sec-((sgh\w+))/i
], [['name', 'Samsung'], 'version'], [ ], [['name', 'Samsung'], 'version'], [
/(transfo[prime\s]{4,10}\s\w+|(?:android).*eeepc)/i // Asus /((transfo[prime\s]{4,10}\s\w+|(?:android.*)eeepc))/i // Asus
], [['name', 'Asus'], 'version'], [ ], [['name', 'Asus'], 'version'], [
/sie-(\w+)*/i // Siemens /(sie)-(\w+)*/i // Siemens
], [['name', 'Siemens'], 'version'], [ ], [['name', 'Siemens'], 'version'], [
/(?=maemo|nokia).*(n900|lumia\s\d+)/i, // Nokia /(maemo|nokia).*(n900|lumia\s\d+)/i, // Nokia
/nokia[\s_-]?([\w-]+)*/i /(nokia)[\s_-]?([\w-]+)*/i
], [['name', 'Nokia'], 'version']); ], [['name', 'Nokia'], 'version']);
}; };
@@ -215,14 +232,17 @@
return ua; return ua;
}; };
this.setUA = function (uastring) { this.getResult = function() {
ua = uastring; return {
this.result = {
browser : this.getBrowser(), browser : this.getBrowser(),
engine : this.getEngine(), engine : this.getEngine(),
os : this.getOS(), os : this.getOS(),
device : this.getDevice() device : this.getDevice()
}; };
};
this.setUA = function (uastring) {
ua = uastring;
return this; return this;
}; };
@@ -232,10 +252,10 @@
// check whether script is running inside node.js export as module // check whether script is running inside node.js export as module
if (typeof exports !== 'undefined' && this.toString() !== '[object DOMWindow]') { if (typeof exports !== 'undefined' && this.toString() !== '[object DOMWindow]') {
if (typeof module !== 'undefined' && module.exports) { if (typeof module !== 'undefined' && module.exports) {
exports = module.exports = parser; exports = module.exports = UAParser;
} }
exports.UAParser = parser; exports.UAParser = UAParser;
} else { } else {
this['UAParser'] = parser; this['UAParser'] = UAParser;
} }
})(); })();