7d6b71e6a5529cd50e68b033c23a70d17b281fbd
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Utility / ClientUtility.php
1 <?php
2 namespace TYPO3\CMS\Core\Utility;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2009-2011 Oliver Hader <oliver@typo3.org>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 * A copy is found in the textfile GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
20 *
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
29 /**
30 * Class to handle and determine browser specific information.
31 *
32 * @author Oliver Hader <oliver@typo3.org>
33 */
34 class ClientUtility {
35
36 /**
37 * Generates an array with abstracted browser information
38 *
39 * @param string $userAgent The useragent string, t3lib_div::getIndpEnv('HTTP_USER_AGENT')
40 * @return array Contains keys "browser", "version", "system
41 */
42 static public function getBrowserInfo($userAgent) {
43 // Hook: $TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/div/class.t3lib_utility_client.php']['getBrowserInfo']:
44 $getBrowserInfoHooks =& $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/div/class.t3lib_utility_client.php']['getBrowserInfo'];
45 if (is_array($getBrowserInfoHooks)) {
46 foreach ($getBrowserInfoHooks as $hookFunction) {
47 $returnResult = TRUE;
48 $hookParameters = array(
49 'userAgent' => &$userAgent,
50 'returnResult' => &$returnResult
51 );
52 // need reference for third parameter in t3lib_div::callUserFunction,
53 // so create a reference to NULL
54 $null = NULL;
55 $hookResult = \TYPO3\CMS\Core\Utility\GeneralUtility::callUserFunction($hookFunction, $hookParameters, $null);
56 if ($returnResult && is_array($hookResult) && count($hookResult)) {
57 return $hookResult;
58 }
59 }
60 }
61 $userAgent = trim($userAgent);
62 $browserInfo = array(
63 'useragent' => $userAgent
64 );
65 // Analyze the userAgent string
66 // Declare known browsers to look for
67 $known = array(
68 'msie',
69 'firefox',
70 'webkit',
71 'opera',
72 'netscape',
73 'konqueror',
74 'gecko',
75 'chrome',
76 'safari',
77 'seamonkey',
78 'navigator',
79 'mosaic',
80 'lynx',
81 'amaya',
82 'omniweb',
83 'avant',
84 'camino',
85 'flock',
86 'aol'
87 );
88 $matches = array();
89 $pattern = '#(?P<browser>' . join('|', $known) . ')[/ ]+(?P<version>[0-9]+(?:\\.[0-9]+)?)#';
90 // Find all phrases (or return empty array if none found)
91 if (!preg_match_all($pattern, strtolower($userAgent), $matches)) {
92 $browserInfo['browser'] = 'unknown';
93 $browserInfo['version'] = '';
94 $browserInfo['all'] = array();
95 } else {
96 // Since some UAs have more than one phrase (e.g Firefox has a Gecko phrase,
97 // Opera 7,8 have a MSIE phrase), use the last one found (the right-most one
98 // in the UA). That's usually the most correct.
99 // For IE use the first match as IE sends multiple MSIE with version, from higher to lower.
100 $lastIndex = count($matches['browser']) - 1;
101 $browserInfo['browser'] = $matches['browser'][$lastIndex];
102 $browserInfo['version'] = $browserInfo['browser'] === 'msie' ? $matches['version'][0] : $matches['version'][$lastIndex];
103 // But return all parsed browsers / version in an extra array
104 for ($i = 0; $i <= $lastIndex; $i++) {
105 if (!isset($browserInfo['all'][$matches['browser'][$i]])) {
106 $browserInfo['all'][$matches['browser'][$i]] = $matches['version'][$i];
107 }
108 }
109 // Replace gecko build date with version given by rv
110 if (isset($browserInfo['all']['gecko'])) {
111 preg_match_all('/rv:([0-9\\.]*)/', strtolower($userAgent), $version);
112 if ($version[1][0]) {
113 $browserInfo['all']['gecko'] = $version[1][0];
114 }
115 }
116 }
117 $browserInfo['all_systems'] = array();
118 if (strstr($userAgent, 'Win')) {
119 // Windows
120 if (strstr($userAgent, 'Windows NT 6.1')) {
121 $browserInfo['all_systems'][] = 'win7';
122 $browserInfo['all_systems'][] = 'winNT';
123 } elseif (strstr($userAgent, 'Windows NT 6.0')) {
124 $browserInfo['all_systems'][] = 'winVista';
125 $browserInfo['all_systems'][] = 'winNT';
126 } elseif (strstr($userAgent, 'Windows NT 5.1')) {
127 $browserInfo['all_systems'][] = 'winXP';
128 $browserInfo['all_systems'][] = 'winNT';
129 } elseif (strstr($userAgent, 'Windows NT 5.0')) {
130 $browserInfo['all_systems'][] = 'win2k';
131 $browserInfo['all_systems'][] = 'winNT';
132 } elseif (strstr($userAgent, 'Win98') || strstr($userAgent, 'Windows 98')) {
133 $browserInfo['all_systems'][] = 'win98';
134 } elseif (strstr($userAgent, 'Win95') || strstr($userAgent, 'Windows 95')) {
135 $browserInfo['all_systems'][] = 'win95';
136 } elseif (strstr($userAgent, 'WinNT') || strstr($userAgent, 'Windows NT')) {
137 $browserInfo['all_systems'][] = 'winNT';
138 } elseif (strstr($userAgent, 'Win16') || strstr($userAgent, 'Windows 311')) {
139 $browserInfo['all_systems'][] = 'win311';
140 }
141 } elseif (strstr($userAgent, 'Mac')) {
142 if (strstr($userAgent, 'iPad') || strstr($userAgent, 'iPhone') || strstr($userAgent, 'iPod')) {
143 $browserInfo['all_systems'][] = 'iOS';
144 $browserInfo['all_systems'][] = 'mac';
145 } else {
146 $browserInfo['all_systems'][] = 'mac';
147 }
148 } elseif (strstr($userAgent, 'Android')) {
149 $browserInfo['all_systems'][] = 'android';
150 $browserInfo['all_systems'][] = 'linux';
151 } elseif (strstr($userAgent, 'Linux')) {
152 $browserInfo['all_systems'][] = 'linux';
153 } elseif (strstr($userAgent, 'BSD')) {
154 $browserInfo['all_systems'][] = 'unix_bsd';
155 } elseif (strstr($userAgent, 'SGI') && strstr($userAgent, ' IRIX ')) {
156 $browserInfo['all_systems'][] = 'unix_sgi';
157 } elseif (strstr($userAgent, ' SunOS ')) {
158 $browserInfo['all_systems'][] = 'unix_sun';
159 } elseif (strstr($userAgent, ' HP-UX ')) {
160 $browserInfo['all_systems'][] = 'unix_hp';
161 } elseif (strstr($userAgent, 'CrOS')) {
162 $browserInfo['all_systems'][] = 'chrome';
163 $browserInfo['all_systems'][] = 'linux';
164 }
165 return $browserInfo;
166 }
167
168 /**
169 * Returns the version of a browser; Basically getting doubleval() of the input string,
170 * stripping of any non-numeric values in the beginning of the string first.
171 *
172 * @param string $version A string with version number, eg. "/7.32 blablabla
173 * @return double Returns double value, eg. "7.32
174 */
175 static public function getVersion($version) {
176 return doubleval(preg_replace('/^[^0-9]*/', '', $version));
177 }
178
179 /**
180 * Gets a code for a browsing device based on the input useragent string.
181 *
182 * @param string $userAgent The useragent string, t3lib_div::getIndpEnv('HTTP_USER_AGENT')
183 * @return string Code for the specific device type
184 */
185 static public function getDeviceType($userAgent) {
186 // Hook: $TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/div/class.t3lib_utility_client.php']['getDeviceType']:
187 $getDeviceTypeHooks =& $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/div/class.t3lib_utility_client.php']['getDeviceType'];
188 if (is_array($getDeviceTypeHooks)) {
189 foreach ($getDeviceTypeHooks as $hookFunction) {
190 $returnResult = TRUE;
191 $hookParameters = array(
192 'userAgent' => &$userAgent,
193 'returnResult' => &$returnResult
194 );
195 // need reference for third parameter in t3lib_div::callUserFunction,
196 // so create a reference to NULL
197 $null = NULL;
198 $hookResult = \TYPO3\CMS\Core\Utility\GeneralUtility::callUserFunction($hookFunction, $hookParameters, $null);
199 if ($returnResult && is_string($hookResult) && !empty($hookResult)) {
200 return $hookResult;
201 }
202 }
203 }
204 $userAgent = strtolower(trim($userAgent));
205 $deviceType = '';
206 // pda
207 if (strstr($userAgent, 'avantgo')) {
208 $deviceType = 'pda';
209 }
210 // wap
211 $browser = substr($userAgent, 0, 4);
212 $wapviwer = substr(stristr($userAgent, 'wap'), 0, 3);
213 if ($wapviwer == 'wap' || $browser == 'noki' || $browser == 'eric' || $browser == 'r380' || $browser == 'up.b' || $browser == 'winw' || $browser == 'wapa') {
214 $deviceType = 'wap';
215 }
216 // grabber
217 if (strstr($userAgent, 'g.r.a.b.') || strstr($userAgent, 'utilmind httpget') || strstr($userAgent, 'webcapture') || strstr($userAgent, 'teleport') || strstr($userAgent, 'webcopier')) {
218 $deviceType = 'grabber';
219 }
220 // robots
221 if (strstr($userAgent, 'crawler') || strstr($userAgent, 'spider') || strstr($userAgent, 'googlebot') || strstr($userAgent, 'searchbot') || strstr($userAgent, 'infoseek') || strstr($userAgent, 'altavista') || strstr($userAgent, 'diibot')) {
222 $deviceType = 'robot';
223 }
224 return $deviceType;
225 }
226
227 }
228
229
230 ?>