device_detector 1.0.7 → 1.1.1

data/lib/device_detector/os.rb

@@ -49,6 +49,8 @@ class DeviceDetector
     OPERATING_SYSTEMS = {
       'AIX' => 'AIX',
       'AND' => 'Android',
+      'ADR' => 'Android TV',
+      'AMZ' => 'Amazon Linux',
       'AMG' => 'AmigaOS',
       'ATV' => 'tvOS',
       'ARL' => 'Arch Linux',
@@ -57,10 +59,15 @@ class DeviceDetector
       'BEO' => 'BeOS',
       'BLB' => 'BlackBerry OS',
       'QNX' => 'BlackBerry Tablet OS',
+      'BOS' => 'Bliss OS',
       'BMP' => 'Brew',
       'CAI' => 'Caixa Mágica',
       'CES' => 'CentOS',
+      'CST' => 'CentOS Stream',
+      'CLR' => 'ClearOS Mobile',
       'COS' => 'Chrome OS',
+      'CRS' => 'Chromium OS',
+      'CHN' => 'China OS',
       'CYN' => 'CyanogenMod',
       'DEB' => 'Debian',
       'DEE' => 'Deepin',
@@ -70,9 +77,11 @@ class DeviceDetector
       'FEN' => 'Fenix',
       'FOS' => 'Firefox OS',
       'FIR' => 'Fire OS',
+      'FOR' => 'Foresight Linux',
       'FRE' => 'Freebox',
       'BSD' => 'FreeBSD',
       'FYD' => 'FydeOS',
+      'FUC' => 'Fuchsia',
       'GNT' => 'Gentoo',
       'GRI' => 'GridOS',
       'GTV' => 'Google TV',
@@ -85,9 +94,14 @@ class DeviceDetector
       'INF' => 'Inferno',
       'JME' => 'Java ME',
       'KOS' => 'KaiOS',
+      'KAN' => 'Kanotix',
       'KNO' => 'Knoppix',
+      'KTV' => 'KreaTV',
       'KBT' => 'Kubuntu',
       'LIN' => 'GNU/Linux',
+      'LND' => 'LindowsOS',
+      'LNS' => 'Linspire',
+      'LEN' => 'Lineage OS',
       'LBT' => 'Lubuntu',
       'LOS' => 'Lumin OS',
       'VLN' => 'VectorLinux',
@@ -97,6 +111,7 @@ class DeviceDetector
       'MDR' => 'Mandriva',
       'SMG' => 'MeeGo',
       'MCD' => 'MocorDroid',
+      'MON' => 'moonOS',
       'MIN' => 'Mint',
       'MLD' => 'MildWild',
       'MOR' => 'MorphOS',
@@ -105,25 +120,34 @@ class DeviceDetector
       'MRE' => 'MRE',
       'WII' => 'Nintendo',
       'NDS' => 'Nintendo Mobile',
+      'NOV' => 'Nova',
       'OS2' => 'OS/2',
       'T64' => 'OSF1',
       'OBS' => 'OpenBSD',
       'OWR' => 'OpenWrt',
+      'OTV' => 'Opera TV',
       'ORD' => 'Ordissimo',
+      'PAR' => 'Pardus',
       'PCL' => 'PCLinuxOS',
+      'PLA' => 'Plasma Mobile',
       'PSP' => 'PlayStation Portable',
       'PS3' => 'PlayStation',
+      'PUR' => 'PureOS',
       'RHT' => 'Red Hat',
+      'REV' => 'Revenge OS',
       'ROS' => 'RISC OS',
       'ROK' => 'Roku OS',
       'RSO' => 'Rosa',
+      'ROU' => 'RouterOS',
       'REM' => 'Remix OS',
+      'RRS' => 'Resurrection Remix OS',
       'REX' => 'REX',
       'RZD' => 'RazoDroiD',
       'SAB' => 'Sabayon',
       'SSE' => 'SUSE',
       'SAF' => 'Sailfish OS',
       'SEE' => 'SeewoOS',
+      'SIR' => 'Sirin OS',
       'SLW' => 'Slackware',
       'SOS' => 'Solaris',
       'SYL' => 'Syllable',
@@ -132,6 +156,7 @@ class DeviceDetector
       'S40' => 'Symbian OS Series 40',
       'S60' => 'Symbian OS Series 60',
       'SY3' => 'Symbian^3',
+      'TEN' => 'TencentOS',
       'TDX' => 'ThreadX',
       'TIZ' => 'Tizen',
       'TOS' => 'TmaxOS',
@@ -148,6 +173,8 @@ class DeviceDetector
       'XBX' => 'Xbox',
       'XBT' => 'Xubuntu',
       'YNS' => 'YunOS',
+      'ZEN' => 'Zenwalk',
+      'ZOR' => 'ZorinOS',
       'IOS' => 'iOS',
       'POS' => 'palmOS',
       'WOS' => 'webOS'
@@ -158,12 +185,13 @@ class DeviceDetector
     end.freeze
 
     OS_FAMILIES = {
-      'Android' => %w[AND CYN FIR REM RZD MLD MCD YNS GRI HAR],
+      'Android' => %w[ AND CYN FIR REM RZD MLD MCD YNS GRI HAR
+                       ADR CLR BOS REV LEN SIR RRS],
       'AmigaOS' => %w[AMG MOR],
       'BlackBerry' => %w[BLB QNX],
       'Brew' => ['BMP'],
       'BeOS' => %w[BEO HAI],
-      'Chrome OS' => %w[COS FYD SEE],
+      'Chrome OS' => %w[COS CRS FYD SEE],
       'Firefox OS' => %w[FOS KOS],
       'Gaming Console' => %w[WII PS3],
       'Google TV' => ['GTV'],
@@ -174,7 +202,9 @@ class DeviceDetector
         LIN ARL DEB KNO MIN UBT KBT XBT LBT FED
         RHT VLN MDR GNT SAB SLW SSE CES BTR SAF
         ORD TOS RSO DEE FRE MAG FEN CAI PCL HAS
-        LOS DVK ROK OWR
+        LOS DVK ROK OWR OTV KTV PUR PLA FUC PAR
+        FOR MON KAN ZEN LND LNS CHN AMZ TEN CST
+        NOV ROU ZOR
       ],
       'Mac' => ['MAC'],
       'Mobile Gaming Console' => %w[PSP NDS XBX],

data/lib/device_detector/parser.rb

@@ -58,7 +58,29 @@ class DeviceDetector
     end
 
     def load_regexes(file_paths)
-      file_paths.map { |path, full_path| [path, symbolize_keys!(YAML.load_file(full_path))] }
+      file_paths.map do |path, full_path|
+        object = YAML.load_file(full_path)
+        object = rewrite_device_object!(object) if is_device_yml_file?(full_path)
+        object = rewrite_vendor_object!(object) if is_vendor_yml_file?(full_path)
+
+        [path, symbolize_keys!(object)]
+      end
+    end
+
+    def is_device_yml_file?(file_path)
+      file_path.include?('/regexes/device/')
+    end
+
+    def is_vendor_yml_file?(file_path)
+      file_path.include?('/regexes/vendorfragments')
+    end
+
+    def rewrite_vendor_object!(object)
+      object.map { |key, values| values.map { |v| { 'regex_name' => key, 'regex' => v } } }.flatten
+    end
+
+    def rewrite_device_object!(object)
+      object.map { |key, value| [key, { 'regex_name' => key }.merge!(value)] }.to_h
     end
 
     def symbolize_keys!(object)
@@ -88,8 +110,8 @@ class DeviceDetector
       Regexp.new('(?:^|[^A-Z0-9\-_]|[^A-Z0-9\-]_|sprd-|MZ-)(?:' + src + ')', Regexp::IGNORECASE)
     end
 
-    def from_cache(key)
-      DeviceDetector.cache.get_or_set(key) { yield }
+    def from_cache(key, &block)
+      DeviceDetector.cache.get_or_set(key, &block)
     end
   end
 end

data/lib/device_detector/vendor_fragment.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'set'
+
+class DeviceDetector
+  class VendorFragment < Parser
+    def name
+      vendor_fragment_info
+    end
+
+    private
+
+    def vendor_fragment_info
+      from_cache(['vendor_fragment', self.class.name, user_agent]) do
+        return if regex_meta.nil? || regex_meta.empty?
+
+        regex_meta[:regex_name]
+      end
+    end
+
+    def filenames
+      ['vendorfragments.yml']
+    end
+  end
+end

data/lib/device_detector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class DeviceDetector
-  VERSION = '1.0.7'
+  VERSION = '1.1.1'
 end

data/lib/device_detector.rb

@@ -14,42 +14,78 @@ require 'device_detector/client'
 require 'device_detector/device'
 require 'device_detector/os'
 require 'device_detector/browser'
+require 'device_detector/client_hint'
+require 'device_detector/vendor_fragment'
 
 class DeviceDetector
-  attr_reader :user_agent
+  attr_reader :client_hint, :user_agent
 
-  def initialize(user_agent)
-    @user_agent = user_agent
+  def initialize(user_agent, headers = nil)
+    @client_hint = ClientHint.new(headers)
+    utf8_user_agent = encode_user_agent_if_needed(user_agent)
+    @user_agent = set_user_agent(utf8_user_agent)
+  end
+
+  # https://github.com/matomo-org/device-detector/blob/c235832dba13961ab0f71b681616baf1aa48de23/Parser/Device/AbstractDeviceParser.php#L1873
+  def set_user_agent(user_agent)
+    return user_agent if client_hint.model.nil?
+
+    regex = build_regex('Android 10[.\d]*; K(?: Build/|[;)])')
+    return user_agent unless user_agent =~ regex
+
+    version = client_hint.os_version || '10'
+
+    user_agent.gsub(regex, "Android #{version}, #{client_hint.model}")
+  end
+
+  def encode_user_agent_if_needed(user_agent)
+    return if user_agent.nil?
+    return user_agent if user_agent.encoding.name == 'UTF-8'
+
+    user_agent.encode('utf-8', 'binary', undef: :replace)
   end
 
   def name
-    client.name
+    return client.name if mobile_fix?
+
+    client_hint.browser_name || client.name
   end
 
   def full_version
-    client.full_version
+    client_hint.platform_version || client.full_version
   end
 
   def os_family
-    os.family
+    return 'GNU/Linux' if linux_fix?
+
+    client_hint.os_family || os.family || client_hint.platform
   end
 
   def os_name
-    os.name
+    return 'GNU/Linux' if linux_fix?
+
+    client_hint.os_name || os.name || client_hint.platform
   end
 
   def os_full_version
-    os.full_version
+    return if skip_os_version?
+
+    client_hint.os_version || os.full_version
   end
 
   def device_name
-    device.name
+    return if fake_ua?
+
+    device.name || client_hint.model || fix_for_x_music
   end
 
   def device_brand
+    return if fake_ua?
+
     # Assume all devices running iOS / Mac OS are from Apple
     brand = device.brand
     brand = 'Apple' if brand.nil? && ['Apple TV', 'iOS', 'Mac'].include?(os_name)
+
     brand
   end
 
@@ -62,7 +98,7 @@ class DeviceDetector
     # Note: We do not check for browser (family) here, as there might be mobile apps using Chrome,
     # that won't have a detected browser, but can still be detected. So we check the useragent for
     # Chrome instead.
-    if t.nil? && os.family == 'Android' && user_agent =~ build_regex('Chrome\/[\.0-9]*')
+    if t.nil? && os_family == 'Android' && user_agent =~ build_regex('Chrome\/[\.0-9]*')
       if user_agent =~ build_regex('(?:Mobile|eliboM) Safari\/')
         t = 'smartphone'
       elsif user_agent =~ build_regex('(?!Mobile )Safari\/')
@@ -97,7 +133,7 @@ class DeviceDetector
     end
 
     # All detected feature phones running android are more likely a smartphone
-    t = 'smartphone' if t == 'feature phone' && os.family == 'Android'
+    t = 'smartphone' if t == 'feature phone' && os_family == 'Android'
 
     # All unknown devices under running Java ME are more likely a features phones
     t = 'feature phone' if t.nil? && os_name == 'Java ME'
@@ -111,19 +147,25 @@ class DeviceDetector
     # assume that all Windows 8 touch devices are tablets.
     if t.nil? && touch_enabled? &&
        (os_name == 'Windows RT' ||
-        (os_name == 'Windows' && os.full_version &&
-         Gem::Version.new(os.full_version) >= VersionExtractor::MAJOR_VERSION_8))
+        (os_name == 'Windows' && os_full_version &&
+         Gem::Version.new(os_full_version) >= VersionExtractor::MAJOR_VERSION_8))
       t = 'tablet'
     end
 
     # All devices running Opera TV Store are assumed to be a tv
     t = 'tv' if opera_tv_store?
 
+    # All devices that contain Andr0id in string are assumed to be a tv
+    t = 'tv' if user_agent =~ build_regex('Andr0id|Android TV')
+
     # All devices running Tizen TV or SmartTV are assumed to be a tv
     t = 'tv' if t.nil? && tizen_samsung_tv?
 
     # Devices running Kylo or Espital TV Browsers are assumed to be a TV
-    t = 'tv' if t.nil? && ['Kylo', 'Espial TV Browser'].include?(client.name)
+    t = 'tv' if t.nil? && ['Kylo', 'Espial TV Browser'].include?(name)
+
+    # All devices containing TV fragment are assumed to be a tv
+    t = 'tv' if t.nil? && user_agent =~ build_regex('\(TV;')
 
     has_desktop = t != 'desktop' && desktop_string? && desktop_fragment?
     t = 'desktop' if has_desktop
@@ -190,12 +232,36 @@ class DeviceDetector
     @os ||= OS.new(user_agent)
   end
 
+  # https://github.com/matomo-org/device-detector/blob/827a3fab7e38c3274c18d2f5f5bc2a78b7ef4a3a/DeviceDetector.php#L921C5-L921C5
+  def fake_ua?
+    os_name == 'Android' && device.brand == 'Apple'
+  end
+
+  # https://github.com/matomo-org/device-detector/blob/be1c9ef486c247dc4886668da5ed0b1c49d90ba8/Parser/Client/Browser.php#L772
+  # Fix mobile browser names e.g. Chrome => Chrome Mobile
+  def mobile_fix?
+    client.name == "#{client_hint.browser_name} Mobile"
+  end
+
+  def linux_fix?
+    client_hint.platform == 'Linux' && os.name == 'Android' && client_hint.mobile == '?0'
+  end
+
+  # Related to issue mentionned in device.rb#1562
+  def fix_for_x_music
+    user_agent&.include?('X-music Ⅲ') ? 'X-Music III' : nil
+  end
+
+  def skip_os_version?
+    !client_hint.os_family.nil? && client_hint.os_family != os.family
+  end
+
   def android_tablet_fragment?
-    user_agent =~ build_regex('Android(?: \d.\d(?:.\d)?)?; Tablet;')
+    user_agent =~ build_regex('Android( [\.0-9]+)?; Tablet;')
   end
 
   def android_mobile_fragment?
-    user_agent =~ build_regex('Android(?: \d.\d(?:.\d)?)?; Mobile;')
+    user_agent =~ build_regex('Android( [\.0-9]+)?; Mobile;')
   end
 
   def desktop_fragment?