update to current COM development

[php-utility-classes.git] / include / classes / useragent.php-class

<?php
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is KaiRo's userAgent detection.
 *
 * The Initial Developer of the Original Code is
 * KaiRo - Robert Kaiser.
 * Portions created by the Initial Developer are Copyright (C) 2003
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s): Robert Kaiser <kairo@kairo.at>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

class userAgent {
  // userAgent PHP class
  // get user agent and tell us what Browser is accessing
  //
  // function userAgent([$ua_string])
  //   CONSTRUCTOR; reads UA string (or takes the optional given UA string) and gets info from that into our variables.
  //
  // var $uastring
  //   the plain User Agent string
  // var $brand
  //   returns the User Agent brand name
  // var $version
  //   the User Agent version
  // var $bot
  //   bool: true if this agent is a bot
  // var $uadata
  //   array of static user agent data (static vars in functions are set for all objects of this class!)
  //
  // function getBrand()
  //   returns the User Agent Brand Name
  // function getVersion()
  //   returns the User Agent version
  //
  // function getAcceptLanguages()
  //   returns an associated array with the accepted languages of this UA
  //     keys are language codes, values are q factors (weights)
  //
  // function getUAString()
  //   returns the full User Agent string
  //
  // function isbot()
  //   returns true if User Agent seems to be a bot
  // function isns()
  //   returns true if User Agent seems to be Netscape brand, false if not
  // function isns4()
  //   returns true if User Agent seems to be Netscape Communicator 4.x, false if not
  // function isie()
  //   returns true if User Agent seems to be a version of Internet Exploder, false if not
  // function geckobased()
  //   returns true if User Agent seems to be a Gecko-based browser, false if not
  // function geckodate()
  //   returns the Gecko date when it's a Gecko-based browser, 0 if not
  // function khtmlbased()
  //   returns true if User Agent seems to be a KHTML-based browser, false if not

  // collection of some known User Agent Strings:
  // Mozilla/5.0 (compatible; Konqueror/3; Linux 2.4.18; X11; i686)
  // Mozilla/5.0 (X11; U; Linux i686; de-AT; rv:1.3b) Gecko/20030114
  // Mozilla/4.0 (compatible; MSIE 5.0; Windows 95; DigExt)
  // Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Win 9x 4.90)
  // Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)
  // Mozilla/4.75 [de] (Win98; U)
  // Opera/5.12 (Windows 2000; U)  [de]
  // Mozilla/5.0 (Windows; U; Win 9x 4.90; de-DE; m18) Gecko/20010131 Netscape6/6.01
  // Mozilla/5.0 (Windows; U; Windows NT 5.1; de-DE; rv:1.0.1) Gecko/20020823 Netscape/7.0
  // Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en) AppleWebKit/51 (like Gecko) Safari/51
  // Lynx/2.8.4rel.1 libwww-FM/2.14 SSL-MM/1.4.1 OpenSSL/0.9.6g
  // Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en-US; rv:1.0.1) Gecko/20021109 Chimera/0.6+
  // Mozilla/5.0 (Macintosh; U; PPC Mac OS X Mach-O; en-US; rv:1.7b) Gecko/20040302 Camino/0.7+
  // Mozilla/5.0 (Windows; U; Win 9x 4.90; en-US; rv:1.3a) Gecko/20021207 Phoenix/0.5
  // Mozilla/5.0 Galeon/1.2.7 (X11; Linux i686; U;) Gecko/20021204
  // Mozilla/4.0 (compatible; MSIE 5.0; Windows XP) Opera 6.05 [ja]
  // Mozilla/4.0 (compatible; MSIE 5.12; Mac_PowerPC) OmniWeb/4.1.1-v424.6
  // Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.4b) Gecko/20030516 Mozilla Firebird/0.6
  // Mozilla/5.0 (Windows; U; WinNT4.0; en-US; rv:1.5a) Gecko/20030728 Mozilla Firebird/0.6.1
  // Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.7a) Gecko/20040216 Firefox/0.8.0+
  // Python-urllib/1.15
  // *** search bots: ***
  // W3C_Validator/1.305.2.12 libwww-perl/5.64
  // Scooter/3.3
  // Spinne/2.0 med_AH
  // Vagabondo/2.0 MT (webagent at wise-guys dot nl)
  // TurnitinBot/1.5 ( ">http://www.turnitin.com/robot/crawlerinfo.html)
  // FAST-WebCrawler/3.x Multimedia (mm dash crawler at fast dot no)
  // Firefly/1.0 (compatible; Mozilla 4.0; MSIE 5.5)
  // Googlebot/2.1 (+ ">http://www.googlebot.com/bot.html)
  // Scrubby/2.2 ( ">http://www.scrubtheweb.com/)
  // psbot/0.1 (+ ">http://www.picsearch.com/bot.html)
  // NG/1.0
  // URL_Spider_Pro/3.0 ( ">http://www.innerprise.net/usp-spider.asp)"
  // Pompos/1.3 ">http://dir.com/pompos.html
  // Szukacz/1.5 (robot; www.szukacz.pl/jakdzialarobot.html; info@szukacz.pl)
  // ASPseek/1.2.10
  // NPBot-1/2.0
  // NetResearchServer/2.7(loopimprovements.com/robot.html)
  // dloader(NaverRobot)/1.0
  // Mozilla/4.0 compatible ZyBorg/1.0 Daily Refresh Beta-d03 (wn.zyborg@looksmart.net;
  // Mozilla/2.0 (compatible; Ask Jeeves/Teoma)
  // Mozilla/5.0 (Slurp/si; slurp@inktomi.com; ">http://www.inktomi.com/slurp.html)
  // Mozilla/5.0 [en] (compatible; Gulper Web Bot 0.2.4 www.ecsl.cs.sunysb.edu/~maxim/cgi-bin/Link/GulperBot)
  // Mozilla/4.0 (compatible; MSIE 5.0; Windows NT; Girafabot; girafabot at girafa dot com;
  // Mozilla/4.0 (efp@gmx.net)
  // Mozilla/4.5 (compatible; HTTrack 3.0x; Windows 98)
  // PingALink Monitoring Services 1.0 (http://www.pingalink.com)
  // IlTrovatore-Setaccio (+ ">http://www.iltrovatore.it)
  // Mercator-2.0
  // appie 1.1 (www.walhello.com)
  // larbin_2.6.2 (larbin2.6.2@unspecified.mail)
  // OWR_Crawler 0.1
  // search.ch V1.4.2 (spiderman@search.ch;
  // WebFilter Robot 1.0
  // Openfind data gatherer, Openbot/3.0+(robot-response@openfind.com.tw;+
  // LinkWalker
  // Internet Explorer 5.5
  // BaiDuSpider
  // Mozilla/4.0 (compatible; B-l-i-t-z-B-O-T)
  // B l i t z B O T @ t r i c u s . n e t (Mozilla compatible)
  // sitecheck.internetseer.com (For more info see: ">http://sitecheck.internetseer.com)