From c20ac2d6ea33159089724f2bda526bfeae1e7fc4 Mon Sep 17 00:00:00 2001 From: Michael M Slusarz Date: Mon, 12 Jan 2009 15:06:00 -0700 Subject: [PATCH] Add Horde_Browser package from CVS HEAD --- framework/Browser/lib/Horde/Browser.php | 1234 +++++++++++++++++++++++++ framework/Browser/lib/Horde/Browser/Imode.php | 465 ++++++++++ framework/Browser/package.xml | 100 ++ 3 files changed, 1799 insertions(+) create mode 100644 framework/Browser/lib/Horde/Browser.php create mode 100644 framework/Browser/lib/Horde/Browser/Imode.php create mode 100644 framework/Browser/package.xml diff --git a/framework/Browser/lib/Horde/Browser.php b/framework/Browser/lib/Horde/Browser.php new file mode 100644 index 000000000..e35a0accf --- /dev/null +++ b/framework/Browser/lib/Horde/Browser.php @@ -0,0 +1,1234 @@ + + * @author Jon Parise + * @package Horde_Browser + */ +class Horde_Browser +{ + /** + * Major version number. + * + * @var integer + */ + protected $_majorVersion = 0; + + /** + * Minor version number. + * + * @var integer + */ + protected $_minorVersion = 0; + + /** + * Browser name. + * + * @var string + */ + protected $_browser = ''; + + /** + * Full user agent string. + * + * @var string + */ + protected $_agent = ''; + + /** + * Lower-case user agent string. + * + * @var string + */ + protected $_lowerAgent = ''; + + /** + * HTTP_ACCEPT string + * + * @var string + */ + protected $_accept = ''; + + /** + * Platform the browser is running on. + * + * @var string + */ + protected $_platform = ''; + + /** + * Known robots. + * + * @var array + */ + protected $_robotAgents = array( + /* The most common ones. */ + 'Googlebot', + 'msnbot', + 'Slurp', + 'Yahoo', + /* The rest alphabetically. */ + 'appie', + 'Arachnoidea', + 'ArchitextSpider', + 'Ask Jeeves', + 'B-l-i-t-z-Bot', + 'Baiduspider', + 'BecomeBot', + 'cfetch', + 'ConveraCrawler', + 'ExtractorPro', + 'FAST-WebCrawler', + 'FDSE robot', + 'fido', + 'findlinks', + 'Francis', + 'geckobot', + 'Gigabot', + 'Girafabot', + 'grub-client', + 'Gulliver', + 'HTTrack', + 'ia_archiver', + 'iaskspider', + 'iCCrawler', + 'InfoSeek', + 'kinjabot', + 'KIT-Fireball', + 'larbin', + 'LEIA', + 'lmspider', + 'lwp-trivial', + 'Lycos_Spider', + 'Mediapartners-Google', + 'MSRBOT', + 'MuscatFerret', + 'NaverBot', + 'OmniExplorer_Bot', + 'polybot', + 'Pompos', + 'RufusBot', + 'Scooter', + 'Seekbot', + 'sogou spider', + 'sproose', + 'Teoma', + 'TheSuBot', + 'TurnitinBot', + 'Twiceler', + 'Ultraseek', + 'ViolaBot', + 'voyager', + 'W3C-checklink', + 'webbandit', + 'www.almaden.ibm.com/cs/crawler', + 'yacy', + 'ZyBorg', + ); + + /** + * Regexp for matching those robot strings. + * + * @var string + */ + protected $_robotAgentRegexp = null; + + /** + * List of mobile user agents. + * + * Browsers like Mobile Safari (iPhone, iPod Touch) are much more + * full featured than OpenWave style browsers. This makes it dicey + * in some cases to treat all "mobile" browsers the same way. + * + * @TODO This list is not used in isMobile yet nor does it provide + * the same results as isMobile(). It is here for reference and + * future work. + */ + protected $_mobileAgents = array( + 'Blackberry', + 'Blazer', + 'Handspring', + 'iPhone', + 'iPod', + 'Kyocera', + 'LG', + 'Motorola', + 'Nokia', + 'Palm', + 'PlayStation Portable', + 'Samsung', + 'Smartphone', + 'SonyEricsson', + 'Symbian', + 'WAP', + 'Windows CE', + ); + + /** + * List of televison user agents. + * + * @TODO This list is not yet used anywhere. It is here for future + * media-type differentiation. + */ + protected $_tvAgents = array( + 'Nintendo Wii', + 'Playstation 3', + 'WebTV', + ); + + /** + * Is this a mobile browser? + * + * @var boolean + */ + protected $_mobile = false; + + /** + * Features. + * + * @var array + */ + protected $_features = array( + 'html' => true, + 'hdml' => false, + 'wml' => false, + 'images' => true, + 'iframes' => false, + 'frames' => true, + 'tables' => true, + 'java' => true, + 'javascript' => true, + 'dom' => false, + 'utf' => false, + 'rte' => false, + 'homepage' => false, + 'accesskey' => false, + 'optgroup' => false, + 'xmlhttpreq' => false, + 'cite' => false, + 'issafari' => false, + // RFC 2397 + 'dataurl' => false, + ); + + /** + * Quirks + * + * @var array + */ + protected $_quirks = array( + 'avoid_popup_windows' => false, + 'break_disposition_header' => false, + 'break_disposition_filename' => false, + 'broken_multipart_form' => false, + 'buggy_compression' => false, + 'cache_same_url' => false, + 'cache_ssl_downloads' => false, + 'double_linebreak_textarea' => false, + 'empty_file_input_value' => false, + 'must_cache_forms' => false, + 'no_filename_spaces' => false, + 'no_hidden_overflow_tables' => false, + 'ow_gui_1.3' => false, + 'png_transparency' => false, + 'scrollbar_in_way' => false, + 'scroll_tds' => false, + 'windowed_controls' => false, + ); + + /** + * List of viewable image MIME subtypes. + * This list of viewable images works for IE and Netscape/Mozilla. + * + * @var array + */ + protected $_images = array('jpeg', 'gif', 'png', 'pjpeg', 'x-png', 'bmp'); + + /** + * Returns a reference to the global Browser object, only creating it if + * it doesn't already exist. + * + * This method must be invoked as: + * $browser = &Browser::singleton([$userAgent[, $accept]]); + * + * @param string $userAgent The browser string to parse. + * @param string $accept The HTTP_ACCEPT settings to use. + * + * @return Browser The Browser object. + */ + public static function &singleton($userAgent = null, $accept = null) + { + static $instances = array(); + + $signature = md5(serialize(array($userAgent, $accept))); + if (empty($instances[$signature])) { + $instances[$signature] = new Browser($userAgent, $accept); + } + + return $instances[$signature]; + } + + /** + * Creates a browser instance (Constructor). + * + * @param string $userAgent The browser string to parse. + * @param string $accept The HTTP_ACCEPT settings to use. + */ + public function __construct($userAgent = null, $accept = null) + { + $this->match($userAgent, $accept); + } + + /** + * Parses the user agent string and inititializes the object with all the + * known features and quirks for the given browser. + * + * @param string $userAgent The browser string to parse. + * @param string $accept The HTTP_ACCEPT settings to use. + */ + public function match($userAgent = null, $accept = null) + { + // Set our agent string. + if (is_null($userAgent)) { + if (isset($_SERVER['HTTP_USER_AGENT'])) { + $this->_agent = trim($_SERVER['HTTP_USER_AGENT']); + } + } else { + $this->_agent = $userAgent; + } + $this->_lowerAgent = String::lower($this->_agent); + + // Set our accept string. + if (is_null($accept)) { + if (isset($_SERVER['HTTP_ACCEPT'])) { + $this->_accept = String::lower(trim($_SERVER['HTTP_ACCEPT'])); + } + } else { + $this->_accept = String::lower($accept); + } + + // Check for UTF support. + if (isset($_SERVER['HTTP_ACCEPT_CHARSET'])) { + $this->setFeature('utf', strpos(String::lower($_SERVER['HTTP_ACCEPT_CHARSET']), 'utf') !== false); + } + + if (empty($this->_agent)) { + return; + } + + $this->_setPlatform(); + + // Use local scope for frequently accessed variables. + $agent = $this->_agent; + $lowerAgent = $this->_lowerAgent; + + if (strpos($lowerAgent, 'iemobile') !== false || + strpos($lowerAgent, 'mobileexplorer') !== false || + strpos($lowerAgent, 'openwave') !== false || + strpos($lowerAgent, 'opera mini') !== false || + strpos($lowerAgent, 'operamini') !== false) { + $this->setFeature('frames', false); + $this->setFeature('javascript', false); + $this->setQuirk('avoid_popup_windows'); + $this->_mobile = true; + } elseif (preg_match('|Opera[/ ]([0-9.]+)|', $agent, $version)) { + $this->setBrowser('opera'); + list($this->_majorVersion, $this->_minorVersion) = explode('.', $version[1]); + $this->setFeature('javascript'); + $this->setFeature('dataurl'); + $this->setQuirk('no_filename_spaces'); + + /* Opera Mobile reports its screen resolution in the user + * agent strings. */ + if (preg_match('/; (120x160|240x280|240x320|320x320)\)/', $agent)) { + $this->_mobile = true; + } + + if ($this->_majorVersion >= 7) { + if ($this->_majorVersion >= 8) { + $this->setFeature('xmlhttpreq'); + $this->setFeature('javascript', 1.5); + } + if (($this->_majorVersion >= 9) && + ($this->_minorVersion >= 5)) { + // Xinha supports (somewhat) 9.2, but fckeditor supports + // only 9.5+. + $this->setFeature('rte'); + } + $this->setFeature('dom'); + $this->setFeature('iframes'); + $this->setFeature('accesskey'); + $this->setFeature('optgroup'); + $this->setQuirk('double_linebreak_textarea'); + } + } elseif (strpos($lowerAgent, 'elaine/') !== false || + strpos($lowerAgent, 'palmsource') !== false || + strpos($lowerAgent, 'digital paths') !== false) { + $this->setBrowser('palm'); + $this->setFeature('images', false); + $this->setFeature('frames', false); + $this->setFeature('javascript', false); + $this->setQuirk('avoid_popup_windows'); + $this->_mobile = true; + } elseif ((preg_match('|MSIE ([0-9.]+)|', $agent, $version)) || + (preg_match('|Internet Explorer/([0-9.]+)|', $agent, $version))) { + $this->setBrowser('msie'); + $this->setQuirk('cache_ssl_downloads'); + $this->setQuirk('cache_same_url'); + $this->setQuirk('break_disposition_filename'); + + if (strpos($version[1], '.') !== false) { + list($this->_majorVersion, $this->_minorVersion) = explode('.', $version[1]); + } else { + $this->_majorVersion = $version[1]; + $this->_minorVersion = 0; + } + + /* IE (< 7) on Windows does not support alpha transparency + * in PNG images. */ + if (($this->_majorVersion < 7) && + preg_match('/windows/i', $agent)) { + $this->setQuirk('png_transparency'); + } + + /* IE 6 (pre-SP1) and 5.5 (pre-SP1) have buggy compression. + * The versions affected are as follows: + * 6.00.2462.0000 Internet Explorer 6 Public Preview (Beta) + * 6.00.2479.0006 Internet Explorer 6 Public Preview (Beta) Refresh + * 6.00.2600.0000 Internet Explorer 6 (Windows XP) + * 5.50.3825.1300 Internet Explorer 5.5 Developer Preview (Beta) + * 5.50.4030.2400 Internet Explorer 5.5 & Internet Tools Beta + * 5.50.4134.0100 Internet Explorer 5.5 for Windows Me (4.90.3000) + * 5.50.4134.0600 Internet Explorer 5.5 + * 5.50.4308.2900 Internet Explorer 5.5 Advanced Security Privacy Beta + * + * See: + * ==== + * http://support.microsoft.com/kb/164539; + * http://support.microsoft.com/default.aspx?scid=kb;en-us;Q312496) + * http://support.microsoft.com/default.aspx?scid=kb;en-us;Q313712 + */ + $ie_vers = $this->getIEVersion(); + $buggy_list = array( + '6,00,2462,0000', '6,0,2462,0', '6,00,2479,0006', + '6,0,2479,0006', '6,00,2600,0000', '6,0,2600,0', + '5,50,3825,1300', '5,50,4030,2400', '5,50,4134,0100', + '5,50,4134,0600', '5,50,4308,2900' + ); + if (!is_null($ie_vers) && in_array($ie_vers, $buggy_list)) { + $this->setQuirk('buggy_compression'); + } + + /* Some Handhelds have their screen resolution in the user + * agent string, which we can use to look for mobile + * agents. */ + if (preg_match('/; (120x160|240x280|240x320|320x320)\)/', $agent)) { + $this->_mobile = true; + } + + switch ($this->_majorVersion) { + case 8: + $this->setFeature('javascript', 1.4); + $this->setFeature('dom'); + $this->setFeature('iframes'); + $this->setFeature('utf'); + $this->setFeature('rte'); + $this->setFeature('homepage'); + $this->setFeature('accesskey'); + $this->setFeature('optgroup'); + $this->setFeature('xmlhttpreq'); + $this->setFeature('dataurl'); + break; + + case 7: + $this->setFeature('javascript', 1.4); + $this->setFeature('dom'); + $this->setFeature('iframes'); + $this->setFeature('utf'); + $this->setFeature('rte'); + $this->setFeature('homepage'); + $this->setFeature('accesskey'); + $this->setFeature('optgroup'); + $this->setFeature('xmlhttpreq'); + break; + + case 6: + $this->setFeature('javascript', 1.4); + $this->setFeature('dom'); + $this->setFeature('iframes'); + $this->setFeature('utf'); + $this->setFeature('rte'); + $this->setFeature('homepage'); + $this->setFeature('accesskey'); + $this->setFeature('optgroup'); + $this->setFeature('xmlhttpreq'); + $this->setQuirk('scrollbar_in_way'); + $this->setQuirk('broken_multipart_form'); + $this->setQuirk('windowed_controls'); + break; + + case 5: + if ($this->getPlatform() == 'mac') { + $this->setFeature('javascript', 1.2); + $this->setFeature('optgroup'); + } else { + // MSIE 5 for Windows. + $this->setFeature('javascript', 1.4); + $this->setFeature('dom'); + $this->setFeature('xmlhttpreq'); + if ($this->_minorVersion >= 5) { + $this->setFeature('rte'); + $this->setQuirk('windowed_controls'); + } + } + $this->setFeature('iframes'); + $this->setFeature('utf'); + $this->setFeature('homepage'); + $this->setFeature('accesskey'); + if ($this->_minorVersion == 5) { + $this->setQuirk('break_disposition_header'); + $this->setQuirk('broken_multipart_form'); + } + break; + + case 4: + $this->setFeature('javascript', 1.2); + $this->setFeature('accesskey'); + if ($this->_minorVersion > 0) { + $this->setFeature('utf'); + } + break; + + case 3: + $this->setFeature('javascript', 1.1); + $this->setQuirk('avoid_popup_windows'); + break; + } + } elseif (preg_match('|ANTFresco/([0-9]+)|', $agent, $version)) { + $this->setBrowser('fresco'); + $this->setFeature('javascript', 1.1); + $this->setQuirk('avoid_popup_windows'); + } elseif (strpos($lowerAgent, 'avantgo') !== false) { + $this->setBrowser('avantgo'); + $this->_mobile = true; + } elseif (preg_match('|Konqueror/([0-9]+)\.?([0-9]+)?|', $agent, $version) || + preg_match('|Safari/([0-9]+)\.?([0-9]+)?|', $agent, $version)) { + // Konqueror and Apple's Safari both use the KHTML + // rendering engine. + $this->setBrowser('konqueror'); + $this->setQuirk('empty_file_input_value'); + $this->setQuirk('no_hidden_overflow_tables'); + $this->setFeature('dataurl'); + + if (strpos($agent, 'Mobile') !== false || + strpos($agent, 'NokiaN') !== false || + strpos($agent, 'SymbianOS') !== false) { + // WebKit Mobile + $this->_mobile = true; + } + + $this->_majorVersion = $version[1]; + if (isset($version[2])) { + $this->_minorVersion = $version[2]; + } + + if (strpos($agent, 'Safari') !== false && + $this->_majorVersion >= 60) { + // Safari. + // TODO: Really need to identify as safari (or webkit), + // not konqueror. For now, hack around by setting feature + // 'issafari'. + //$this->setBrowser('safari'); + $this->setFeature('issafari'); + + // Truly annoying - Safari did not start putting real version + // numbers until Version 3. + if (preg_match('|Version/([0-9.]+)|', $agent, $version_string)) { + list($this->_majorVersion, $this->_minorVersion) = explode('.', $version_string[1], 2); + $this->_minorVersion = intval($this->_minorVersion); + // Safari 3 works with both FCKEditor (2.6) and Xinha + // (0.95) packaged with Horde as of 3.2. + $this->setFeature('rte'); + } elseif ($this->_majorVersion >= 412) { + $this->_majorVersion = 2; + $this->_minorVersion = 0; + } else { + if ($this->_majorVersion >= 312) { + $this->_minorVersion = 3; + } elseif ($this->_majorVersion >= 124) { + $this->_minorVersion = 2; + } else { + $this->_minorVersion = 0; + } + $this->_majorVersion = 1; + } + + $this->setFeature('utf'); + $this->setFeature('javascript', 1.4); + $this->setFeature('dom'); + $this->setFeature('iframes'); + if ($this->_majorVersion > 1 || $this->_minorVersion > 2) { + // As of Safari 1.3 + $this->setFeature('accesskey'); + $this->setFeature('xmlhttpreq'); + } + } else { + // Konqueror. + $this->setFeature('javascript', 1.1); + switch ($this->_majorVersion) { + case 4: + case 3: + $this->setFeature('dom'); + $this->setFeature('iframes'); + if ($this->_minorVersion >= 5 || $this->_majorVersion == 4) { + $this->setFeature('accesskey'); + $this->setFeature('xmlhttpreq'); + } + break; + } + } + } elseif (preg_match('|Mozilla/([0-9.]+)|', $agent, $version)) { + $this->setBrowser('mozilla'); + $this->setQuirk('must_cache_forms'); + $this->setFeature('dataurl'); + + list($this->_majorVersion, $this->_minorVersion) = explode('.', $version[1]); + switch ($this->_majorVersion) { + case 5: + if ($this->getPlatform() == 'win') { + $this->setQuirk('break_disposition_filename'); + } + $this->setFeature('javascript', 1.4); + $this->setFeature('dom'); + $this->setFeature('accesskey'); + $this->setFeature('optgroup'); + $this->setFeature('xmlhttpreq'); + $this->setFeature('cite'); + if (preg_match('|rv:(.*)\)|', $agent, $revision)) { + if ($revision[1] >= 1) { + $this->setFeature('iframes'); + } + if ($revision[1] >= 1.3) { + $this->setFeature('rte'); + } + } + break; + + case 4: + $this->setFeature('javascript', 1.3); + $this->setQuirk('buggy_compression'); + break; + + case 3: + default: + $this->setFeature('javascript', 1); + $this->setQuirk('buggy_compression'); + break; + } + } elseif (preg_match('|Lynx/([0-9]+)|', $agent, $version)) { + $this->setBrowser('lynx'); + $this->setFeature('images', false); + $this->setFeature('frames', false); + $this->setFeature('javascript', false); + $this->setQuirk('avoid_popup_windows'); + } elseif (preg_match('|Links \(([0-9]+)|', $agent, $version)) { + $this->setBrowser('links'); + $this->setFeature('images', false); + $this->setFeature('frames', false); + $this->setFeature('javascript', false); + $this->setQuirk('avoid_popup_windows'); + } elseif (preg_match('|HotJava/([0-9]+)|', $agent, $version)) { + $this->setBrowser('hotjava'); + $this->setFeature('javascript', false); + } elseif (strpos($agent, 'UP/') !== false || + strpos($agent, 'UP.B') !== false || + strpos($agent, 'UP.L') !== false) { + $this->setBrowser('up'); + $this->setFeature('html', false); + $this->setFeature('javascript', false); + $this->setFeature('hdml'); + $this->setFeature('wml'); + + if (strpos($agent, 'GUI') !== false && + strpos($agent, 'UP.Link') !== false) { + /* The device accepts Openwave GUI extensions for WML + * 1.3. Non-UP.Link gateways sometimes have problems, + * so exclude them. */ + $this->setQuirk('ow_gui_1.3'); + } + $this->_mobile = true; + } elseif (strpos($agent, 'Xiino/') !== false) { + $this->setBrowser('xiino'); + $this->setFeature('hdml'); + $this->setFeature('wml'); + $this->_mobile = true; + } elseif (strpos($agent, 'Palmscape/') !== false) { + $this->setBrowser('palmscape'); + $this->setFeature('javascript', false); + $this->setFeature('hdml'); + $this->setFeature('wml'); + $this->_mobile = true; + } elseif (strpos($agent, 'Nokia') !== false) { + $this->setBrowser('nokia'); + $this->setFeature('html', false); + $this->setFeature('wml'); + $this->setFeature('xhtml'); + $this->_mobile = true; + } elseif (strpos($agent, 'Ericsson') !== false) { + $this->setBrowser('ericsson'); + $this->setFeature('html', false); + $this->setFeature('wml'); + $this->_mobile = true; + } elseif (strpos($agent, 'Grundig') !== false) { + $this->setBrowser('grundig'); + $this->setFeature('xhtml'); + $this->setFeature('wml'); + $this->_mobile = true; + } elseif (strpos($agent, 'NetFront') !== false) { + $this->setBrowser('netfront'); + $this->setFeature('xhtml'); + $this->setFeature('wml'); + $this->_mobile = true; + } elseif (strpos($lowerAgent, 'wap') !== false) { + $this->setBrowser('wap'); + $this->setFeature('html', false); + $this->setFeature('javascript', false); + $this->setFeature('hdml'); + $this->setFeature('wml'); + $this->_mobile = true; + } elseif (strpos($lowerAgent, 'docomo') !== false || + strpos($lowerAgent, 'portalmmm') !== false) { + $this->setBrowser('imode'); + $this->setFeature('images', false); + $this->_mobile = true; + } elseif (strpos($agent, 'BlackBerry') !== false) { + $this->setBrowser('blackberry'); + $this->setFeature('html', false); + $this->setFeature('javascript', false); + $this->setFeature('hdml'); + $this->setFeature('wml'); + $this->_mobile = true; + } elseif (strpos($agent, 'MOT-') !== false) { + $this->setBrowser('motorola'); + $this->setFeature('html', false); + $this->setFeature('javascript', false); + $this->setFeature('hdml'); + $this->setFeature('wml'); + $this->_mobile = true; + } elseif (strpos($lowerAgent, 'j-') !== false) { + $this->setBrowser('mml'); + $this->_mobile = true; + } + } + + /** + * Matches the platform of the browser. + * + * This is a pretty simplistic implementation, but it's intended to let us + * tell what line breaks to send, so it's good enough for its purpose. + */ + protected function _setPlatform() + { + if (strpos($this->_lowerAgent, 'wind') !== false) { + $this->_platform = 'win'; + } elseif (strpos($this->_lowerAgent, 'mac') !== false) { + $this->_platform = 'mac'; + } else { + $this->_platform = 'unix'; + } + } + + /** + * Returns the currently matched platform. + * + * @return string The user's platform. + */ + public function getPlatform() + { + return $this->_platform; + } + + /** + * Sets the current browser. + * + * @param string $browser The browser to set as current. + */ + public function setBrowser($browser) + { + $this->_browser = $browser; + } + + /** + * Determines if the given browser is the same as the current. + * + * @param string $browser The browser to check. + * + * @return boolean Is the given browser the same as the current? + */ + public function isBrowser($browser) + { + return ($this->_browser === $browser); + } + + /** + * Do we consider the current browser to be a mobile device? + * + * @return boolean True if we do, false if we don't. + */ + public function isMobile() + { + return $this->_mobile; + } + + /** + * Determines if the browser is a robot or not. + * + * @return boolean True if browser is a known robot. + */ + public function isRobot() + { + if (is_null($this->_robotAgentRegexp)) { + $regex = array(); + foreach ($this->_robotAgents as $r) { + $regex[] = preg_quote($r, '/'); + } + $this->_robotAgentRegexp = '/' . implode('|', $regex) . '/'; + } + + return (bool)preg_match($this->_robotAgentRegexp, $this->_agent); + } + + /** + * Returns the current browser. + * + * @return string The current browser. + */ + public function getBrowser() + { + return $this->_browser; + } + + /** + * Returns the current browser's major version. + * + * @return integer The current browser's major version. + */ + public function getMajor() + { + return $this->_majorVersion; + } + + /** + * Returns the current browser's minor version. + * + * @return integer The current browser's minor version. + */ + public function getMinor() + { + return $this->_minorVersion; + } + + /** + * Returns the current browser's version. + * + * @return string The current browser's version. + */ + public function getVersion() + { + return $this->_majorVersion . '.' . $this->_minorVersion; + } + + /** + * Returns the full browser agent string. + * + * @return string The browser agent string. + */ + public function getAgentString() + { + return $this->_agent; + } + + /** + * Sets unique behavior for the current browser. + * + * @param string $quirk The behavior to set. + * @param string $value Special behavior parameter. + */ + public function setQuirk($quirk, $value = true) + { + $this->_quirks[$quirk] = $value; + } + + /** + * Checks unique behavior for the current browser. + * + * @param string $quirk The behavior to check. + * + * @return boolean Does the browser have the behavior set? + */ + public function hasQuirk($quirk) + { + return !empty($this->_quirks[$quirk]); + } + + /** + * Returns unique behavior for the current browser. + * + * @param string $quirk The behavior to retrieve. + * + * @return string The value for the requested behavior. + */ + public function getQuirk($quirk) + { + return isset($this->_quirks[$quirk]) + ? $this->_quirks[$quirk] + : null; + } + + /** + * Sets capabilities for the current browser. + * + * @param string $feature The capability to set. + * @param string $value Special capability parameter. + */ + public function setFeature($feature, $value = true) + { + $this->_features[$feature] = $value; + } + + /** + * Checks the current browser capabilities. + * + * @param string $feature The capability to check. + * + * @return boolean Does the browser have the capability set? + */ + public function hasFeature($feature) + { + return !empty($this->_features[$feature]); + } + + /** + * Returns the current browser capability. + * + * @param string $feature The capability to retrieve. + * + * @return string The value of the requested capability. + */ + public function getFeature($feature) + { + return isset($this->_features[$feature]) + ? $this->_features[$feature] + : null; + } + + /** + * Determines if we are using a secure (SSL) connection. + * + * @return boolean True if using SSL, false if not. + */ + public function usingSSLConnection() + { + return ((isset($_SERVER['HTTPS']) && + ($_SERVER['HTTPS'] == 'on')) || + getenv('SSL_PROTOCOL_VERSION')); + } + + /** + * Returns the server protocol in use on the current server. + * + * @return string The HTTP server protocol version. + */ + public function getHTTPProtocol() + { + if (isset($_SERVER['SERVER_PROTOCOL'])) { + if (($pos = strrpos($_SERVER['SERVER_PROTOCOL'], '/'))) { + return substr($_SERVER['SERVER_PROTOCOL'], $pos + 1); + } + } + + return null; + } + + /** + * Determines if files can be uploaded to the system. + * + * @return integer If uploads allowed, returns the maximum size of the + * upload in bytes. Returns 0 if uploads are not + * allowed. + */ + public function allowFileUploads() + { + if (ini_get('file_uploads')) { + if (($dir = ini_get('upload_tmp_dir')) && + !is_writable($dir)) { + return 0; + } + $filesize = ini_get('upload_max_filesize'); + switch (strtolower(substr($filesize, -1, 1))) { + case 'k': + $filesize = intval(floatval($filesize) * 1024); + break; + + case 'm': + $filesize = intval(floatval($filesize) * 1024 * 1024); + break; + + default: + $filesize = intval($filesize); + break; + } + $postsize = ini_get('post_max_size'); + switch (strtolower(substr($postsize, -1, 1))) { + case 'k': + $postsize = intval(floatval($postsize) * 1024); + break; + + case 'm': + $postsize = intval(floatval($postsize) * 1024 * 1024); + break; + + default: + $postsize = intval($postsize); + break; + } + return min($filesize, $postsize); + } else { + return 0; + } + } + + /** + * Determines if the file was uploaded or not. If not, will return the + * appropriate error message. + * + * @param string $field The name of the field containing the uploaded + * file. + * @param string $name The file description string to use in the error + * message. Default: 'file'. + * + * @return mixed True on success, PEAR_Error on error. + */ + public function wasFileUploaded($field, $name = null) + { + require_once 'PEAR.php'; + + if (is_null($name)) { + $name = _("file"); + } + + if (!($uploadSize = Browser::allowFileUploads())) { + return PEAR::raiseError(_("File uploads not supported.")); + } + + /* Get any index on the field name. */ + $index = Horde_Array::getArrayParts($field, $base, $keys); + + if ($index) { + /* Index present, fetch the error var to check. */ + $keys_path = array_merge(array($base, 'error'), $keys); + $error = Horde_Array::getElement($_FILES, $keys_path); + + /* Index present, fetch the tmp_name var to check. */ + $keys_path = array_merge(array($base, 'tmp_name'), $keys); + $tmp_name = Horde_Array::getElement($_FILES, $keys_path); + } else { + /* No index, simple set up of vars to check. */ + if (!isset($_FILES[$field])) { + return PEAR::raiseError(_("No file uploaded"), UPLOAD_ERR_NO_FILE); + } + $error = $_FILES[$field]['error']; + $tmp_name = $_FILES[$field]['tmp_name']; + } + + if (!isset($_FILES) || ($error == UPLOAD_ERR_NO_FILE)) { + return PEAR::raiseError(sprintf(_("There was a problem with the file upload: No %s was uploaded."), $name), UPLOAD_ERR_NO_FILE); + } elseif (($error == UPLOAD_ERR_OK) && is_uploaded_file($tmp_name)) { + return true; + } elseif (($error == UPLOAD_ERR_INI_SIZE) || + ($error == UPLOAD_ERR_FORM_SIZE)) { + return PEAR::raiseError(sprintf(_("There was a problem with the file upload: The %s was larger than the maximum allowed size (%d bytes)."), $name, min($uploadSize, Util::getFormData('MAX_FILE_SIZE'))), $error); + } elseif ($error == UPLOAD_ERR_PARTIAL) { + return PEAR::raiseError(sprintf(_("There was a problem with the file upload: The %s was only partially uploaded."), $name), $error); + } + } + + /** + * Returns the headers for a browser download. + * + * @param string $filename The filename of the download. + * @param string $cType The content-type description of the file. + * @param boolean $inline True if inline, false if attachment. + * @param string $cLength The content-length of this file. + */ + public function downloadHeaders($filename = 'unknown', $cType = null, + $inline = false, $cLength = null) + { + /* Remove linebreaks from file names. */ + $filename = str_replace(array("\r\n", "\r", "\n"), ' ', $filename); + + /* Some browsers don't like spaces in the filename. */ + if ($this->hasQuirk('no_filename_spaces')) { + $filename = strtr($filename, ' ', '_'); + } + + /* MSIE doesn't like multiple periods in the file name. Convert all + * periods (except the last one) to underscores. */ + if ($this->isBrowser('msie')) { + if (($pos = strrpos($filename, '.'))) { + $filename = strtr(substr($filename, 0, $pos), '.', '_') . substr($filename, $pos); + } + + /* Encode the filename so IE downloads it correctly. (Bug #129) */ + $filename = rawurlencode($filename); + } + + /* Content-Type/Content-Disposition Header. */ + if ($inline) { + if (!is_null($cType)) { + header('Content-Type: ' . trim($cType)); + } elseif ($this->isBrowser('msie')) { + header('Content-Type: application/x-msdownload'); + } else { + header('Content-Type: application/octet-stream'); + } + header('Content-Disposition: inline; filename="' . $filename . '"'); + } else { + if ($this->isBrowser('msie')) { + header('Content-Type: application/x-msdownload'); + } elseif (!is_null($cType)) { + header('Content-Type: ' . trim($cType)); + } else { + header('Content-Type: application/octet-stream'); + } + + if ($this->hasQuirk('break_disposition_header')) { + header('Content-Disposition: filename="' . $filename . '"'); + } else { + header('Content-Disposition: attachment; filename="' . $filename . '"'); + } + } + + /* Content-Length Header. Only send if we are not compressing + * output. */ + if (!is_null($cLength) && + !in_array('ob_gzhandler', ob_list_handlers())) { + header('Content-Length: ' . $cLength); + } + + /* Overwrite Pragma: and other caching headers for IE. */ + if ($this->hasQuirk('cache_ssl_downloads')) { + header('Expires: 0'); + header('Cache-Control: must-revalidate'); + header('Pragma: public'); + } + } + + /** + * Determines if a browser can display a given MIME type. + * + * @param string $mimetype The MIME type to check. + * + * @return boolean True if the browser can display the MIME type. + */ + public function isViewable($mimetype) + { + $mimetype = String::lower($mimetype); + list($type, $subtype) = explode('/', $mimetype); + + if (!empty($this->_accept)) { + $wildcard_match = false; + + if (strpos($this->_accept, $mimetype) !== false) { + return true; + } + + if (strpos($this->_accept, '*/*') !== false) { + $wildcard_match = true; + if ($type != 'image') { + return true; + } + } + + /* image/jpeg and image/pjpeg *appear* to be the same entity, but + * Mozilla doesn't seem to want to accept the latter. For our + * purposes, we will treat them the same. */ + if ($this->isBrowser('mozilla') && + ($mimetype == 'image/pjpeg') && + (strpos($this->_accept, 'image/jpeg') !== false)) { + return true; + } + + if (!$wildcard_match) { + return false; + } + } + + if (!$this->hasFeature('images') || ($type != 'image')) { + return false; + } + + return in_array($subtype, $this->_images); + } + + /** + * Escapes characters in javascript code if the browser requires it. %23, + * %26, and %2B (for some browsers) and %27 need to be escaped or else + * javascript will interpret it as a single quote, pound sign, or + * ampersand and refuse to work. + * + * @param string $code The JS code to escape. + * + * @return string The escaped code. + */ + public function escapeJSCode($code) + { + $from = $to = array(); + + if ($this->isBrowser('msie') || + ($this->isBrowser('mozilla') && ($this->getMajor() >= 5)) || + $this->isBrowser('konqueror')) { + $from = array('%23', '%26', '%2B'); + $to = array('%2523', '%2526', '%252B'); + } + $from[] = '%27'; + $to[] = '\%27'; + + return str_replace($from, $to, $code); + } + + /** + * Sets the IE version in the session. + * + * @param string $ver The IE Version string. + */ + public function setIEVersion($ver) + { + $_SESSION['__browser'] = array( + 'ie_version' => $ver + ); + } + + /** + * Returns the IE version stored in the session, if available. + * + * @return mixed The IE Version string or null if no string is stored. + */ + public function getIEVersion() + { + return isset($_SESSION['__browser']['ie_version']) + ? $_SESSION['__browser']['ie_version'] + : null; + } + +} diff --git a/framework/Browser/lib/Horde/Browser/Imode.php b/framework/Browser/lib/Horde/Browser/Imode.php new file mode 100644 index 000000000..037dc5f15 --- /dev/null +++ b/framework/Browser/lib/Horde/Browser/Imode.php @@ -0,0 +1,465 @@ + + * @package Horde_Browser + */ +class Horde_Browser_imode +{ + /** + * Device data. From http://www.nttdocomo.co.jp/i/tag/s5.html#5_1 + * + * @var array + */ + protected $_data = array( + 'D209i' => array( + 'imagewidth' => 96, 'imageheight' => 90, + 'textwidth' => 8, 'textheight' => 7, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'F209i' => array( + 'imagewidth' => 96, 'imageheight' => 91, + 'textwidth' => 8, 'textheight' => 7, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'N209i' => array( + 'imagewidth' => 108, 'imageheight' => 82, + 'textwidth' => 9, 'textheight' => 6, + 'color' => 'grey', + 'imageformats' => array('gif') + ), + 'P209i' => array( + 'imagewidth' => 96, 'imageheight' => 87, + 'textwidth' => 8, 'textheight' => 6, + 'color' => 'grey', + 'imageformats' => array('gif') + ), + 'P209is' => array( + 'imagewidth' => 96, 'imageheight' => 87, + 'textwidth' => 8, 'textheight' => 6, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'R209i' => array( + 'imagewidth' => 96, 'imageheight' => 72, + 'textwidth' => 8, 'textheight' => 6, + 'color' => 'grey', + 'imageformats' => array('gif') + ), + 'ER209i' => array( + 'imagewidth' => 120, 'imageheight' => 72, + 'textwidth' => 10, 'textheight' => 6, + 'color' => 'grey', + 'imageformats' => array('gif') + ), + 'KO209i' => array( + 'imagewidth' => 96, 'imageheight' => 96, + 'textwidth' => 8, 'textheight' => 8, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'D210i' => array( + 'imagewidth' => 96, 'imageheight' => 91, + 'textwidth' => 8, 'textheight' => 7, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'F210i' => array( + 'imagewidth' => 96, 'imageheight' => 113, + 'textwidth' => 8, 'textheight' => 8, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'N210i' => array( + 'imagewidth' => 118, 'imageheight' => 113, + 'textwidth' => 10, 'textheight' => 8, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'P210i' => array( + 'imagewidth' => 96, 'imageheight' => 91, + 'textwidth' => 8, 'textheight' => 6, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'KO210i' => array( + 'imagewidth' => 96, 'imageheight' => 96, + 'textwidth' => 8, 'textheight' => 8, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'SO210i' => array( + 'imagewidth' => 120, 'imageheight' => 113, + 'textwidth' => 8, 'textheight' => 7, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'D501i' => array( + 'imagewidth' => 96, 'imageheight' => 72, + 'textwidth' => 8, 'textheight' => 6, + 'color' => 'black', + 'imageformats' => array('gif') + ), + 'F501i' => array( + 'imagewidth' => 112, 'imageheight' => 84, + 'textwidth' => 8, 'textheight' => 6, + 'color' => 'black', + 'imageformats' => array('gif') + ), + 'N501i' => array( + 'imagewidth' => 118, 'imageheight' => 128, + 'textwidth' => 10, 'textheight' =>10, + 'color' => 'black', + 'imageformats' => array('gif') + ), + 'P501i' => array( + 'imagewidth' => 96, 'imageheight' => 120, + 'textwidth' => 8, 'textheight' => 8, + 'color' => 'black', + 'imageformats' => array('gif') + ), + 'D502i' => array( + 'imagewidth' => 96, 'imageheight' => 90, + 'textwidth' => 8, 'textheight' => 7, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'F502i' => array( + 'imagewidth' => 96, 'imageheight' => 91, + 'textwidth' => 8, 'textheight' => 7, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'F502it' => array( + 'imagewidth' => 96, 'imageheight' => 91, + 'textwidth' => 8, 'textheight' => 7, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'N502i' => array( + 'imagewidth' => 118, 'imageheight' => 128, + 'textwidth' => 10, 'textheight' => 10, + 'color' => 'grey', + 'imageformats' => array('gif') + ), + 'N502it' => array( + 'imagewidth' => 118, 'imageheight' => 128, + 'textwidth' => 10, 'textheight' => 10, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'P502i' => array( + 'imagewidth' => 96, 'imageheighth' => 117, + 'textwidth' => 8, 'textheight' => 8, + 'color' => 'grey', + 'imageformats' => array('gif') + ), + 'NM502i' => array( + 'imagewidth' => 111, 'imageheight' => 77, + 'textwidth' => 8, 'textheight' => 6, + 'color' => 'black', + 'imageformats' => array('gif') + ), + 'SO502i' => array( + 'imagewidth' => 120, 'imageheight' => 120, + 'textwidth' => 8, 'textheight' => 8, + 'color' => 'grey', + 'imageformats' => array('gif') + ), + 'SO502iwm' => array( + 'imagewidth' => 120, 'imageheight' => 113, + 'textwidth' => 8, 'textheight' => 7, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'F503i' => array( + 'imagewidth' => 120, 'imageheight' => 130, + 'textwidth' => 10, 'textheight' => 10, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'F503iS' => array( + 'imagewidth' => 120, 'imageheight' => 130, + 'textwidth' => 12, 'textheight' => 12, + 'color' => 4096, + 'imageformats' => array('gif') + ), + 'P503i' => array( + 'imagewidth' => 120, 'imageheight' => 130, + 'textwidth' => 12, 'textheight' => 10, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'P503iS' => array( + 'imagewidth' => 120, 'imageheight' => 130, + 'textwidth' => 12, 'textheight' => 10, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'SO503i' => array( + 'imagewidth' => 120, 'imageheight' => 113, + 'textwidth' => 8.5, 'textheight' => 7, + 'color' => 65536, + 'imageformats' => array('gif') + ), + 'D503i' => array( + 'imagewidth' => 132, 'imageheight' => 126, + 'textwidth' => 8, 'textheight' => 7, + 'color' => 4096, + 'imageformats' => array('gif') + ), + 'N503i' => array( + 'imagewidth' => 118, 'imageheight' => 128, + 'textwidth' => 10, 'textheight' => 10, + 'color' => 4096, + 'imageformats' => array('gif', 'jpg') + ), + 'N503iS' => array( + 'imagewidth' => 118, 'imageheight' => 128, + 'textwidth' => 10, 'textheight' => 10, + 'color' => 4096, + 'imageformats' => array('gif', 'jpg') + ), + 'N691i' => array( + 'imagewidth' => 96, 'imageheight' => 72, + 'textwidth' => 8, 'textheight' => 6, + 'color' => 'grey', + 'imageformats' => array('gif') + ), + 'SH821i' => array( + 'imagewidth' => 96, 'imageheight' => 78, + 'textwidth' => 8, 'textheight' => 6, + 'color' => 256, + 'imageformats' => array('gif') + ), + 'N821i' => array( + 'imagewidth' => 118, 'imageheight' => 128, + 'textwidth' => 10, 'textheight' => 10, + 'color' => 'grey', + 'imageformats' => array('gif') + ), + 'P821i' => array( + 'imagewidth' => 118, 'imageheight' => 128, + 'textwidth' => 10, 'textheight' => 10, + 'color' => 'grey', + 'imageformats' => array('gif') + ), + 'safe' => array( + 'imagewidth' => 94, 'imageheight' => 72, + 'textwidth' => 8, 'textheight' => 6, + 'color' => 'black', + 'imageformats' => array('gif') + ) + ); + + /** + * TODO + */ + protected $_manufacturerlist = array( + 'D' => 'Mitsubishi', + 'P' => 'Panasonic (Matsushita)', + 'NM' => 'Nokia', + 'SO' => 'Sony', + 'F' => 'Fujitsu', + 'N' => 'Nec', + 'SH' => 'Sharp', + 'ER' => 'Ericsson', + 'R' => 'Japan Radio', + 'KO' => 'Kokusai (Hitachi)' + ); + + /** + * TODO + */ + protected $_extra = array( + 't' => 'Transport layer', + 'e' => 'English language', + 's' => 'Second version' + ); + + /** + * TODO + */ + protected $_user_agent; + + /** + * TODO + */ + protected $_model; + + /** + * TODO + */ + protected $_manufacturer; + + /** + * TODO + */ + protected $_httpversion; + + /** + * TODO + */ + protected $_cache = 5; + + /** + * Constructor. + * NOTE: Does not handle bogus user_agents or most of the other error + * situation properly yet. + * + * Example usage: + * $ua = new Browser_imode($_SERVER['HTTP_USER_AGENT']); + * + * @param string $input The user agent to match. + */ + public function __construct($input) + { + $_error = 0; + $temp = explode('/', $input); + + $this->_user_agent = $input; + $this->_httpversion = $temp[1]; + $this->_model = $temp[2]; + if ($temp[3]) { + $this->_cache = substr($temp[3], 1); + } + + preg_match('/(^[a-zA-Z]+)([0-9]+i)(.*)\/?(.*)/', $this->_model, $matches); + + // @TODO: Fix situation of unknown manufacturer. Implement + // extrainfo properly. + $this->_manufacturer = $this->_manufacturerlist[$matches[1]]; + $this->_extra = $matches[3]; + + if (!($this->_data[$this->_model])) { + $_error = PEAR::raiseError('Unknown User Agent'); + } + } + + /** + * TODO + * + * Example usage: + * $imagedim = $ua->getImageDimensions(); + * $imagewidth = $imagedim[0]; + * $imageheight = $imagedim[1]; + * + * @return array The maximum imagewidth and imageheight that + * fit on the handset screen without scrolling. + */ + public function getImageDimensions() + { + $data = $this->_data[$this->_model]; + return array($data['imagewidth'], $data['imageheight']); + } + + /** + * TODO + * + * Example usage: + * $textdim = $ua->getTextDimensions(); + * $textwidth = $textdim[0]; + * $textheight = $textdim[1]; + * + * @return array The Maximum textwidth and textheight that + * fit on the handset screen without scrolling. + */ + public function getTextDimensions() + { + return array($this->_data[$this->_model]['textwidth'], + $this->_data[$this->_model]['textheight']); + } + + /** + * TODO + * + * @return integer The amount of handset cache in kilobytes. + */ + public function getCache() + { + return (int)$this->_cache; + } + + /** + * TODO + */ + public function getManufacturer() + { + return $this->_manufacturer; + } + + /** + * TODO + */ + public function getExtra() + { + return $this->_extra; + } + + /** + * TODO + */ + public function getImageFormats() + { + return $this->_data[$this->_model]['imageformats']; + } + + /** + * TODO + * + * @return integer Which color model the handset supports. + * Values have the following meaning: + * 
+     * 0 -> black and white
+     * 1 -> 4 tone greyscale
+     * 2 -> 256 color
+     *
+ */ + public function getColor() + { + return $this->_data[$this->_model]['color']; + } + + /** + * TODO + */ + public function getHTTPVersion() + { + return $this->_httpversion; + } + + /** + * TODO + */ + public function isColor() + { + return $this->_data[$this->_model]['color'] == 256; + } + + /** + * TODO + */ + public function isGreyScale() + { + return $this->_data[$this->_model]['color'] == 'grey'; + } + + /** + * TODO + */ + public function isBlackAndWhite() + { + return $this->_data[$this->_model]['color'] == 'black'; + } + +} diff --git a/framework/Browser/package.xml b/framework/Browser/package.xml new file mode 100644 index 000000000..fec5488c4 --- /dev/null +++ b/framework/Browser/package.xml @@ -0,0 +1,100 @@ + + + Horde_Browser + pear.horde.org + Horde Browser API + The Horde_Browser:: class provides an API for getting information +about the current user's browser and its capabilities. + + + Chuck Hagenbuch + chuck + chuck@horde.org + yes + + 2009-01-12 + + 0.1.0 + 0.1.0 + + + beta + beta + + LGPL + * Initial Horde 4 package. + + + + + + + + + + + + + + + + 5.2.0 + + + 1.5.0 + + + Util + pear.horde.org + + + + + PEAR + pear.php.net + + + + + + + + + + + + + 0.0.2 + 0.0.2 + + + alpha + alpha + + 2006-05-08 + + LGPL + * Converted to package.xml 2.0 for pear.horde.org + * Add Opera Mobile detection (Request #4953) + * Add Grundig and NetFront detection (Request #5269) + + + + + 0.0.1 + 0.0.1 + + + alpha + alpha + + 2004-02-12 + LGPL + Initial packaging + + + + -- 2.11.0