File Source for TeraWurflRemoteClient.php

<?php
/**
* Tera_WURFL - PHP MySQL driven WURFL
*
* Tera-WURFL was written by Steve Kamerman, and is based on the
* Java WURFL Evolution package by Luca Passani and WURFL PHP Tools by Andrea Trassati.
* This version uses a MySQL database to store the entire WURFL file, multiple patch
* files, and a persistent caching mechanism to provide extreme performance increases.
*
* @package TeraWurflRemoteClient
* @author Steve Kamerman <stevekamerman AT gmail.com>
* @version Stable 2.1.3 $Date: 2010/09/18 15:43:21
* @license http://www.mozilla.org/MPL/ MPL Vesion 1.1
*/
/**
* Tera-WURFL remote webservice client for PHP
* @package TeraWurflRemoteClient
*/
class TeraWurflRemoteClient {
/**
* XML Data Format - this should only be used to communicate with Tera-WURFL 2.1.1 and older
* @var String
*/
public static $FORMAT_XML = 'xml';
/**
* The JSON Data Format is the default transport for Tera-WURFL 2.1.2 and newer due to it's smaller size
* and better performance with the builtin PHP functions
* @var String
*/
public static $FORMAT_JSON = 'json';
/**
* If you try to use a capability that has not been retrieved yet and this is set to true,
* it will generate another request to the webservice and retrieve this capability automatically.
* @var Bool
*/
public $autolookup = true;
/**
* Flattened version of Tera-WURFL's capabilities array, containing only capability names and values.
* Since it is 'Flattened', there a no groups in this array, just individual capabilities.
* @var Array
*/
public $capabilities = array();
/**
* Array of errors that were encountered while processing the request and/or response.
* @var Array
*/
public $errors;
/**
* The HTTP Headers that Tera-WURFL will look through to find the best User Agent, if one is not specified
* @var Array
*/
public static $userAgentHeaders = array(
'HTTP_X_DEVICE_USER_AGENT',
'HTTP_X_ORIGINAL_USER_AGENT',
'HTTP_X_OPERAMINI_PHONE_UA',
'HTTP_X_SKYFIRE_PHONE',
'HTTP_X_BOLT_PHONE_UA',
'HTTP_USER_AGENT'
);
protected $format;
protected $userAgent;
protected $webserviceUrl;
protected $xml;
protected $json;
protected $clientVersion = '2.1.3';
protected $apiVersion;
protected $loadedDate;
protected $timeout;
/**
* Creates a TeraWurflRemoteClient object. NOTE: in Tera-WURFL 2.1.2 the default data format is JSON.
* This format is not supported in Tera-WURFL 2.1.1 or earlier, so if you must use this client with
* an earlier version of the server, set the second parameter to TeraWurflRemoteClient::$FORMAT_XML
* @param String URL to the master Tera-WURFL Server's webservice.php
* @param String TeraWurflRemoteClient::$FORMAT_JSON or TeraWurflRemoteClient::$FORMAT_XML
*/
public function __construct($TeraWurflWebserviceURL,$data_format='json',$timeout=1){
$this->format = $data_format;
if(!self::validURL($TeraWurflWebserviceURL)){
throw new Exception("TeraWurflRemoteClient Error: the specified webservice URL is invalid. Please make sure you pass the full url to Tera-WURFL's webservice.php.");
exit(1);
}
$this->capabilities = array();
$this->errors = array();
$this->webserviceUrl = $TeraWurflWebserviceURL;
$this->timeout = $timeout;
}
/**
* Get the requested capabilities from Tera-WURFL for the given user agent
* @param String HTTP User Agent of the device being detected
* @param Array Array of capabilities that you would like to retrieve
* @return bool Success
*/
public function getDeviceCapabilitiesFromAgent($userAgent, Array $capabilities){
$this->userAgent = (is_null($userAgent))? self::getUserAgent(): $userAgent;
// build request string
$uri = $this->webserviceUrl . (strpos($this->webserviceUrl,'?')===false?'?':'&')
. 'ua=' . urlencode($this->userAgent)
. '&format=' . $this->format
. '&search=' . implode('|',$capabilities);
$this->callTeraWurfl($uri);
$this->loadCapabilities();
$this->loadErrors();
return true;
}
/**
* Maintains backwards compatibility with Tera-WURFL <= 2.1.2. This function is an
* alias for TeraWurflRemoteClient::getDeviceCapabilitiesFromAgent()
* @param String HTTP User Agent of the device being detected
* @param Array Array of capabilities that you would like to retrieve
* @return bool Success
*/
public function getCapabilitiesFromAgent($userAgent, Array $capabilities){
return $this->getDeviceCapabilitiesFromAgent($userAgent,$capabilities);
/**
* Returns the value of the requested capability
* @param String The WURFL capability you are looking for (e.g. "is_wireless_device")
* @return Mixed String, Numeric, Bool
*/
public function getDeviceCapability($capability){
$capability = strtolower($capability);
if(!array_key_exists($capability, $this->capabilities)){
if($this->autolookup){
$this->getDeviceCapabilitiesFromAgent($this->userAgent, array($capability));
return $this->capabilities[$capability];
}else{
return null;
}
}
return $this->capabilities[$capability];
}
/**
* Get the version of the Tera-WURFL Remote Client (this file)
* @return String
*/
public function getClientVersion(){
return $this->clientVersion;
}
/**
* Get the version of the Tera-WURFL Webservice (webservice.php on server). This is only available
* after a query has been made since it is returned in the response.
* @return String
*/
public function getAPIVersion(){
return $this->apiVersion;
}
/**
* Get the date that the Tera-WURFL was last updated. This is only available
* after a query has been made since it is returned in the response.
* @return String
*/
public function getLoadedDate(){
return $this->loadedDate;
}
/**
* Make the webservice call to the server using the GET method and load the response.
* @param String The URI of the master server
* @return void
*/
protected function callTeraWurfl($uri){
$context_options = array(
'http' => array(
'user_agent' => 'Tera-WURFL/RemoteClient v'.$this->clientVersion,
)
);
if(version_compare(PHP_VERSION, '5.2.1', '>=')){
$context_options['http']['timeout'] = $this->timeout;
}
$context = stream_context_create($context_options);
try{
switch($this->format){
case self::$FORMAT_JSON:
$data = file_get_contents($uri,false,$context);
$this->json = json_decode($data,true);
if(is_null($this->json)){
// Trigger the catch block
throw new Exception("foo");
}
unset($data);
break;
default:
case self::$FORMAT_XML:
if(!$this->xml = simplexml_load_string(file_get_contents($uri,false,$context))){
throw new Exception("foo");
}
break;
}
}catch(Exception $ex){
// Can't use builtin logging here through Tera-WURFL since it is on the client, not the server
throw new Exception("TeraWurflRemoteClient Error: Could not query Tera-WURFL master server.");
exit(1);
}
}
/**
* Parse the response into the capabilities array
* @return void
*/
protected function loadCapabilities(){
switch($this->format){
case self::$FORMAT_JSON:
$this->apiVersion = $this->json['apiVersion'];
$this->loadedDate = $this->json['mtime'];
$this->capabilities['id'] = $this->json['id'];
$this->capabilities = array_merge($this->capabilities,$this->json['capabilities']);
break;
default:
case self::$FORMAT_XML:
$this->apiVersion = $this->xml->device['apiVersion'];
$this->loadedDate = $this->xml->device['mtime'];
foreach($this->xml->device->capability as $cap){
$this->capabilities[(string)$cap['name']] = self::niceCast((string)$cap['value']);
}
$this->capabilities['id'] = (string)$this->xml->device['id'];
break;
}
}
/**
* Parse the response's errors into the errors array
* @return void
*/
protected function loadErrors(){
switch($this->format){
case self::$FORMAT_JSON:
$this->errors &= $this->json['errors'];
break;
default:
case self::$FORMAT_XML:
foreach($this->xml->errors->error as $error){
$this->errors[(string)$error['name']]=(string)$error['description'];
}
break;
}
}
/**
* Cast strings into proper variable types, i.e. 'true' into true
* @param $value
* @return Mixed String, Bool, Float
*/
protected static function niceCast($value){
// Clean Boolean values
if($value === 'true')$value=true;
if($value === 'false')$value=false;
if(!is_bool($value)){
// Clean Numeric values by loosely comparing the (float) to the (string)
$numval = (float)$value;
if(strcmp($value,$numval)==0)$value=$numval;
}
return $value;
}
/**
* Is the given URL valid
* @param $url
* @return Bool
*/
protected static function validURL($url){
if(preg_match('/^(http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?/',$url)) return true;
return false;
}
/**
* Return the requesting client's User Agent
* @param $source
* @return String
*/
public static function getUserAgent($source=null){
if(is_null($source) || !is_array($source))$source = $_SERVER;
$userAgent = '';
if(isset($_GET['UA'])){
$userAgent = $_GET['UA'];
}else{
foreach(self::$userAgentHeaders as $header){
if(array_key_exists($header,$source) && $source[$header]){
$userAgent = $source[$header];
break;
}
}
}
return $userAgent;
}
}

Source for file TeraWurflRemoteClient.php