mirror of
https://github.com/Lastorder-DC/rhymix.git
synced 2026-01-03 16:51:40 +09:00
480 lines
12 KiB
PHP
480 lines
12 KiB
PHP
<?php
|
|
|
|
namespace Rhymix\Framework;
|
|
|
|
/**
|
|
* The user-agent class.
|
|
*/
|
|
class UA
|
|
{
|
|
/**
|
|
* Public properties to be used in getBrowserInfo().
|
|
*/
|
|
public $browser;
|
|
public $version;
|
|
public $os;
|
|
public $os_version;
|
|
public $device;
|
|
public $is_mobile;
|
|
public $is_tablet;
|
|
public $is_webview;
|
|
public $is_robot;
|
|
|
|
/**
|
|
* Cache to prevent multiple lookups.
|
|
*/
|
|
protected static $_mobile_cache = array();
|
|
protected static $_tablet_cache = array();
|
|
protected static $_robot_cache = array();
|
|
|
|
/**
|
|
* Windows version lookup table.
|
|
*/
|
|
protected static $_windows_versions = array(
|
|
'5.1' => 'XP',
|
|
'5.2' => 'XP',
|
|
'6.0' => 'Vista',
|
|
'6.1' => '7',
|
|
'6.2' => '8',
|
|
'6.3' => '8.1',
|
|
);
|
|
|
|
/**
|
|
* Check whether the current visitor is using a mobile device.
|
|
*
|
|
* @param string $ua (optional)
|
|
* @return bool
|
|
*/
|
|
public static function isMobile(?string $ua = null): bool
|
|
{
|
|
// Get the User-Agent header if the caller did not specify $ua.
|
|
if ($ua === null)
|
|
{
|
|
$ua = isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : null;
|
|
$using_header = true;
|
|
}
|
|
else
|
|
{
|
|
$using_header = false;
|
|
}
|
|
|
|
// If the User-Agent header is missing, it's probably not a mobile browser.
|
|
if (is_null($ua))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Look for headers that are only used in mobile browsers.
|
|
if ($using_header && (isset($_SERVER['HTTP_X_WAP_PROFILE']) || isset($_SERVER['HTTP_X_OPERAMINI_PHONE_UA'])))
|
|
{
|
|
return true;
|
|
}
|
|
|
|
// Look up the cache.
|
|
if (isset(self::$_mobile_cache[$ua]))
|
|
{
|
|
return self::$_mobile_cache[$ua];
|
|
}
|
|
|
|
// Look for the 'mobile' keyword and common mobile platform names.
|
|
if (preg_match('/android|ip(hone|ad|od)|blackberry|nokia|palm|mobile/i', $ua))
|
|
{
|
|
return self::$_mobile_cache[$ua] = true;
|
|
}
|
|
|
|
// Look for common non-mobile OS names.
|
|
if (preg_match('/windows|linux|os [x9]|bsd/i', $ua))
|
|
{
|
|
return self::$_mobile_cache[$ua] = false;
|
|
}
|
|
|
|
// Look for other platform, manufacturer, and device names that are known to be mobile.
|
|
if (preg_match('/kindle|opera (mini|mobi)|polaris|netfront|fennec|motorola|symbianos|webos/i', $ua))
|
|
{
|
|
return self::$_mobile_cache[$ua] = true;
|
|
}
|
|
if (preg_match('/s[pgc]h-|lgtelecom|sonyericsson|alcatel|vodafone|maemo|minimo|bada/i', $ua))
|
|
{
|
|
return self::$_mobile_cache[$ua] = true;
|
|
}
|
|
|
|
// If we're here, it's probably not a mobile device.
|
|
return self::$_mobile_cache[$ua] = false;
|
|
}
|
|
|
|
/**
|
|
* Check whether the current visitor is using a tablet.
|
|
*
|
|
* @param string $ua (optional)
|
|
* @return bool
|
|
*/
|
|
public static function isTablet(?string $ua = null): bool
|
|
{
|
|
// Get the User-Agent header if the caller did not specify $ua.
|
|
$ua = $ua ?: ($_SERVER['HTTP_USER_AGENT'] ?? null);
|
|
|
|
// If the User-Agent header is missing, it's probably not a tablet.
|
|
if (is_null($ua))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Look up the cache.
|
|
if (isset(self::$_tablet_cache[$ua]))
|
|
{
|
|
return self::$_tablet_cache[$ua];
|
|
}
|
|
|
|
// Check if the user-agent is mobile.
|
|
if (!self::isMobile($ua))
|
|
{
|
|
return self::$_tablet_cache[$ua] = false;
|
|
}
|
|
|
|
// Check for Android tablets without the 'mobile' keyword.
|
|
if (stripos($ua, 'android') !== false && stripos($ua, 'mobile') === false)
|
|
{
|
|
return self::$_tablet_cache[$ua] = true;
|
|
}
|
|
|
|
// Check for common tablet identifiers.
|
|
if (preg_match('/tablet|pad\b|tab\b|\bgt-\d+|kindle|nook|playbook|webos|xoom/i', $ua))
|
|
{
|
|
return self::$_tablet_cache[$ua] = true;
|
|
}
|
|
|
|
// If we're here, it's probably not a tablet.
|
|
return self::$_tablet_cache[$ua] = false;
|
|
}
|
|
|
|
/**
|
|
* Check whether the current visitor is a robot.
|
|
*
|
|
* @param string $ua (optional)
|
|
* @return bool
|
|
*/
|
|
public static function isRobot(?string $ua = null): bool
|
|
{
|
|
// Get the User-Agent header if the caller did not specify $ua.
|
|
$ua = $ua ?: ($_SERVER['HTTP_USER_AGENT'] ?? null);
|
|
|
|
// If the User-Agent header is missing, it's probably not a robot.
|
|
if (is_null($ua))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Look up the cache.
|
|
if (isset(self::$_robot_cache[$ua]))
|
|
{
|
|
return self::$_robot_cache[$ua];
|
|
}
|
|
|
|
// Look for common search engine names and the 'bot' keyword.
|
|
if (preg_match('/bot|spider|crawler|archiver|wget|curl|php|slurp|wordpress|facebook|external(agent|fetcher)|teoma|yeti|daum|apachebench|googleother|mediapartners-google|[(<+]https?:|@/i', $ua))
|
|
{
|
|
return self::$_robot_cache[$ua] = true;
|
|
}
|
|
|
|
// Use the custom user-agent list.
|
|
$customlist = Config::get('security.robot_user_agents') ?: array();
|
|
foreach ($customlist as $item)
|
|
{
|
|
if (strpos($ua, $item) !== false)
|
|
{
|
|
return self::$_robot_cache[$ua] = true;
|
|
}
|
|
}
|
|
|
|
// If we're here, it's probably not a robot.
|
|
return self::$_robot_cache[$ua] = false;
|
|
}
|
|
|
|
/**
|
|
* This method parses the Accept-Language header to guess the browser's default locale.
|
|
*
|
|
* @param string $header (optional)
|
|
* @return string
|
|
*/
|
|
public static function getLocale(?string $header = null): string
|
|
{
|
|
// Get the Accept-Language header if the caller did not specify $header.
|
|
$header = $header ?: ($_SERVER['HTTP_ACCEPT_LANGUAGE'] ?? 'en-US');
|
|
|
|
// Return the first locale name found.
|
|
return preg_match('/^([a-z0-9_-]+)/i', $header, $matches) ? $matches[1] : 'en-US';
|
|
}
|
|
|
|
/**
|
|
* This method parses the User-Agent string to guess what kind of browser it is.
|
|
*
|
|
* @param string $ua (optional)
|
|
* @return self
|
|
*/
|
|
public static function getBrowserInfo(?string $ua = null): self
|
|
{
|
|
// Get the User-Agent header if the caller did not specify $ua.
|
|
$ua = $ua ?: ($_SERVER['HTTP_USER_AGENT'] ?? null);
|
|
|
|
// Initialize the result.
|
|
$result = new self;
|
|
if (is_null($ua))
|
|
{
|
|
return $result;
|
|
}
|
|
|
|
// Try to guess the OS.
|
|
if (preg_match('#(Windows|Android|Linux|i(?:Phone|P[ao]d)|OS X|Macintosh)#i', $ua, $matches))
|
|
{
|
|
if ($matches[1] === 'Linux' && strpos($ua, 'Android') !== false)
|
|
{
|
|
$result->os = 'Android';
|
|
if (preg_match('#Android ([0-9\.]+);(?: ([^;]+) Build/)?#', $ua, $matches))
|
|
{
|
|
$result->os_version = $matches[1];
|
|
$result->device = isset($matches[2]) ? ($matches[2] ?: null) : null;
|
|
}
|
|
}
|
|
elseif ($matches[1] === 'iPhone' || $matches[1] === 'iPad' || $matches[1] === 'iPod')
|
|
{
|
|
$result->os = 'iOS';
|
|
if (preg_match('#(i(?:Phone|P[ao]d)); (?:.+?) OS ([0-9_\.]+)#s', $ua, $matches))
|
|
{
|
|
$result->os_version = str_replace('_', '.', $matches[2]);
|
|
$result->device = $matches[1];
|
|
}
|
|
}
|
|
elseif ($matches[1] === 'Macintosh' || $matches[1] === 'OS X')
|
|
{
|
|
$result->os = 'macOS';
|
|
if (preg_match('#OS X ([0-9_\.]+)#', $ua, $matches))
|
|
{
|
|
$result->os_version = str_replace('_', '.', $matches[1]);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$result->os = $matches[1];
|
|
if (preg_match('#Windows NT ([0-9\.]+)#', $ua, $matches))
|
|
{
|
|
$result->os_version = isset(self::$_windows_versions[$matches[1]]) ? self::$_windows_versions[$matches[1]] : $matches[1];
|
|
}
|
|
}
|
|
}
|
|
|
|
// Fill in miscellaneous fields.
|
|
$result->is_mobile = self::isMobile($ua);
|
|
$result->is_tablet = self::isTablet($ua);
|
|
$result->is_webview = strpos($ua, '; wv)') !== false;
|
|
$result->is_robot = self::isRobot($ua);
|
|
|
|
// Try to match some of the most common browsers.
|
|
if ($result->os === 'Android' && preg_match('#Android ([0-9]+\\.[0-9]+)#', $ua, $matches))
|
|
{
|
|
if (strpos($ua, 'Chrome') === false || preg_match('#(?:Version|Browser)/[0-9]+#', $ua) || preg_match('#\\bwv\\b#', $ua))
|
|
{
|
|
$result->browser = 'Android';
|
|
$result->version = $matches[1];
|
|
return $result;
|
|
}
|
|
}
|
|
if (preg_match('#Edg(?:e|A|iOS)?/([0-9]+\\.)#', $ua, $matches))
|
|
{
|
|
$result->browser = 'Edge';
|
|
$result->version = $matches[1] . '0';
|
|
return $result;
|
|
}
|
|
if (preg_match('#Trident/([0-9]+)\\.[0-9]+#', $ua, $matches))
|
|
{
|
|
$result->browser = 'IE';
|
|
$result->version = ($matches[1] + 4) . '.0';
|
|
return $result;
|
|
}
|
|
if (preg_match('#(MSIE|OPR|CriOS|Firefox|FxiOS|Iceweasel|Whale|Yeti|[a-z]+(?:bot|spider)(?:-Image)?|wget|curl)[ /:]([0-9]+\\.[0-9]+)#i', $ua, $matches))
|
|
{
|
|
if ($matches[1] === 'MSIE')
|
|
{
|
|
$result->browser = 'IE';
|
|
}
|
|
elseif ($matches[1] === 'CriOS')
|
|
{
|
|
$result->browser = 'Chrome';
|
|
}
|
|
elseif ($matches[1] === 'FxiOS' || $matches[1] === 'Iceweasel')
|
|
{
|
|
$result->browser = 'Firefox';
|
|
}
|
|
elseif ($matches[1] === 'OPR')
|
|
{
|
|
$result->browser = 'Opera';
|
|
}
|
|
else
|
|
{
|
|
$result->browser = ucfirst($matches[1]);
|
|
}
|
|
$result->version = $matches[2];
|
|
return $result;
|
|
}
|
|
if (preg_match('#(?:Opera|OPR)[/ ]([0-9]+\\.[0-9]+)#', $ua, $matches))
|
|
{
|
|
$result->browser = 'Opera';
|
|
if ($matches[1] >= 9.79 && preg_match('#Version/([0-9]+\\.[0-9]+)#', $ua, $operamatches))
|
|
{
|
|
$result->version = $operamatches[1];
|
|
}
|
|
else
|
|
{
|
|
$result->version = $matches[1];
|
|
}
|
|
return $result;
|
|
}
|
|
if (preg_match('#(?:Konqueror|KHTML)/([0-9]+\\.[0-9]+)$#', $ua, $matches))
|
|
{
|
|
$result->browser = 'Konqueror';
|
|
$result->version = $matches[1];
|
|
return $result;
|
|
}
|
|
if (preg_match('#Chrome/([0-9]+\\.[0-9]+)#', $ua, $matches))
|
|
{
|
|
$result->browser = 'Chrome';
|
|
$result->version = $matches[1];
|
|
return $result;
|
|
}
|
|
if (preg_match('#Safari/[0-9]+#', $ua) && preg_match('#Version/([0-9]+\\.[0-9]+)#', $ua, $matches) && $matches[1] < 500)
|
|
{
|
|
$result->browser = 'Safari';
|
|
$result->version = $matches[1];
|
|
return $result;
|
|
}
|
|
if (preg_match('#\\bPHP(/[0-9]+\\.[0-9]+)?#', $ua, $matches))
|
|
{
|
|
$result->browser = 'PHP';
|
|
$result->version = (isset($matches[1]) && $matches[1]) ? substr($matches[1], 1) : null;
|
|
return $result;
|
|
}
|
|
if (preg_match('#^Mozilla/([0-9]+\\.[0-9]+)#', $ua, $matches))
|
|
{
|
|
$result->browser = 'Mozilla';
|
|
$result->version = $matches[1];
|
|
return $result;
|
|
}
|
|
if (preg_match('#^([a-zA-Z0-9_-]+)(?:/([0-9]+\\.[0-9]+))?#', $ua, $matches))
|
|
{
|
|
$result->browser = ucfirst($matches[1]);
|
|
$result->version = isset($matches[2]) ? ($matches[2] ?: null) : null;
|
|
return $result;
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* This method encodes a UTF-8 filename for downloading in the current visitor's browser.
|
|
*
|
|
* See: https://blog.bloodcat.com/302
|
|
*
|
|
* @param string $filename
|
|
* @param string $ua (optional)
|
|
* @return string
|
|
*/
|
|
public static function encodeFilenameForDownload(string $filename, ?string $ua = null): string
|
|
{
|
|
// Get the User-Agent header if the caller did not specify $ua.
|
|
$ua = $ua ?: ($_SERVER['HTTP_USER_AGENT'] ?? null);
|
|
|
|
// Get the browser name and version.
|
|
$browser = self::getBrowserInfo($ua);
|
|
|
|
// Find the best format that this browser supports.
|
|
if ($browser->browser === 'Chrome' && $browser->version >= 11 & !$browser->is_webview)
|
|
{
|
|
$output_format = 'rfc5987';
|
|
}
|
|
elseif ($browser->browser === 'Firefox' && $browser->version >= 6)
|
|
{
|
|
$output_format = 'rfc5987';
|
|
}
|
|
elseif ($browser->browser === 'Safari' && $browser->version >= 6)
|
|
{
|
|
$output_format = 'rfc5987';
|
|
}
|
|
elseif ($browser->browser === 'IE' && $browser->version >= 10)
|
|
{
|
|
$output_format = 'rfc5987';
|
|
}
|
|
elseif ($browser->browser === 'Edge')
|
|
{
|
|
$output_format = 'rfc5987';
|
|
}
|
|
elseif ($browser->browser === 'IE')
|
|
{
|
|
$output_format = 'old_ie';
|
|
}
|
|
elseif ($browser->browser === 'Android' || $browser->browser === 'Whale' || $browser->is_webview)
|
|
{
|
|
$output_format = 'raw';
|
|
}
|
|
elseif ($browser->browser === 'Chrome' || $browser->browser === 'Safari')
|
|
{
|
|
$output_format = 'raw';
|
|
}
|
|
else
|
|
{
|
|
$output_format = 'old_ie';
|
|
}
|
|
|
|
// Clean the filename.
|
|
$filename = Filters\FilenameFilter::clean($filename);
|
|
|
|
// Apply the format and return.
|
|
switch ($output_format)
|
|
{
|
|
case 'raw':
|
|
return 'filename="' . $filename . '"';
|
|
|
|
case 'rfc5987':
|
|
$filename = rawurlencode($filename);
|
|
return "filename*=UTF-8''" . $filename;
|
|
|
|
case 'old_ie':
|
|
default:
|
|
$filename = rawurlencode($filename);
|
|
return 'filename="' . preg_replace('/\./', '%2e', $filename, substr_count($filename, '.') - 1) . '"';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the current color scheme (auto, light, dark)
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function getColorScheme(): string
|
|
{
|
|
if (isset($_COOKIE['rx_color_scheme']) && in_array($_COOKIE['rx_color_scheme'], ['light', 'dark']))
|
|
{
|
|
return strval($_COOKIE['rx_color_scheme']);
|
|
}
|
|
else
|
|
{
|
|
return 'auto';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set the color scheme (auto, light, dark)
|
|
*
|
|
* @param string $color_scheme
|
|
* @return void
|
|
*/
|
|
public static function setColorScheme(string $color_scheme): void
|
|
{
|
|
if (in_array($color_scheme, ['light', 'dark']))
|
|
{
|
|
Cookie::set('rx_color_scheme', $color_scheme, ['expires' => 365, 'path' => \RX_BASEURL]);
|
|
}
|
|
else
|
|
{
|
|
Cookie::remove('rx_color_scheme');
|
|
}
|
|
}
|
|
}
|