device_detector 1.1.2 → 1.1.3

data/lib/device_detector/os.rb

@@ -4,6 +4,16 @@ require 'set'
 
 class DeviceDetector
   class OS < Parser
+    class << self
+      def mapped_os_version(version, mapping)
+        return if version.nil?
+
+        major_version = version.split('.').first
+
+        mapping[version] || mapping[major_version]
+      end
+    end
+
     def name
       os_info[:name]
     end
@@ -39,31 +49,41 @@ class DeviceDetector
       end
     end
 
+    # https://github.com/matomo-org/device-detector/blob/75d88bbefb0182f9207c9f48dc39b1bc8c7cc43f/Parser/OperatingSystem.php#L286-L288
     DESKTOP_OSS = Set.new(
       [
-        'AmigaOS', 'IBM', 'GNU/Linux', 'Mac', 'Unix', 'Windows', 'BeOS', 'Chrome OS'
+        'AmigaOS', 'IBM', 'GNU/Linux', 'Mac', 'Unix', 'Windows', 'BeOS', 'Chrome OS', 'Chromium OS'
       ]
     )
 
     # OS short codes mapped to long names
+    # https://github.com/matomo-org/device-detector/blob/75d88bbefb0182f9207c9f48dc39b1bc8c7cc43f/Parser/OperatingSystem.php#L42-L220
     OPERATING_SYSTEMS = {
       'AIX' => 'AIX',
       'AND' => 'Android',
       'ADR' => 'Android TV',
+      'ALP' => 'Alpine Linux',
       'AMZ' => 'Amazon Linux',
       'AMG' => 'AmigaOS',
+      'ARM' => 'Armadillo OS',
+      'ARO' => 'AROS',
       'ATV' => 'tvOS',
       'ARL' => 'Arch Linux',
+      'AOS' => 'AOSC OS',
+      'ASP' => 'ASPLinux',
       'BTR' => 'BackTrack',
       'SBA' => 'Bada',
+      'BYI' => 'Baidu Yi',
       'BEO' => 'BeOS',
       'BLB' => 'BlackBerry OS',
       'QNX' => 'BlackBerry Tablet OS',
       'BOS' => 'Bliss OS',
       'BMP' => 'Brew',
+      'BSN' => 'BrightSignOS',
       'CAI' => 'Caixa Mágica',
       'CES' => 'CentOS',
       'CST' => 'CentOS Stream',
+      'CLO' => 'Clear Linux OS',
       'CLR' => 'ClearOS Mobile',
       'COS' => 'Chrome OS',
       'CRS' => 'Chromium OS',
@@ -73,6 +93,8 @@ class DeviceDetector
       'DEE' => 'Deepin',
       'DFB' => 'DragonFly',
       'DVK' => 'DVKBuntu',
+      'ELE' => 'ElectroBSD',
+      'EUL' => 'EulerOS',
       'FED' => 'Fedora',
       'FEN' => 'Fenix',
       'FOS' => 'Firefox OS',
@@ -80,9 +102,13 @@ class DeviceDetector
       'FOR' => 'Foresight Linux',
       'FRE' => 'Freebox',
       'BSD' => 'FreeBSD',
+      'FRI' => 'FRITZ!OS',
       'FYD' => 'FydeOS',
       'FUC' => 'Fuchsia',
       'GNT' => 'Gentoo',
+      'GNX' => 'GENIX',
+      'GEO' => 'GEOS',
+      'GNS' => 'gNewSense',
       'GRI' => 'GridOS',
       'GTV' => 'Google TV',
       'HPX' => 'HP-UX',
@@ -90,12 +116,15 @@ class DeviceDetector
       'IPA' => 'iPadOS',
       'HAR' => 'HarmonyOS',
       'HAS' => 'HasCodingOS',
+      'HEL' => 'HELIX OS',
       'IRI' => 'IRIX',
       'INF' => 'Inferno',
       'JME' => 'Java ME',
+      'JOL' => 'Joli OS',
       'KOS' => 'KaiOS',
       'KAL' => 'Kali',
       'KAN' => 'Kanotix',
+      'KIN' => 'KIN OS',
       'KNO' => 'Knoppix',
       'KTV' => 'KreaTV',
       'KBT' => 'Kubuntu',
@@ -103,6 +132,8 @@ class DeviceDetector
       'LND' => 'LindowsOS',
       'LNS' => 'Linspire',
       'LEN' => 'Lineage OS',
+      'LIR' => 'Liri OS',
+      'LOO' => 'Loongnix',
       'LBT' => 'Lubuntu',
       'LOS' => 'Lumin OS',
       'LUN' => 'LuneOS',
@@ -114,18 +145,23 @@ class DeviceDetector
       'SMG' => 'MeeGo',
       'MCD' => 'MocorDroid',
       'MON' => 'moonOS',
+      'EZX' => 'Motorola EZX',
       'MIN' => 'Mint',
       'MLD' => 'MildWild',
       'MOR' => 'MorphOS',
       'NBS' => 'NetBSD',
       'MTK' => 'MTK / Nucleus',
       'MRE' => 'MRE',
+      'NXT' => 'NeXTSTEP',
+      'NWS' => 'NEWS-OS',
       'WII' => 'Nintendo',
       'NDS' => 'Nintendo Mobile',
       'NOV' => 'Nova',
       'OS2' => 'OS/2',
       'T64' => 'OSF1',
       'OBS' => 'OpenBSD',
+      'OVS' => 'OpenVMS',
+      'OVZ' => 'OpenVZ',
       'OWR' => 'OpenWrt',
       'OTV' => 'Opera TV',
       'ORA' => 'Oracle Linux',
@@ -136,11 +172,17 @@ class DeviceDetector
       'PLA' => 'Plasma Mobile',
       'PSP' => 'PlayStation Portable',
       'PS3' => 'PlayStation',
+      'PVE' => 'Proxmox VE',
       'PUR' => 'PureOS',
+      'QTP' => 'Qtopia',
+      'PIO' => 'Raspberry Pi OS',
+      'RAS' => 'Raspbian',
       'RHT' => 'Red Hat',
+      'RST' => 'Red Star',
       'RED' => 'RedOS',
       'REV' => 'Revenge OS',
       'ROS' => 'RISC OS',
+      'ROC' => 'Rocky Linux',
       'ROK' => 'Roku OS',
       'RSO' => 'Rosa',
       'ROU' => 'RouterOS',
@@ -151,10 +193,13 @@ class DeviceDetector
       'SAB' => 'Sabayon',
       'SSE' => 'SUSE',
       'SAF' => 'Sailfish OS',
+      'SCI' => 'Scientific Linux',
       'SEE' => 'SeewoOS',
+      'SER' => 'SerenityOS',
       'SIR' => 'Sirin OS',
       'SLW' => 'Slackware',
       'SOS' => 'Solaris',
+      'SBL' => 'Star-Blade OS',
       'SYL' => 'Syllable',
       'SYM' => 'Symbian',
       'SYS' => 'Symbian OS',
@@ -166,7 +211,10 @@ class DeviceDetector
       'TIZ' => 'Tizen',
       'TIV' => 'TiVo OS',
       'TOS' => 'TmaxOS',
+      'TUR' => 'Turbolinux',
       'UBT' => 'Ubuntu',
+      'ULT' => 'ULTRIX',
+      'UOS' => 'UOS',
       'VID' => 'VIDAA',
       'WAS' => 'watchOS',
       'WER' => 'Wear OS',
@@ -178,6 +226,7 @@ class DeviceDetector
       'WMO' => 'Windows Mobile',
       'WPH' => 'Windows Phone',
       'WRT' => 'Windows RT',
+      'WPO' => 'WoPhone',
       'XBX' => 'Xbox',
       'XBT' => 'Xubuntu',
       'YNS' => 'YunOS',
@@ -185,6 +234,7 @@ class DeviceDetector
       'ZOR' => 'ZorinOS',
       'IOS' => 'iOS',
       'POS' => 'palmOS',
+      'WEB' => 'Webian',
       'WOS' => 'webOS'
     }.freeze
 
@@ -192,10 +242,14 @@ class DeviceDetector
       h[long.downcase] = short
     end.freeze
 
+    APPLE_OS_NAMES = Set.new(%w[iPadOS tvOS watchOS iOS Mac]).freeze
+
+    # https://github.com/matomo-org/device-detector/blob/75d88bbefb0182f9207c9f48dc39b1bc8c7cc43f/Parser/OperatingSystem.php#L227-L269
     OS_FAMILIES = {
       'Android' => %w[ AND CYN FIR REM RZD MLD MCD YNS GRI HAR
-                       ADR CLR BOS REV LEN SIR RRS WER PIC],
-      'AmigaOS' => %w[AMG MOR],
+                       ADR CLR BOS REV LEN SIR RRS WER PIC ARM
+                       HEL BYI],
+      'AmigaOS' => %w[AMG MOR ARO],
       'BlackBerry' => %w[BLB QNX],
       'Brew' => ['BMP'],
       'BeOS' => %w[BEO HAI],
@@ -212,17 +266,24 @@ class DeviceDetector
         ORD TOS RSO DEE FRE MAG FEN CAI PCL HAS
         LOS DVK ROK OWR OTV KTV PUR PLA FUC PAR
         FOR MON KAN ZEN LND LNS CHN AMZ TEN CST
-        NOV ROU ZOR VID
+        NOV ROU ZOR RED KAL ORA VID TIV BSN RAS
+        UOS PIO FRI LIR WEB SER ASP AOS LOO EUL
+        SCI ALP CLO ROC OVZ PVE RST EZX GNS JOL
+        TUR QTP WPO
       ],
       'Mac' => ['MAC'],
       'Mobile Gaming Console' => %w[PSP NDS XBX],
+      'OpenVMS' => ['OVS'],
       'Real-time OS' => %w[MTK TDX MRE JME REX],
-      'Other Mobile' => %w[WOS POS SBA TIZ SMG MAE],
+      'Other Mobile' => %w[WOS POS SBA TIZ SMG MAE LUN GEO],
       'Symbian' => %w[SYM SYS SY3 S60 S40],
-      'Unix' => %w[SOS AIX HPX BSD NBS OBS DFB SYL IRI T64 INF],
+      'Unix' => %w[
+        SOS AIX HPX BSD NBS OBS DFB SYL IRI T64
+        INF ELE GNX ULT NWS NXT SBL
+      ],
       'WebTV' => ['WTV'],
       'Windows' => ['WIN'],
-      'Windows Mobile' => %w[WPH WMO WCE WRT WIO],
+      'Windows Mobile' => %w[WPH WMO WCE WRT WIO KIN],
       'Other Smart TV' => ['WHS']
     }.freeze
 
@@ -230,6 +291,47 @@ class DeviceDetector
       oss.each { |os| h[os] = family }
     end.freeze
 
+    # https://github.com/matomo-org/device-detector/blob/75d88bbefb0182f9207c9f48dc39b1bc8c7cc43f/Parser/OperatingSystem.php#L295-L308
+    FIRE_OS_VERSION_MAPPING = {
+      '11' => '8',
+      '10' => '8',
+      '9' => '7',
+      '7' => '6',
+      '5' => '5',
+      '4.4.3' => '4.5.1',
+      '4.4.2' => '4',
+      '4.2.2' => '3',
+      '4.0.3' => '3',
+      '4.0.2' => '3',
+      '4' => '2',
+      '2' => '1',
+    }.freeze
+
+    # https://github.com/matomo-org/device-detector/blob/75d88bbefb0182f9207c9f48dc39b1bc8c7cc43f/Parser/OperatingSystem.php#L315-L337
+    LINEAGE_OS_VERSION_MAPPING = {
+      '14' => '21',
+      '13' => '20.0',
+      '12.1' => '19.1',
+      '12' => '19.0',
+      '11' => '18.0',
+      '10' => '17.0',
+      '9' => '16.0',
+      '8.1.0' => '15.1',
+      '8.0.0' => '15.0',
+      '7.1.2' => '14.1',
+      '7.1.1' => '14.1',
+      '7.0' => '14.0',
+      '6.0.1' => '13.0',
+      '6.0' => '13.0',
+      '5.1.1' => '12.1',
+      '5.0.2' => '12.0',
+      '5.0' => '12.0',
+      '4.4.4' => '11.0',
+      '4.3' => '10.2',
+      '4.2.2' => '10.1',
+      '4.0.4' => '9.1.0'
+    }.freeze
+
     def filenames
       ['oss.yml']
     end

data/lib/device_detector/parser.rb

@@ -60,18 +60,18 @@ class DeviceDetector
     def load_regexes(file_paths)
       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)
+        object = rewrite_device_object!(object) if device_yml_file?(full_path)
+        object = rewrite_vendor_object!(object) if vendor_yml_file?(full_path)
 
         [path, symbolize_keys!(object)]
       end
     end
 
-    def is_device_yml_file?(file_path)
+    def device_yml_file?(file_path)
       file_path.include?('/regexes/device/')
     end
 
-    def is_vendor_yml_file?(file_path)
+    def vendor_yml_file?(file_path)
       file_path.include?('/regexes/vendorfragments')
     end
 
@@ -101,13 +101,14 @@ class DeviceDetector
         raise "invalid device spec: #{meta.inspect}" unless meta[:regex].is_a? String
 
         meta[:regex] = build_regex(meta[:regex])
+        meta[:versions].each { |v| v[:regex] = build_regex(v[:regex]) } if meta.key?(:versions)
         meta[:path] = path
         meta
       end
     end
 
     def build_regex(src)
-      Regexp.new('(?:^|[^A-Z0-9\-_]|[^A-Z0-9\-]_|sprd-|MZ-)(?:' + src + ')', Regexp::IGNORECASE)
+      Regexp.new("(?:^|[^A-Z0-9_-]|[^A-Z0-9-]_|sprd-|MZ-)(?:#{src})", Regexp::IGNORECASE)
     end
 
     def from_cache(key, &block)

data/lib/device_detector/version.rb

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

data/lib/device_detector.rb

@@ -23,11 +23,11 @@ class DeviceDetector
   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)
+    @user_agent = build_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)
+  # https://github.com/matomo-org/device-detector/blob/a2535ff3b63e4187f1d3440aed24ff43d74fb7f1/Parser/Device/AbstractDeviceParser.php#L2065-L2073
+  def build_user_agent(user_agent)
     return user_agent if client_hint.model.nil?
 
     regex = build_regex('Android 10[.\d]*; K(?: Build/|[;)])')
@@ -35,7 +35,7 @@ class DeviceDetector
 
     version = client_hint.os_version || '10'
 
-    user_agent.gsub(regex, "Android #{version}, #{client_hint.model}")
+    user_agent.gsub(/(Android 10[.\d]*; K)/, "Android #{version}; #{client_hint.model}")
   end
 
   def encode_user_agent_if_needed(user_agent)
@@ -52,7 +52,7 @@ class DeviceDetector
   end
 
   def full_version
-    client_hint.platform_version || client.full_version
+    client_hint.full_version || client.full_version
   end
 
   def os_family
@@ -69,6 +69,8 @@ class DeviceDetector
 
   def os_full_version
     return if skip_os_version?
+    return os.full_version if pico_os_fix?
+    return fire_os_version if fire_os_fix?
 
     client_hint.os_version || os.full_version
   end
@@ -84,7 +86,7 @@ class DeviceDetector
 
     # Assume all devices running iOS / Mac OS are from Apple
     brand = device.brand
-    brand = 'Apple' if brand.nil? && %w[iPadOS tvOS watchOS iOS Mac].include?(os_name)
+    brand = 'Apple' if brand.nil? && DeviceDetector::OS::APPLE_OS_NAMES.include?(os_name)
 
     brand
   end
@@ -92,6 +94,8 @@ class DeviceDetector
   def device_type
     t = device.type
 
+    t = nil if fake_ua?
+
     # Chrome on Android passes the device type based on the keyword 'Mobile'
     # If it is present the device should be a smartphone, otherwise it's a tablet
     # See https://developer.chrome.com/multidevice/user-agent#chrome_for_android_user_agent
@@ -99,21 +103,23 @@ class DeviceDetector
     # 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 user_agent =~ build_regex('(?:Mobile|eliboM) Safari\/')
-        t = 'smartphone'
-      elsif user_agent =~ build_regex('(?!Mobile )Safari\/')
-        t = 'tablet'
-      end
+      t = user_agent =~ build_regex('(?:Mobile|eliboM)') ? 'smartphone' : 'tablet'
     end
 
+    # Some UA contain the fragment 'Pad/APad', so we assume those devices as tablets
+    t = 'tablet' if t == 'smartphone' && user_agent =~ build_regex('Pad\/APad')
+
     # Some UA contain the fragment 'Android; Tablet;' or 'Opera Tablet', so we assume those devices
     # as tablets
-    t = 'tablet' if t.nil? && android_tablet_fragment? || opera_tablet?
+    t = 'tablet' if t.nil? && (android_tablet_fragment? || opera_tablet?)
 
     # Some user agents simply contain the fragment 'Android; Mobile;', so we assume those devices
     # as smartphones
     t = 'smartphone' if t.nil? && android_mobile_fragment?
 
+    # Some UA contains the 'Android; Mobile VR;' fragment
+    t = 'wearable' if t.nil? && android_vr_fragment?
+
     # Android up to 3.0 was designed for smartphones only. But as 3.0,
     # which was tablet only, was published too late, there were a
     # bunch of tablets running with 2.x With 4.0 the two trees were
@@ -156,14 +162,18 @@ class DeviceDetector
     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')
+    if user_agent =~ build_regex('Andr0id|(?:Android(?: UHD)?|Google) TV|\(lite\) TV|BRAVIA')
+      t = 'tv'
+    end
 
     # 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
+    # Devices running those clients are assumed to be a TV
     t = 'tv' if ['Kylo', 'Espial TV Browser', 'LUJO TV Browser', 'LogicUI TV Browser',
-                 'Open TV Browser'].include?(name)
+                 'Open TV Browser', 'Seraphic Sraf', 'Opera Devices', 'Crow Browser',
+                 'Vewd Browser', 'TiviMate', 'Quick Search TV', 'QJY TV Browser',
+                 'TV Bro'].include?(name)
 
     # All devices containing TV fragment are assumed to be a tv
     t = 'tv' if t.nil? && user_agent =~ build_regex('\(TV;')
@@ -233,9 +243,9 @@ class DeviceDetector
     @os ||= OS.new(user_agent)
   end
 
-  # https://github.com/matomo-org/device-detector/blob/827a3fab7e38c3274c18d2f5f5bc2a78b7ef4a3a/DeviceDetector.php#L921C5-L921C5
+  # https://github.com/matomo-org/device-detector/blob/67ae11199a5129b42fa8b985d372ea834104fe3a/DeviceDetector.php#L931-L938
   def fake_ua?
-    os_name == 'Android' && device.brand == 'Apple'
+    device.brand == 'Apple' && !DeviceDetector::OS::APPLE_OS_NAMES.include?(os_name)
   end
 
   # https://github.com/matomo-org/device-detector/blob/be1c9ef486c247dc4886668da5ed0b1c49d90ba8/Parser/Client/Browser.php#L772
@@ -245,7 +255,9 @@ class DeviceDetector
   end
 
   def linux_fix?
-    client_hint.platform == 'Linux' && os.name == 'Android' && client_hint.mobile == '?0'
+    client_hint.platform == 'Linux' &&
+      %w[iOS Android].include?(os.name) &&
+      %w[?0 0].include?(client_hint.mobile)
   end
 
   # Related to issue mentionned in device.rb#1562
@@ -253,20 +265,41 @@ class DeviceDetector
     user_agent&.include?('X-music Ⅲ') ? 'X-Music III' : nil
   end
 
+  def pico_os_fix?
+    client_hint.os_name == 'Pico OS'
+  end
+
+  # https://github.com/matomo-org/device-detector/blob/323629cb679c8572a9745cba9c3803fee13f3cf6/Parser/OperatingSystem.php#L398-L403
+  def fire_os_fix?
+    !client_hint.platform.nil? && os.name == 'Fire OS'
+  end
+
+  def fire_os_version
+    DeviceDetector::OS
+      .mapped_os_version(client_hint.os_version, DeviceDetector::OS::FIRE_OS_VERSION_MAPPING)
+  end
+
+  # https://github.com/matomo-org/device-detector/blob/323629cb679c8572a9745cba9c3803fee13f3cf6/Parser/OperatingSystem.php#L378-L383
   def skip_os_version?
-    !client_hint.os_family.nil? && client_hint.os_family != os.family
+    !client_hint.os_family.nil? &&
+      client_hint.os_version.nil? &&
+      client_hint.os_family != os.family
   end
 
   def android_tablet_fragment?
-    user_agent =~ build_regex('Android( [\.0-9]+)?; Tablet;')
+    user_agent =~ build_regex('Android( [\.0-9]+)?; Tablet;|Tablet(?! PC)|.*\-tablet$')
   end
 
   def android_mobile_fragment?
-    user_agent =~ build_regex('Android( [\.0-9]+)?; Mobile;')
+    user_agent =~ build_regex('Android( [\.0-9]+)?; Mobile;|.*\-mobile$')
+  end
+
+  def android_vr_fragment?
+    user_agent =~ build_regex('Android( [\.0-9]+)?; Mobile VR;| VR ')
   end
 
   def desktop_fragment?
-    user_agent =~ build_regex('Desktop (x(?:32|64)|WOW64);')
+    user_agent =~ build_regex('Desktop(?: (x(?:32|64)|WOW64))?;')
   end
 
   def touch_enabled?
@@ -300,7 +333,7 @@ class DeviceDetector
     # Check for browsers available for mobile devices only
     return false if uses_mobile_browser?
 
-    os.desktop?
+    DeviceDetector::OS::DESKTOP_OSS.include?(os_family)
   end
 
   def build_regex(src)