add mobile phone detecting in user agent library and expose it in browser check

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

diff --git a/include/classes/useragent.php-class b/include/classes/useragent.php-class
index a7a137ce4526572915511fcf38afe7b85b11eaeb..108649fb81c4d0169dd07e51aedb332599907adc 100755 (executable)
--- a/include/classes/useragent.php-class
+++ b/include/classes/useragent.php-class
@@ -50,6 +50,8 @@ class userAgent {
   //   the User Agent version
   // private $bot
   //   bool: true if this agent is a bot
+  // private $mobile
+  //   bool: true if this agent is a mobile phone
   // private $uadata
   //   array of static user agent data (static vars in functions are set for all objects of this class!)
   //
@@ -92,6 +94,9 @@ class userAgent {
   // public function isBot()
   //   returns true if User Agent seems to be a bot
   //
+  // public function isMobile()
+  //   returns true if User Agent seems to be a mobile phone
+  //
   // *** functions that only return useable info for some agents ***
   //
   // public function getGeckoDate()
@@ -123,6 +128,7 @@ class userAgent {
   private $brand;
   private $version;
   private $bot = false;
+  private $mobile = false;
   private $uadata = array();
 
   function __construct($ua_string = '') {
@@ -281,11 +287,13 @@ class userAgent {
       $this->brand = 'Minimo';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|Fennec/([0-9a-zA-Z\.+]+)|i', $this->uastring, $regs)) {
       $this->brand = 'Fennec'; // Firefox mobile code name
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|Galeon/([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'Galeon';
@@ -311,21 +319,25 @@ class userAgent {
       $this->brand = 'microB';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|Maemo Browser ([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'microB';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|Opera\/([^\(]+) \(.*; Opera Mini; |', $this->uastring, $regs)) {
       $this->brand = 'Opera Mini';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('/Opera\/[^\(]+ \(.*; Opera Mini\/([^;]+); /i', $this->uastring, $regs)) {
       $this->brand = 'Opera Mini';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|Opera[ /]([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'Opera';
@@ -383,8 +395,9 @@ class userAgent {
       $this->bot = false;
     }
     elseif (preg_match('|Safari/([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
-      if (preg_match('| Mobile(/[0-9a-zA-Z\.+]+)? Safari/|', $this->uastring)) {
+      if (preg_match('| Mobile(/[0-9a-zA-Z\.+]+)? ?Safari/|', $this->uastring)) {
         $this->brand = 'Mobile Safari';
+        $this->mobile = true;
       }
       else {
         $this->brand = 'Safari';
@@ -448,16 +461,19 @@ class userAgent {
       $this->brand = 'YodaoBot-Mobile';
       $this->version = $regs[1];
       $this->bot = true;
+      $this->mobile = true;
     }
     elseif (preg_match('|Googlebot-Mobile/([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) { /* looks like Gecko! */
       $this->brand = 'Googlebot-Mobile';
       $this->version = $regs[1];
       $this->bot = true;
+      $this->mobile = true;
     }
     elseif (preg_match('|FASTMobileCrawl/([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) { /* looks like Gecko! */
       $this->brand = 'FASTMobileCrawl';
       $this->version = $regs[1];
       $this->bot = true;
+      $this->mobile = true;
     }
     elseif (preg_match('|MSFrontPage/([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'Microsoft FrontPage';
@@ -503,6 +519,7 @@ class userAgent {
       $this->brand = 'PlayStation Portable';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|PLAYSTATION 3; ([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'PlayStation 3';
@@ -513,51 +530,61 @@ class userAgent {
       $this->brand = 'NetFront';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|UP.Browser/([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'UP.Browser';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|UP.Link/([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'UP.Link';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|AU-MIC-([0-9A-Z]+/[0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'Obigo';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|Browser/Obigo-([0-9A-Z]+/[0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'Obigo';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|Nokia([0-9a-zA-Z]+/[0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'Nokia';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|SonyEricsson([0-9a-zA-Z]+/[0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'SonyEricsson';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|SIE-([0-9a-zA-Z]+/[0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'Siemens';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|MOT-([0-9a-zA-Z]+/[0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'Motorola';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|IXI/([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'IXI';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|NewsFox/([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'NewsFox';
@@ -933,6 +960,11 @@ class userAgent {
       $this->version = "9.0";
       $this->bot = false;
     }
+    elseif (preg_match('|MSIE 7\.0.+Trident/6.0|', $this->uastring, $regs)) {
+      $this->brand = 'Microsoft Internet Explorer';
+      $this->version = "10.0";
+      $this->bot = false;
+    }
     elseif (preg_match('|MSIE ([0-9a-zA-Z\.+]+)|', $this->uastring, $regs)) {
       $this->brand = 'Microsoft Internet Explorer';
       $this->version = $regs[1];
@@ -942,6 +974,7 @@ class userAgent {
       $this->brand = 'Microsoft Pocket Internet Explorer';
       $this->version = $regs[1];
       $this->bot = false;
+      $this->mobile = true;
     }
     elseif (preg_match('|Mozilla/([0-9a-zA-Z\.+]+)|', $this->uastring, $regs) &&
             (strpos($this->uastring, 'compatible') === false) && (strpos($this->uastring, 'Gecko/') === false) &&
@@ -967,6 +1000,11 @@ class userAgent {
     if (in_array($this->brand, $botArray)) {
       $this->bot = true;
     }
+
+    if (($this->brand == 'Microsoft Pocket Internet Explorer') ||
+        (strpos($this->brand, 'BlackBerry') !== false)) {
+      $this->mobile = true;
+    }
   }
 
   public function getBrand() { return $this->brand; }
@@ -996,7 +1034,7 @@ class userAgent {
       $this->uadata['engine'] = 'unknown';
       $this->uadata['geckodate'] = null;
       if (!$this->bot) {
-        if (preg_match('|Gecko/([0-9]+)|', $this->uastring, $regs) && (strpos($this->brand, 'Opera') === false)) {
+        if (preg_match('|Gecko/([0-9\.]+)|', $this->uastring, $regs) && (strpos($this->brand, 'Opera') === false)) {
           $this->uadata['engine'] = 'gecko';
           // If it looks like a version number, i.e. shorter than 4 chars or has a . in it, it's no date.
           $this->uadata['geckodate'] = ((strlen($regs[1]) > 4) && (strpos($regs[1], '.') === false))?$regs[1]:null;
@@ -1126,6 +1164,7 @@ class userAgent {
             $this->uadata['os'] = $regs[1].' ('.$regs[2].')';
             $this->uadata['lang'] = null;
             $this->uadata['eng_version'] = $regs[3];
+            $this->mobile = ($regs[2] == 'Mobile');
           }
           elseif (preg_match('|Mozilla/5.0 \(([^;]+); ([^;]+); rv:([^\);]+)\)|', $this->uastring, $regs)) {
             if ((strpos($regs[2], 'Linux') !== false) && ($regs[1] != 'X11')) {
@@ -1142,6 +1181,12 @@ class userAgent {
             $this->uadata['lang'] = null;
             $this->uadata['eng_version'] = null;
           }
+          elseif (preg_match('|Mozilla/5.0 \(Mobile; rv:([^\);]+)\)|', $this->uastring, $regs)) {
+            $this->uadata['os'] = 'Firefox OS';
+            $this->uadata['lang'] = null;
+            $this->uadata['eng_version'] = $regs[1];
+            $this->mobile = true;
+          }
           elseif (preg_match('|Mozilla/5.0 \(([^;]+); rv:([^\);]+)\)|', $this->uastring, $regs)) {
             $this->uadata['os'] = $regs[1];
             $this->uadata['lang'] = null;
@@ -1173,11 +1218,13 @@ class userAgent {
             $this->uadata['eng_version'] = (strpos($this->uastring,'MSPIE')!==false)?null:"ie".$regs[1];
             $this->uadata['os'] = $regs[2].' ('.$regs[3].')';
             $this->uadata['lang'] = null;
+            $this->mobile = (strpos($this->uastring,'MSPIE') !== false);
           }
           elseif (preg_match('/Mozilla\/[^\(]+ \(compatible *; MSP?IE ([^;]+)[^\)]*; ?((?:Mac|Win)[^;]+)[^\)]*\)/i', $this->uastring, $regs)) {
             $this->uadata['eng_version'] = (strpos($this->uastring,'MSPIE')!==false)?null:"ie".$regs[1];
             $this->uadata['os'] = $regs[2];
             $this->uadata['lang'] = null;
+            $this->mobile = (strpos($this->uastring,'MSPIE') !== false);
           }
           elseif (preg_match('/Mozilla\/[^\(]+ \(compatible *; MSIE ([^;]+)[^\)]*\)/i', $this->uastring, $regs)) {
             $this->uadata['eng_version'] = "ie".$regs[1];
@@ -1235,6 +1282,11 @@ class userAgent {
             $this->uadata['os'] = $regs[1];
             $this->uadata['lang'] = $regs[2];
           }
+          elseif (preg_match('|Mozilla/5.0 \(Linux; ([^;]+); ([^\);]+)\)|', $this->uastring, $regs)) {
+            // (Chrome for) Android - $regs[2] is device
+            $this->uadata['os'] = $regs[1];
+            $this->uadata['lang'] = null;
+          }
           elseif (preg_match('|Mozilla/5.0 \(([^\);]+); ([^\);]+)\)|', $this->uastring, $regs)) {
             if (($regs[1] == 'X11') || ($regs[1] == 'Macintosh') || ($regs[1] == 'iPhone')) {
               $this->uadata['os'] = $regs[2];
@@ -1259,6 +1311,9 @@ class userAgent {
             // For some reason, Amazon spoofs us and tells us it's on MacOS X!
             $this->uadata['os'] = 'Android';
           }
+          if (preg_match('| Mobile |', $this->uastring)) {
+            $this->mobile = true;
+          }
         }
         elseif ($this->hasEngine('presto')) {
           // Opera < 8
@@ -1310,6 +1365,9 @@ class userAgent {
             $this->uadata['os'] = $regs[1];
             $this->uadata['lang'] = $regs[2];
           }
+          if (preg_match('| Mobi|', $this->uastring)) {
+            $this->mobile = true;
+          }
         }
         elseif ($this->hasEngine('nscp')) {
           if (preg_match('/Mozilla\/([0-9a-zA-Z\.+]+) (?:\[([a-z_-]+)\][^\(]+)?\(X11; [^;]+; ([^\)]+)\)/i', $this->uastring, $regs)) {
@@ -1395,6 +1453,9 @@ class userAgent {
         elseif ($this->uadata['os'] == 'Windows NT 6.1') { $this->uadata['os'] = 'Windows 7'; }
         elseif ($this->uadata['os'] == 'Windows NT 6.1 (Win64)') { $this->uadata['os'] = 'Windows 7 (64bit)'; }
         elseif ($this->uadata['os'] == 'Windows NT 6.1 (WOW64)') { $this->uadata['os'] = 'Windows 7 (64bit)'; }
+        elseif ($this->uadata['os'] == 'Windows NT 6.2') { $this->uadata['os'] = 'Windows 8'; }
+        elseif ($this->uadata['os'] == 'Windows NT 6.2 (Win64)') { $this->uadata['os'] = 'Windows 8 (64bit)'; }
+        elseif ($this->uadata['os'] == 'Windows NT 6.2 (WOW64)') { $this->uadata['os'] = 'Windows 8 (64bit)'; }
         elseif ($this->uadata['os'] == 'Win95') { $this->uadata['os'] = 'Windows 95'; }
         elseif ($this->uadata['os'] == 'Win98') { $this->uadata['os'] = 'Windows 98'; }
         elseif ($this->uadata['os'] == 'WinNT') { $this->uadata['os'] = 'Windows NT'; }
@@ -1446,6 +1507,9 @@ class userAgent {
         elseif (strpos($this->uadata['os'], 'mingw') !== false) { $this->uadata['platform'] = 'Windows'; }
         else { $this->uadata['platform'] = $this->uadata['os']; }
 
+        if (strpos($this->uadata['os'], 'Windows Phone OS') !== false) { $this->mobile = true; }
+        elseif (strpos($this->uadata['os'], 'Gameboy') !== false) { $this->mobile = true; }
+
         $this->uadata['lang'] = str_replace('_', '-', $this->uadata['lang']);
       }
     }
@@ -1499,6 +1563,14 @@ class userAgent {
 
   public function isBot() { return $this->bot; }
 
+  public function isMobile() {
+    if (!isset($this->uadata['os'])) {
+      // getOS() makes sure that also the mobile tag is set correctly
+      $this->getOS();
+    }
+    return $this->mobile;
+  }
+
   public function isns() {
     trigger_error(__CLASS__.'::'.__FUNCTION__.' is a deprecated function', E_USER_NOTICE);
     return (strpos($this->brand, 'Netscape') !== false);