1HTTP::BrowserDetect(3)User Contributed Perl DocumentationHTTP::BrowserDetect(3)
2
3
4

NAME

6       HTTP::BrowserDetect - Determine Web browser, version, and platform from
7       an HTTP user agent string
8

VERSION

10       version 3.35
11

SYNOPSIS

13           use HTTP::BrowserDetect ();
14
15           my $user_agent_string
16               = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.116 Safari/537.36';
17           my $ua = HTTP::BrowserDetect->new($user_agent_string);
18
19           # Print general information
20           print 'Browser: ' . $ua->browser_string . "\n" if $ua->browser_string;
21           print 'Version: ' . $ua->browser_version . $ua->browser_beta . "\n" if $ua->browser_version;
22           print 'OS: ' . $ua->os_string . "\n" if $ua->os_string;
23
24           # Detect operating system
25           if ( $ua->windows ) {
26               if ( $ua->winnt ) {
27                   # do something
28               }
29               if ( $ua->win95 ) {
30                   # do something
31               }
32           }
33           print "Mac\n" if $ua->macosx;
34
35           # Detect browser vendor and version
36           print "Safari\n" if $ua->safari;
37           print "MSIE\n" if $ua->ie;
38           print "Mobile\n" if $ua->mobile;
39           if ( $ua->browser_major(4) ) {
40               if ( $ua->browser_minor > .5 ) {
41                   # ...;
42               }
43           }
44           if ( $ua->browser_version > 4.5 ) {
45               # ...;
46           }
47

DESCRIPTION

49       The HTTP::BrowserDetect object does a number of tests on an HTTP user
50       agent string. The results of these tests are available via methods of
51       the object.
52
53       For an online demonstration of this module's parsing, you can check out
54       <http://www.browserdetect.org/>
55
56       This module was originally based upon the JavaScript browser detection
57       code available at
58       <http://www.mozilla.org/docs/web-developer/sniffer/browser_type.html>.
59

CONSTRUCTOR AND STARTUP

61   new()
62           HTTP::BrowserDetect->new( $user_agent_string )
63
64       The constructor may be called with a user agent string specified.
65       Otherwise, it will use the value specified by $ENV{'HTTP_USER_AGENT'},
66       which is set by the web server when calling a CGI script.
67

SUBROUTINES/METHODS

Browser Information

70   browser()
71       Returns the browser, as one of the following values:
72
73       chrome, firefox, ie, opera, safari, adm, applecoremedia, blackberry,
74       brave, browsex, dalvik, elinks, links, lynx, emacs, epiphany, galeon,
75       konqueror, icab, lotusnotes, mosaic, mozilla, netfront, netscape, n3ds,
76       dsi, obigo, polaris, pubsub, realplayer, seamonkey, silk, staroffice,
77       ucbrowser, webtv, samsung
78
79       If the browser could not be identified (either because unrecognized or
80       because it is a robot), returns "undef".
81
82   browser_string()
83       Returns a human formatted version of the browser name. These names are
84       subject to change and are meant for display purposes. This may include
85       information additional to what's in browser() (e.g. distinguishing
86       Firefox from Iceweasel).
87
88       If the user agent could not be identified, or if it was identified as a
89       robot instead, returns "undef".
90

Browser Version

92       Please note that that the version(), major() and minor() methods have
93       been deprecated as of release 1.78 of this module. They should be
94       replaced with browser_version(), browser_major(), browser_minor(), and
95       browser_beta().
96
97       The reasoning behind this is that version() method will, in the case of
98       Safari, return the Safari/XXX numbers even when Version/XXX numbers are
99       present in the UserAgent string (i.e. it will return incorrect versions
100       for Safari in some cases).
101
102   browser_version()
103       Returns the browser version (major and minor) as a string. For example,
104       for Chrome 36.0.1985.67, this returns "36.0".
105
106   browser_major()
107       Returns the major part of the version as a string. For example, for
108       Chrome 36.0.1985.67, this returns "36".
109
110       Returns undef if no version information can be detected.
111
112   browser_minor()
113       Returns the minor part of the version as a string. This includes the
114       decimal point; for example, for Chrome 36.0.1985.67, this returns ".0".
115
116       Returns undef if no version information can be detected.
117
118   browser_beta()
119       Returns any part of the version after the major and minor version, as a
120       string. For example, for Chrome 36.0.1985.67, this returns ".1985.67".
121       The beta part of the string can contain any type of alphanumeric
122       characters.
123
124       Returns undef if no version information can be detected. Returns an
125       empty string if version information is detected but it contains only a
126       major and minor version with nothing following.
127

Operating System

129   os()
130       Returns one of the following strings, or "undef":
131
132         windows, winphone, mac, macosx, linux, android, ios, os2, unix, vms,
133         chromeos, firefoxos, ps3, psp, rimtabletos, blackberry, amiga, brew
134
135   os_string()
136       Returns a human formatted version of the OS name.  These names are
137       subject to change and are really meant for display purposes. This may
138       include information additional to what's in os() (e.g. distinguishing
139       various editions of Windows from one another) (although for a way to do
140       that that's more suitable for use in program logic, see below under "OS
141       related properties").
142
143       Returns "undef" if no OS information could be detected.
144
145   os_version(), os_major(), os_minor(), os_beta()
146       Returns version information for the OS, if any could be detected. The
147       format is the same as for the browser_version() functions.
148

Mobile Devices

150   mobile()
151       Returns true if the browser appears to belong to a mobile phone or
152       similar device (i.e. one small enough that the mobile version of a page
153       is probably preferable over the desktop version).
154
155       In previous versions, tablet devices sometimes had mobile() return
156       true. They are now mutually exclusive.
157
158   tablet()
159       Returns true if the browser appears to belong to a tablet device.
160
161   device()
162       Returns the type of mobile / tablet hardware, if it can be detected.
163
164       Currently returns one of: android, audrey, avantgo, blackberry, dsi,
165       iopener, ipad, iphone, ipod, kindle, n3ds, palm, ps3, psp, wap, webos,
166       winphone.
167
168       Returns "undef" if this is not a tablet/mobile device or no hardware
169       information can be detected.
170
171   device_string()
172       Returns a human formatted version of the hardware device name.  These
173       names are subject to change and are really meant for display purposes.
174       You should use the device() method in your logic. This may include
175       additional information (such as the model of phone if it is
176       detectable).
177
178       Returns "undef" if this is not a portable device or if no device name
179       can be detected.
180

Robots

182   robot()
183       If the user agent appears to be a robot, spider, crawler, or other
184       automated Web client, this returns one of the following values:
185
186       lwp, slurp, yahoo, bingbot, msnmobile, msn, msoffice, ahrefs,
187       altavista, apache, askjeeves, baidu, curl, facebook, getright,
188       googleadsbot, googleadsense, googlebotimage, googlebotnews,
189       googlebotvideo, googlefavicon, googlemobile, google, golib, indy,
190       infoseek, ipsagent, linkchecker, linkexchange, lycos, malware, mj12bot,
191       nutch, phplib, puf, rubylib, scooter, specialarchiver, wget, yandexbot,
192       yandeximages, java, headlesschrome, unknown
193
194       Returns "unknown" when the user agent is believed to be a robot but is
195       not identified as one of the above specific robots.
196
197       Returns "undef" if the user agent is not a robot or cannot be
198       identified.
199
200       Note that if a robot crafts a user agent designed to impersonate a
201       particular browser, we generally set properties appropriate to both the
202       actual robot, and the browser it is impersonating. For example,
203       googlebot-mobile pretends to be mobile safari so that it will get
204       mobile versions of pages. In this case, browser() will return 'safari',
205       the properties will generally be set as if for Mobile Safari, the
206       'robot' property will be set, and robot() will return 'googlemobile'.
207
208       lib()
209
210       Returns true if the user agent appears to be an HTTP library or tool
211       (e.g. LWP, curl, wget, java). Generally libraries are also classified
212       as robots, although it is impossible to tell whether they are being
213       operated by an automated system or a human.
214
215       robot_string()
216
217       Returns a human formatted version of the robot name. These names are
218       subject to change and are meant for display purposes. This may include
219       additional information (e.g. robots which return "unknown" from robot()
220       generally can be identified in a human-readable fashion by reading
221       robot_string() ).
222
223       robot_id()
224
225       This method is currently in beta.
226
227       Returns an id consisting of lower case letters, numbers and dashes.
228       This id will remain constant, so you can use it for matching against a
229       particular robot.  The ids were introduced in version 3.14.  There may
230       still be a few corrections to ids in subsequent releases.  Once this
231       method becomes stable the ids will also be frozen.
232
233       all_robot_ids()
234
235       This method returns an "ArrayRef" of all possible "robot_id" values.
236
237   robot_version(), robot_major(), robot_minor(), robot_beta()
238       Returns version information for the robot, if any could be detected.
239       The format is the same as for the browser_version() functions.
240
241       Note that if a robot crafts a user agent designed to impersonate a
242       particular browser, we generally return results appropriate to both the
243       actual robot, and the browser it is impersonating. For example,
244       googlebot-mobile pretends to be mobile safari so that it will get
245       mobile versions of pages. In this case, robot_version() will return the
246       version of googlebot-mobile, and browser_version() will return the
247       version of Safari that googlebot-mobile is impersonating.
248

Browser Properties

250       Operating systems, devices, browser names, rendering engines, and true-
251       or-false methods (e.g. "mobile" and "lib") are all browser properties.
252       For example, calling browser_properties() for Mobile Safari running on
253       an Android will return this list:
254
255       ('android', 'device', 'mobile', 'mobile_safari', 'safari', 'webkit')
256
257   browser_properties()
258       Returns all properties for this user agent, as a list. Note that
259       because a large number of cases must be considered, this will take
260       significantly more time than simply querying the particular methods you
261       care about.
262
263       A mostly complete list of properties follows (i.e. each of these
264       methods is both a method you can call, and also a property that may be
265       in the list returned by browser_properties() ). In addition to this
266       list, robot(), lib(), device(), mobile(), and tablet() are all browser
267       properties.
268
269   OS related properties
270       The following methods are available, each returning a true or false
271       value.  Some methods also test for the operating system version. The
272       indentations below show the hierarchy of tests (for example, win2k is
273       considered a type of winnt, which is a type of win32)
274
275       windows()
276
277           win16 win3x win31
278           win32
279               winme win95 win98
280               winnt
281                   win2k winxp win2k3 winvista win7
282                   win8
283                       win8_0 win8_1
284                   win10
285                       win10_0
286           wince
287           winphone
288               winphone7 winphone7_5 winphone8 winphone10
289
290       dotnet()
291
292       x11()
293
294       webview()
295
296       chromeos()
297
298       firefoxos()
299
300       mac()
301
302       mac68k macppc macosx ios
303
304       os2()
305
306       bb10()
307
308       rimtabletos()
309
310       unix()
311
312         sun sun4 sun5 suni86 irix irix5 irix6 hpux hpux9 hpux10
313         aix aix1 aix2 aix3 aix4 linux sco unixware mpras reliant
314         dec sinix freebsd bsd
315
316       vms()
317
318       amiga()
319
320       ps3gameos()
321
322       pspgameos()
323
324       It may not be possible to detect Win98 in Netscape 4.x and earlier. On
325       Opera 3.0, the userAgent string includes "Windows 95/NT4" on all Win32,
326       so you can't distinguish between Win95 and WinNT.
327
328   Browser related properties
329       The following methods are available, each returning a true or false
330       value.  Some methods also test for the browser version, saving you from
331       checking the version separately.
332
333       adm
334
335       aol aol3 aol4 aol5 aol6
336
337       applecoremedia
338
339       avantgo
340
341       browsex
342
343       chrome
344
345       dalvik
346
347       emacs
348
349       epiphany
350
351       firefox
352
353       galeon
354
355       icab
356
357       ie ie3 ie4 ie4up ie5 ie5up ie55 ie55up ie6 ie7 ie8 ie9 ie10 ie11
358
359       ie_compat_mode
360
361       The ie_compat_mode is used to determine if the IE user agent is for the
362       compatibility mode view, in which case the real version of IE is higher
363       than that detected. The true version of IE can be inferred from the
364       version of Trident in the engine_version method.
365
366       konqueror
367
368       lotusnotes
369
370       lynx links elinks
371
372       mobile_safari
373
374       mosaic
375
376       mozilla
377
378       neoplanet neoplanet2
379
380       netfront
381
382       netscape nav2 nav3 nav4 nav4up nav45 nav45up navgold nav6 nav6up
383
384       obigo
385
386       opera opera3 opera4 opera5 opera6 opera7
387
388       polaris
389
390       pubsub
391
392       realplayer
393
394       The realplayer method above tests for the presence of either the
395       RealPlayer plug-in "(r1 " or the browser "RealPlayer".
396
397       realplayer_browser
398
399       The realplayer_browser method tests for the presence of the RealPlayer
400       browser (but returns 0 for the plugin).
401
402       safari
403
404       samsung
405
406       seamonkey
407
408       silk
409
410       staroffice
411
412       ucbrowser
413
414       webtv
415
416       Netscape 6, even though it's called six, in the User-Agent string has
417       version number 5. The nav6 and nav6up methods correctly handle this
418       quirk. The Firefox test correctly detects the older-named versions of
419       the browser (Phoenix, Firebird).
420
421   Device related properties
422       The following methods are available, each returning a true or false
423       value.
424
425       android
426
427       audrey
428
429       avantgo
430
431       blackberry
432
433       dsi
434
435       iopener
436
437       iphone
438
439       ipod
440
441       ipad
442
443       kindle
444
445       kindlefire
446
447       n3ds
448
449       palm
450
451       webos
452
453       wap
454
455       Note that 'wap' indicates that the device is capable of WAP, not
456       necessarily that the device is limited to WAP only. Most modern WAP
457       devices are also capable of rendering standard HTML.
458
459       psp
460
461       ps3
462
463   Robot properties
464       These methods are now deprecated and will be removed in a future
465       release.  Please use the "robot()" and "robot_id()" methods to identify
466       the bots.  Use "robot_id()" if you need to match on a string, since the
467       value that is returned by "robot" could possibly change in a future
468       release.
469
470       The following additional methods are available, each returning a true
471       or false value. This is by no means a complete list of robots that
472       exist on the Web.
473
474       ahrefs
475
476       altavista
477
478       apache
479
480       askjeeves
481
482       baidu
483
484       bingbot
485
486       curl
487
488       facebook
489
490       getright
491
492       golib
493
494       google
495
496       googleadsbot
497
498       googleadsense
499
500       googlemobile
501
502       indy
503
504       infoseek
505
506       ipsagent
507
508       java
509
510       linkexchange
511
512       lwp
513
514       lycos
515
516       malware
517
518       mj12bot
519
520       msn
521
522       msoffice
523
524       puf
525
526       rubylib
527
528       slurp
529
530       wget
531
532       yahoo
533
534       yandex
535
536       yandeximages
537
538       headlesschrome
539
540   Engine properties
541       The following properties indicate if a particular rendering engine is
542       being used.
543
544       webkit
545
546       gecko
547
548       trident
549
550       presto
551
552       khtml
553

Other methods

555   user_agent()
556       Returns the value of the user agent string.
557
558       Calling this method with a parameter to set the user agent has now been
559       removed; please use HTTP::BrowserDetect->new() to pass the user agent
560       string.
561
562   u2f()
563       Returns true if this browser and version are known to support Universal
564       Second Factor (U2F).  This method will need future updates as more
565       browsers fully support this standard.
566
567   country()
568       Returns the country string as it may be found in the user agent string.
569       This will be in the form of an upper case 2 character code. ie: US, DE,
570       etc
571
572   language()
573       Returns the language string as it is found in the user agent string.
574       This will be in the form of an upper case 2 character code. ie: EN, DE,
575       etc
576
577   engine()
578       Returns the rendering engine, one of the following:
579
580       gecko, webkit, khtml, trident, ie, presto, netfront
581
582       Note that this returns "webkit" for webkit based browsers (including
583       Chrome/Blink). This is a change from previous versions of this library,
584       which returned "KHTML" for webkit.
585
586       Returns "undef" if none of the above rendering engines can be detected.
587
588   engine_string()
589       Returns a human formatted version of the rendering engine.
590
591       Note that this returns "WebKit" for webkit based browsers (including
592       Chrome/Blink). This is a change from previous versions of this library,
593       which returned "KHTML" for webkit.
594
595       Returns "undef" if none of the known rendering engines can be detected.
596
597   engine_version(), engine_major(), engine_minor(), engine_beta()
598       Returns version information for the rendering engine, if any could be
599       detected. The format is the same as for the browser_version()
600       functions.
601

Deprecated methods

603   device_name()
604       Deprecated alternate name for device_string()
605
606   version()
607       This is probably not what you want.  Please use either
608       browser_version() or engine_version() instead.
609
610       Returns the version (major and minor) as a string.
611
612       This function returns wrong values for some Safari versions, for
613       compatibility with earlier code. browser_version() returns correct
614       version numbers for Safari.
615
616   major()
617       This is probably not what you want. Please use either browser_major()
618       or engine_major() instead.
619
620       Returns the integer portion of the browser version as a string.
621
622       This function returns wrong values for some Safari versions, for
623       compatibility with earlier code. browser_version() returns correct
624       version numbers for Safari.
625
626   minor()
627       This is probably not what you want. Please use either browser_minor()
628       or engine_minor() instead.
629
630       Returns the decimal portion of the browser version as a string.
631
632       This function returns wrong values for some Safari versions, for
633       compatibility with earlier code. browser_version() returns correct
634       version numbers for Safari.
635
636   beta()
637       This is probably not what you want. Please use browser_beta() instead.
638
639       Returns the beta version, consisting of any characters after the major
640       and minor version number, as a string.
641
642       This function returns wrong values for some Safari versions, for
643       compatibility with earlier code. browser_version() returns correct
644       version numbers for Safari.
645
646   public_version(), public_major(), public_minor(), public_beta()
647       Deprecated.  Please use browser_version() and related functions
648       instead.
649
650   gecko_version()
651       If a Gecko rendering engine is used (as in Mozilla or Firefox), returns
652       the engine version. If no Gecko browser is being used, or the version
653       number can't be detected, returns undef.
654
655       This is an old function, preserved for compatibility; please use
656       engine_version() in new code.
657

CREDITS

659       Lee Semel, lee@semel.net (Original Author)
660
661       Peter Walsham (co-maintainer)
662
663       Olaf Alders, "olaf at wundercounter.com" (co-maintainer)
664

ACKNOWLEDGEMENTS

666       Thanks to the following for their contributions:
667
668       cho45
669
670       Leonardo Herrera
671
672       Denis F. Latypoff
673
674       merlynkline
675
676       Simon Waters
677
678       Toni Cebrin
679
680       Florian Merges
681
682       david.hilton.p
683
684       Steve Purkis
685
686       Andrew McGregor
687
688       Robin Smidsrod
689
690       Richard Noble
691
692       Josh Ritter
693
694       Mike Clarke
695
696       Marc Sebastian Pelzer
697
698       Alexey Surikov
699
700       Maros Kollar
701
702       Jay Rifkin
703
704       Luke Saunders
705
706       Jacob Rask
707
708       Heiko Weber
709
710       Jon Jensen
711
712       Jesse Thompson
713
714       Graham Barr
715
716       Enrico Sorcinelli
717
718       Olivier Bilodeau
719
720       Yoshiki Kurihara
721
722       Paul Findlay
723
724       Uwe Voelker
725
726       Douglas Christopher Wilson
727
728       John Oatis
729
730       Atsushi Kato
731
732       Ronald J. Kimball
733
734       Bill Rhodes
735
736       Thom Blake
737
738       Aran Deltac
739
740       yeahoffline
741
742       David Ihnen
743
744       Hao Wu
745
746       Perlover
747
748       Daniel Stadie
749
750       ben hengst
751
752       Andrew Moise
753
754       Atsushi Kato
755
756       Marco Fontani
757
758       Nicolas Doye
759

TO DO

761       POD coverage is not 100%.
762

SEE ALSO

764       "Browser ID (User-Agent) Strings",
765       <http://www.zytrax.com/tech/web/browser_ids.htm>
766
767       HTML::ParseBrowser.
768

SUPPORT

770       You can find documentation for this module with the perldoc command.
771
772           perldoc HTTP::BrowserDetect
773
774       You can also look for information at:
775
776       •   GitHub Source Repository
777
778           <http://github.com/oalders/http-browserdetect>
779
780       •   Reporting Issues
781
782           <https://github.com/oalders/http-browserdetect/issues>
783
784       •   Search CPAN
785
786           <https://metacpan.org/module/HTTP::BrowserDetect>
787

CONTRIBUTING

789       Patches are certainly welcome, with many thanks for the excellent
790       contributions which have already been received. The preferred method of
791       patching would be to fork the GitHub repo and then send a pull request.
792
793       Please include a test case as this will speed up the time to release
794       your changes. Just edit t/useragents.json so that the test coverage
795       includes any changes you have made. Please open a GitHub issue if you
796       have any questions.
797

AUTHORS

799       •   Lee Semel <lee@semel.net>
800
801       •   Peter Walsham
802
803       •   Olaf Alders <olaf@wundercounter.com> (current maintainer)
804
806       This software is copyright (c) 1999 by Lee Semel.
807
808       This is free software; you can redistribute it and/or modify it under
809       the same terms as the Perl 5 programming language system itself.
810
811
812
813perl v5.34.0                      2022-01-21            HTTP::BrowserDetect(3)
Impressum