SYNOPSIS
use HTTP::BrowserDetect;
my $ua = HTTP::BrowserDetect->new($user_agent_string);
# Print general information
print "Browser: $ua->browser_string\n"
if $ua->browser_string;
print "Version: $ua->browser_version$ua->browser_beta\n"
if $ua->browser_version;
print "OS: $ua->os_string\n"
if $ua->os_string;
# Detect operating system
if ($ua->windows) {
if ($ua->winnt) ...
if ($ua->win95) ...
}
print "Mac\n" if $ua->macosx;
# Detect browser vendor and version
print "Safari\n" if $ua->safari;
print "MSIE\n" if $ua->ie;
print "Mobile\n" if $ua->mobile;
if ($ua->browser_major(4)) {
if ($ua->browser_minor() > .5) {
...
}
}
if ($ua->browser_version() > 4.5) {
...;
}
DESCRIPTION
The HTTP::BrowserDetect object does a number of tests on an HTTP user
agent string. The results of these tests are available via methods of
the object.
This module was originally based upon the JavaScript browser detection
code available at
http://www.mozilla.org/docs/web-developer/sniffer/browser_type.html.
CONSTRUCTOR AND STARTUP
new()
HTTP::BrowserDetect->new( $user_agent_string )
The constructor may be called with a user agent string specified.
Otherwise, it will use the value specified by $ENV{'HTTP_USER_AGENT'},
which is set by the web server when calling a CGI script.
SUBROUTINES/METHODS
Browser Information
browser()
Returns the browser, as one of the following values:
chrome, firefox, ie, opera, safari, applecoremedia, blackberry,
browsex, dalvik, elinks, links, lynx, emacs, epiphany, galeon,
konqueror, icab, lotusnotes, mosaic, mozilla, netfront, netscape, n3ds,
dsi, obigo, realplayer, seamonkey, silk, staroffice, ucbrowser, webtv
If the browser could not be identified (either because unrecognized or
because it is a robot), returns undef.
browser_string()
Returns a human formatted version of the browser name. These names are
subject to change and are meant for display purposes. This may include
information additional to what's in browser() (e.g. distinguishing
Firefox from Iceweasel).
If the user agent could not be identified, or if it was identified as a
robot instead, returns undef.
Browser Version
Please note that that the version(), major() and minor() methods have
been deprecated as of release 1.78 of this module. They should be
replaced with browser_version(), browser_major(), browser_minor(), and
browser_beta().
The reasoning behind this is that version() method will, in the case of
Safari, return the Safari/XXX numbers even when Version/XXX numbers are
present in the UserAgent string (i.e. it will return incorrect versions
for Safari in some cases).
browser_version()
Returns the browser version (major and minor) as a string. For example,
for Chrome 36.0.1985.67, this returns "36.0".
browser_major()
Returns the major part of the version as a string. For example, for
Chrome 36.0.1985.67, this returns "36".
Returns undef if no version information can be detected.
browser_minor()
Returns the minor part of the version as a string. This includes the
decimal point; for example, for Chrome 36.0.1985.67, this returns ".0".
Returns undef if no version information can be detected.
browser_beta()
Returns any part of the version after the major and minor version, as a
string. For example, for Chrome 36.0.1985.67, this returns ".1985.67".
The beta part of the string can contain any type of alphanumeric
characters.
Returns undef if no version information can be detected. Returns an
empty string if version information is detected but it contains only a
major and minor version with nothing following.
Operating System
os()
Returns one of the following strings, or undef:
windows, winphone, mac, macosx, linux, android, ios, os2, unix, vms,
chromeos, firefoxos, ps3, psp, rimtabletos, blackberry, amiga
os_string()
Returns a human formatted version of the OS name. These names are
subject to change and are really meant for display purposes. This may
include information additional to what's in os() (e.g. distinguishing
various editions of Windows from one another) (although for a way to do
that that's more suitable for use in program logic, see below under "OS
related properties").
Returns undef if no OS information could be detected.
os_version() =head2 os_major() =head2 os_minor() =head2 os_beta()
Returns version information for the OS, if any could be detected. The
format is the same as for the browser_version() functions.
Mobile Devices
mobile()
Returns true if the browser appears to belong to a handheld device.
tablet()
Returns true if the browser appears to belong to a tablet device.
device()
Returns the type of mobile / tablet hardware, if it can be detected.
Currently returns one of: android, audrey, avantgo, blackberry, dsi,
iopener, ipad, iphone, ipod, kindle, n3ds, palm, ps3, psp, wap, webos,
winphone.
Returns undef if this is not a tablet/mobile device or no hardware
information can be detected.
device_string()
Returns a human formatted version of the hardware device name. These
names are subject to change and are really meant for display purposes.
You should use the device() method in your logic. This may include
additional information (such as the model of phone if it is
detectable).
Returns undef if this is not a portable device or if no device name can
be detected.
Robots
robot()
If the user agent appears to be a robot, spider, crawler, or other
automated Web client, this returns one of the following values:
lwp, slurp, yahoo, msnmobile, msn, ahrefs, altavista, apache,
askjeeves, baidu, curl, facebook, getright, googleadsbot,
googleadsense, googlebotimage, googlebotnews, googlebotvideo,
googlemobile, google, golib, indy, infoseek, linkexchange, linkchecker,
lycos, mj12bot, puf, rubylib, scooter, specialarchiver, webcrawler,
wget, yandexbot, yandeximages, java, unknown
Returns "unknown" when the user agent is believed to be a robot but is
not identified as one of the above specific robots.
Returns undef if the user agent is not a robot or cannot be identified.
Note that if a robot crafts a user agent designed to impersonate a
particular browser, we generally set properties appropriate to both the
actual robot, and the browser it is impersonating. For example,
googlebot-mobile pretends to be mobile safari so that it will get
mobile versions of pages. In this case, browser() will return 'safari',
the properties will generally be set as if for Mobile Safari, the
'robot' property will be set, and robot() will return 'googlemobile'.
lib()
Returns true if the user agent appears to be an HTTP library or tool
(e.g. LWP, curl, wget, java). Generally libraries are also classified
as robots, although it is impossible to tell whether they are being
operated by an automated system or a human.
robot_string()
Returns a human formatted version of the robot name. These names are
subject to change and are meant for display purposes. This may include
additional information (e.g. robots which return "unknown" from robot()
generally can be identified in a human-readable fashion by reading
robot_string() ).
Browser Properties
Operating systems, devices, browser names, rendering engines, and
true-or-false methods (e.g. "mobile" and "lib") are all browser
properties. For example, calling browser_properties() for Mobile Safari
running on an Android will return this list:
('android', 'device', 'mobile', 'mobile_safari', 'safari', 'webkit')
browser_properties()
Returns all properties for this user agent, as a list. Note that
because a large number of cases must be considered, this will take
significantly more time than simply querying the particular methods you
care about.
A mostly complete list of properties follows (i.e. each of these
methods is both a method you can call, and also a property that may be
in the list returned by browser_properties() ). In addition to this
list, robot(), lib(), device(), mobile(), and tablet() are all browser
properties.
OS related properties
The following methods are available, each returning a true or false
value. Some methods also test for the operating system version. The
indentations below show the hierarchy of tests (for example, win2k is
considered a type of winnt, which is a type of win32)
windows()
win16 win3x win31
win32
winme win95 win98
winnt
win2k winxp win2k3 winvista win7
win8
win8_0 win8_1
wince
winphone
winphone7 winphone7_5 winphone8
dotnet()
chromeos()
firefoxos()
mac()
mac68k macppc macosx ios
os2()
bb10()
rimtabletos()
unix()
sun sun4 sun5 suni86 irix irix5 irix6 hpux hpux9 hpux10
aix aix1 aix2 aix3 aix4 linux sco unixware mpras reliant
dec sinix freebsd bsd
vms()
amiga()
ps3gameos()
pspgameos()
It may not be possibile to detect Win98 in Netscape 4.x and earlier. On
Opera 3.0, the userAgent string includes "Windows 95/NT4" on all Win32,
so you can't distinguish between Win95 and WinNT.
Browser related properties
The following methods are available, each returning a true or false
value. Some methods also test for the browser version, saving you from
checking the version separately.
aol aol3 aol4 aol5 aol6
chrome
emacs
firefox
gecko
icab
ie ie3 ie4 ie4up ie5 ie5up ie55 ie55up ie6 ie7 ie8 ie9 ie10 ie11
ie_compat_mode
The ie_compat_mode is used to determine if the IE user agent is for the
compatibility mode view, in which case the real version of IE is higher
than that detected. The true version of IE can be inferred from the
version of Trident in the engine_version method.
konqueror
lotusnotes
lynx links elinks
mobile_safari
mosaic
mozilla
neoplanet neoplanet2
netfront
netscape nav2 nav3 nav4 nav4up nav45 nav45up navgold nav6 nav6up
opera opera3 opera4 opera5 opera6 opera7
realplayer
The realplayer method above tests for the presence of either the
RealPlayer plug-in "(r1 " or the browser "RealPlayer".
realplayer_browser
The realplayer_browser method tests for the presence of the RealPlayer
browser (but returns 0 for the plugin).
safari
staroffice
webtv
Netscape 6, even though it's called six, in the User-Agent string has
version number 5. The nav6 and nav6up methods correctly handle this
quirk. The Firefox test correctly detects the older-named versions of
the browser (Phoenix, Firebird).
Device related properties
The following methods are available, each returning a true or false
value.
android
audrey
avantgo
blackberry
dsi
iopener
iphone
ipod
ipad
kindle
n3ds
obigo
palm
webos
wap
psp
ps3
Robot properties
The following additional methods are available, each returning a true
or false value. This is by no means a complete list of robots that
exist on the Web.
ahrefs
altavista
apache
askjeeves
baidu
curl
facebook
getright
golib
google
googleadsbot
googleadsense
googlemobile
indy
infoseek
java
linkexchange
lwp
lycos
mj12bot
msn (same as bing)
puf
rubylib
slurp
webcrawler
wget
yahoo
yandex
yandeximages
Engine properties
The following properties indicate if a particular rendering engine is
being used.
webkit
gecko
trident
presto
khtml
Other methods
user_agent()
Returns the value of the user agent string.
Calling this method with a parameter to set the user agent has now been
removed; please use HTTP::BrowserDetect->new() to pass the user agent
string.
country()
Returns the country string as it may be found in the user agent string.
This will be in the form of an upper case 2 character code. ie: US, DE,
etc
language()
Returns the language string as it is found in the user agent string.
This will be in the form of an upper case 2 character code. ie: EN, DE,
etc
engine()
Returns the rendering engine, one of the following:
gecko, webkit, khtml, trident, ie, presto, netfront
Note that this returns "webkit" for webkit based browsers (including
Chrome/Blink). This is a change from previous versions of this library,
which returned "KHTML" for webkit.
Returns undef if none of the above rendering engines can be detected.
engine_string()
Returns a human formatted version of the rendering engine.
Note that this returns "WebKit" for webkit based browsers (including
Chrome/Blink). This is a change from previous versions of this library,
which returned "KHTML" for webkit.
Returns undef if none of the known rendering engines can be detected.
engine_version() =head2 engine_major() =head2 engine_minor() =head2
engine_beta()
Returns version information for the rendering engine, if any can be
detected. The format is the same as for the browser_version()
functions.
Deprecated methods
device_name()
Deprecated alternate name for device_string()
version()
This is probably not what you want. Please use either browser_version()
or engine_version() instead.
Returns the version (major and minor) as a string.
This function returns wrong values for some Safari versions, for
compatibility with earlier code. browser_version() returns correct
version numbers for Safari.
major()
This is probably not what you want. Please use either browser_major()
or engine_major() instead.
Returns the integer portion of the browser version as a string.
This function returns wrong values for some Safari versions, for
compatibility with earlier code. browser_version() returns correct
version numbers for Safari.
minor()
This is probably not what you want. Please use either browser_minor()
or engine_minor() instead.
Returns the decimal portion of the browser version as a string.
This function returns wrong values for some Safari versions, for
compatibility with earlier code. browser_version() returns correct
version numbers for Safari.
beta()
This is probably not what you want. Please use browser_beta() instead.
Returns the beta version, consisting of any characters after the major
and minor version number, as a string.
This function returns wrong values for some Safari versions, for
compatibility with earlier code. browser_version() returns correct
version numbers for Safari.
public_version() =head2 public_major() =head2 public_minor() =head2
public_beta()
Deprecated alternate names for the browser_version() family of
functions.
gecko_version()
If a Gecko rendering engine is used (as in Mozilla or Firefox), returns
the engine version. If no Gecko browser is being used, or the version
number can't be detected, returns undef.
This is an old function, preserved for compatibility; please use
engine_version() in new code.
CREDITS
Lee Semel, lee@semel.net (Original Author)
Peter Walsham (co-maintainer)
Olaf Alders, olaf at wundercounter.com (co-maintainer)
ACKNOWLEDGEMENTS
Thanks to the following for their contributions:
cho45
Leonardo Herrera
Denis F. Latypoff
merlynkline
Simon Waters
Toni Cebrin
Florian Merges
david.hilton.p
Steve Purkis
Andrew McGregor
Robin Smidsrod
Richard Noble
Josh Ritter
Mike Clarke
Marc Sebastian Pelzer
Alexey Surikov
Maros Kollar
Jay Rifkin
Luke Saunders
Jacob Rask
Heiko Weber
Jon Jensen
Jesse Thompson
Graham Barr
Enrico Sorcinelli
Olivier Bilodeau
Yoshiki Kurihara
Paul Findlay
Uwe Voelker
Douglas Christopher Wilson
John Oatis
Atsushi Kato
Ronald J. Kimball
Bill Rhodes
Thom Blake
Aran Deltac
yeahoffline
David Ihnen
Hao Wu
Perlover
TO DO
POD coverage is not 100%.
SEE ALSO
"Browser ID (User-Agent) Strings",
http://www.zytrax.com/tech/web/browser_ids.htm
HTML::ParseBrowser.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc HTTP::BrowserDetect
You can also look for information at:
* GitHub Source Repository
http://github.com/oalders/http-browserdetect
* Reporting Issues
https://github.com/oalders/http-browserdetect/issues
* AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/HTTP-BrowserDetect
* CPAN Ratings
http://cpanratings.perl.org/d/HTTP-BrowserDetect
* Search CPAN
https://metacpan.org/module/HTTP::BrowserDetect
BUGS AND LIMITATIONS
The biggest limitation at this point is the test suite, which really
needs to have many more UserAgent strings to test against.
CONTRIBUTING
Patches are certainly welcome, with many thanks for the excellent
contributions which have already been received. The preferred method of
patching would be to fork the GitHub repo and then send me a pull
request, but plain old patch files are also welcome.
If you're able to add test cases, this will speed up the time to
release your changes. Just edit t/useragents.json so that the test
coverage includes any changes you have made. Please contact me if you
have any questions.
This distribution uses Dist::Zilla. If you're not familiar with this
module, please see
https://github.com/oalders/http-browserdetect/issues/5 for some helpful
tips to get you started.