Source for file tera_wurfl.php

 

    require_once(dirname(__FILE__).'/tera_wurfl_config.php');

 

    die("NO CONFIGURATION");

 

    require_once(WURFL_PARSER_FILE);

    require_once(dirname(__FILE__)."/tera_wurfl_parser.php");

 

class tera_wurfl {

    /**

    var $id="";

 

    /**

    var $GUI=false;

 

    /**

    var $brand='';

 

    /**

    var $model='';

 

    /**

    var $browser_is_wap=false;

 

    /**

    var $capabilities=array();

 

    /**

    var $http_accept="";

 

    /**

    var $ignoreBrowser=false;

 

    /**

    var $errors = array();

 

    /**

    var $dbcon = '';

    

    /**

    var $devtable = '';

    

    /**

    var $device_root = '';

    

    /**

    var $device_image = '';

    

    /**

    var $num_queries = 0;

    

    /**

    var $found_in_cache = false;

    

    /**

    function tera_wurfl() {

        // connect to database

        $this->dbcon = mysql_connect(DB_HOST,DB_USER,DB_PASS) or die("ERROR: Could not connect to MySQL Server (".DB_HOST."): ".mysql_error());

        // select schema

        mysql_select_db(DB_SCHEMA,$this->dbcon) or die("ERROR: Connected to MySQL Server but could not select database (".DB_SCHEMA."): ".mysql_error());

        if(WURFL_PATCH_ENABLE){

            $this->devtable = DB_HYBRID_TABLE;

        }else{

            $this->devtable = DB_DEVICE_TABLE;

        }

        // make sure the device table is not empty

        // set the default http-accept

        $this->http_accept = $_SERVER['HTTP_ACCEPT'];

        $this->_toLog('constructor', '-----Class Initiated-----', LOG_NOTICE);

        return(true);

    }

 

    /**

    function _GetFullCapabilities($_id) {

        if(count($this->errors) != 0) return(false);

        $this->_toLog('_GetFullCapabilities', "searching for $_id", LOG_INFO);

        $_curr_device = $this->_getDeviceCapabilitiesFromId($_id);

        // array of full records

        $_capabilities[] = $_curr_device;

        // keep the while loop from running away on an error

        $iteration_limit = 20;

        $i = 0;

        while ( $_curr_device['fall_back'] != 'generic' && $_curr_device['fall_back'] != 'root' && $i <= $iteration_limit) {

            $this->_toLog('_GetFullCapabilities', 'parent device:'.$_curr_device['fall_back'].' now going to read its capabilities', LOG_INFO);

            $_curr_device = $this->_getDeviceCapabilitiesFromId($_curr_device['fall_back']);

            array_unshift($_capabilities,$_curr_device);

            $i++;

        }

        if($i >= $iteration_limit){

            // the while loop ran away

            $this->_toLog('_GetFullCapabilities', 'Killing runaway while loop - $_id='.$_id, LOG_ERR);

            return(false);

        }

        $this->_toLog('_GetFullCapabilities', 'reading capabilities of \'generic\' device', LOG_INFO);

        $generic = $this->_getDeviceCapabilitiesFromId('generic');

        $_final = $generic;

        // the generic devices are already at the top of the array because I used array_unshift()

        foreach($_capabilities as $curr_device){

            //TODO: Why don't I just array_merge the whole record???? Good question!

            foreach($curr_device as $key => $val) {

                if ( is_array($val) ) {

                    $_final[$key] = array_merge($_final[$key], $val);

                } else {

                    $_final[$key] = $val;

                }

            }

        }

        $this->capabilities = $_final;

        //$this->brand = $this->capabilities['product_info']['brand_name'];

        //$this->model = $this->capabilities['product_info']['model_name'];

        //$this->id = $this->capabilities['id'];

        return(true);

    }

 

    /**

    function _getDeviceCapabilitiesFromId($_id) {

        if(count($this->errors) != 0) return(false);

        $this->_toLog('_getDeviceCapabilitiesFromId', "reading id:$_id", LOG_INFO);

        if ( $_id == 'upgui_generic' ) {

            $this->GUI = true;

        }

        $res = mysql_query("SELECT * FROM ".$this->devtable." WHERE deviceID=".$this->_sqlPrep($_id),$this->dbcon) or die(mysql_error($this->dbcon));

        $this->num_queries++;

        if(mysql_num_rows($res) > 0){

            $device = mysql_fetch_assoc($res);

            //print_r($device);

            if($this->device_root == '' && $device['actual_device_root'] == 1){

                $this->_toLog("_getDeviceCapabilitiesFromId","device root detected: ".$device['deviceID'], LOG_INFO);

                $this->device_root = $device['deviceID'];

                $image = IMAGE_DIR.$device['deviceID'].".gif";

                // PHP evaluates from left to right, so "file_exists" will not get

                // called if IMAGE_CHECKING is false

                if(IMAGE_CHECKING && file_exists($image)){

                    $this->device_image = $image;

                    $this->_toLog("_getDeviceCapabilitiesFromId","device image found: $image",LOG_INFO);

                }

            }

            $cap = unserialize($device['capabilities']);

            //echo "<pre>".print_r($cap,true)."</pre>";

            return($cap);

        }else{

            // device is not in the WURFL

            // deal with it appropriately

            $this->_toLog('_getDeviceCapabilitiesFromId', "the id $_id is not present in wurfl", LOG_WARNING);

            //die("the id $_id is not present in wurfl_agents");

            echo("the id ($_id) is not present in wurfl DB<br />");

            // I should never get here!!

            return(false);

        }

    }

 

    /**

    function getDeviceCapabilitiesFromAgent($_user_agent, $_check_accept=false) {

        if(count($this->errors) != 0) return(false);

        //TODO: Would be cool to log user agent and headers for future use to feed WURFL

        // clear any existing device root and image

        $this->device_root = '';

        $this->device_image = '';

        // Resetting properties

        $this->user_agent = $_user_agent; // the class prop will remain unchanged

        // FIXME: I'm not sure if people use these, but they're not getting set all the time

        $this->wurfl_agent = '';

        $this->GUI = false;

        $this->capabilities = array();

        $this->capabilities['product_info'] = array();

        // set this to false by default

        $this->capabilities['product_info']['is_wireless_device'] = false;

        $this->capabilities['product_info']['brand_name'] = '';

        $this->capabilities['product_info']['model_name'] = '';

        // As of version 1.4.5 the short names are references to the actual capabilities

        $this->browser_is_wap = &$this->capabilities['product_info']['is_wireless_device'];

        $this->brand = &$this->capabilities['product_info']['brand_name'];

        $this->model = &$this->capabilities['product_info']['model_name'];

        $this->id = &$this->capabilities['id'];

        $this->num_queries = 0;

        $this->found_in_cache = false;

 

        // if caching is enabled, let's check the cache

        if(WURFL_CACHE_ENABLE){

            $cache_data = $this->_UserAgentInCache($this->user_agent);

            if($cache_data !== false){

                $this->_toLog('_UserAgentInCache', 'UA was found in the cache', LOG_INFO);

                $this->found_in_cache = true;

                $cache_data = unserialize($cache_data);

                $this->capabilities = $cache_data['capabilities'];

                if($cache_data['device_root'] != ''){

                    $this->_toLog("_UserAgentInCache","device root detected: ".$cache_data['device_root'], LOG_INFO);

                    $this->device_root = $cache_data['device_root'];

                    $image = IMAGE_DIR.$cache_data['device_root'].".gif";

                    // PHP evaluates from left to right, so "file_exists" will not get

                    // called if IMAGE_CHECKING is false

                    if(IMAGE_CHECKING && file_exists($image)){

                        $this->device_image = $image;

                        $this->_toLog("_UserAgentInCache","device image found: $image",LOG_INFO);

                    }

                }

                return(true);

            }else{

                $this->_toLog('_UserAgentInCache', 'UA was not found in the cache', LOG_INFO);

            }

        }

        // removing the possible Openwave MAG tag

        // at this point a user agent like this: "UP.Link/6.3.0.0.0" will

        // result in an null $_user_agent

        //FIXME: why do we really need to get rid of this anyway???

        $_user_agent = trim(ereg_replace("UP.Link.*", "", $_user_agent));

        //FIXME: PocketPCs (Windows Mobile) contain "MSIE 5"

        // like the Cingular 8125

        /**

         * The following logic has been removed because it has been deemed unmaintainable

         * with the introduction of so many mobile versions of common desktop browsers.

         */

        // TODO: Spend some time on this code and make it MUCH more robust.

        // FIXME: I'm not sure that this even actually does anything :( - I think 'browser_is_wap'

        // get's overwritten anyway. Hmmmm....  Also, I changed it from LOG_WARNING to LOG_NOTICE

        if ($_check_accept == true) {

            if (!eregi('wml', $this->http_accept) && !eregi('wap', $this->http_accept) && !eregi('xhtml', $this->http_accept)) {

                $this->_toLog('getDeviceCapabilitiesFromAgent', 'This browser does not support wml, wap, or xhtml', LOG_NOTICE);

                $this->browser_is_wap=false;

            }else{

                // We can assume this is a mobile device since it accepts wml || wap || xhtml

                $this->browser_is_wap=true;

            }

        }

        $this->_toLog('getDeviceCapabilitiesFromAgent', 'searching for '.$_user_agent, LOG_INFO);

        if ( trim($_user_agent) == '' || !$_user_agent ) {

            // NO USER AGENT??? This is not a WAP device

            $this->_toLog('getDeviceCapabilitiesFromAgent', 'No user agent', LOG_ERR);

            $this->browser_is_wap=false;

            return(false);

        }

        $curr_device = $this->_UserAgentInDB($this->user_agent);

        if(is_array($curr_device)){

            // the exact user agent was in the WURFL - Great!

            //DEBUG: echo "Found exact UA in DB!<br />".print_r($curr_device,true)."<br />";

            $this->_GetFullCapabilities($curr_device['deviceID']);

            // in case you have desktop web browsers in your patch file

            // It was suggested by MOLABIB on 22Dec2006 that the following line

            // is incorrect and should be replaced:

            // $this->browser_is_wap = $this->capabilities['browser_is_wap'];

            // the following is it's replacement:

            //$this->browser_is_wap = $this->capabilities['product_info']['is_wireless_device'];

            //$this->brand = $this->capabilities['product_info']['brand_name'];

            //$this->model = $this->capabilities['product_info']['model_name'];

            $this->_AddUAToCache($this->user_agent,$this->capabilities,$this->device_root);

            return(true);

        }

        // the user agent was NOT in the WURFL - try to dissect it

        $_ua = $_user_agent;

        // Used to be $_ua_len = strlen($_ua) - 1 but that resulted in erroneous results since

        // the full string could still match UAs longer than itself in the DB

        // Thanks to Christian Aune Thomassen [christian.thomassen(at)waptheweb.no] for finding this bug!

        $_ua_len = strlen($_ua);

        // Searching in wurfl_agents

        // The user_agent should not become shorter than 4 characters

        $this->_toLog('getDeviceCapabilitiesFromAgent', 'Searching the DB ('.$this->devtable.')', LOG_INFO);

        // I request to set a short list of UA's among which I should search an unknown user agent

        $_short_ua_len = 4;

        $_last_good_short_ua = array();

        $_min_len = 4;

        // track number of queries

        $niceua = rtrim($this->_sqlPrep(substr($_ua, 0, $_min_len)),"'")."%'";

        $minquery = "SELECT COUNT(deviceID) AS num FROM ".$this->devtable." WHERE user_agent LIKE $niceua";

        $res = mysql_query($minquery,$this->dbcon);

        $this->num_queries++;

        $_short_wurfl_ua = array();

        if(mysql_result($res,0,'num') == 0){

            //DEBUG: echo "no devices match the UA down to the min chars in the DB<br />$minquery";

            // no devices match the UA down to the min chars in the DB

            // basically you're not going to get a match.

            // look for acceptable generic ID

            if(!$this->_getGenericID($_user_agent)){

                // no generic ID found - assuming this is not a WAP device

                return(true);

            }

        }else{

            while ( $_ua_len > $_min_len) {

                //DEBUG: echo "--trying user agent length $_ua_len<br />";

                $_short_wurfl_ua = array();

                $_short_ua = substr($_ua, 0, $_ua_len);

                // take the user agent and prep it (escapes chars and adds single quotes

                // then remove the right most quote and put %' in it's place which will

                // make it this MOT- look like this: 'MOT-%' - that will work for MySQL LIKE queries

                $niceua = rtrim($this->_sqlPrep($_short_ua),"'")."%'";

                $res = mysql_query("SELECT user_agent FROM ".$this->devtable." WHERE user_agent LIKE $niceua",$this->dbcon);

                $this->num_queries++;

                while($row = mysql_fetch_assoc($res)){

                    // load the $_short_wurfl_ua array with matching user agents

                    $_short_wurfl_ua[] = $row['user_agent'];

                }

                if ( $_ua_len <= $_min_len && count($_short_wurfl_ua) == 0 ) {

                    // Probably impossible to get here, but if it does there is no match

                    // DEBUG fast search echo "no match even for the first 4 chars<br>\n";

                    break;

                }

                if ( count($_short_wurfl_ua) > 0 ) {

                    // This is the FIRST time that ANY matching user agents were found

                    //DEBUG: echo "list has ".count($_short_wurfl_ua)." elements<br />";

                    break;

                }

                // shortening the agent by one each time

                $_ua_len--;

            }

        }

        //DEBUG: die("Done.<br />Original UA: $_user_agent<br />Best match UA: ".$_short_wurfl_ua[0]."<br />");

        //FIXME: probably shouldn't blindly grab the first UA, so improve...

        if(count($_short_wurfl_ua) > 0){

            $bestmatch = array_shift($_short_wurfl_ua);

            $device = $this->_UserAgentInDB($bestmatch);

            $this->_GetFullCapabilities($device['deviceID']);

            $this->_AddUAToCache($this->user_agent,$this->capabilities,$this->device_root);

            $this->_toLog('getDeviceCapabilitiesFromAgent', 'Match found in DB after '.$this->num_queries.' queries', LOG_INFO);

            return(true);

        }else{

            // no match was found

            $this->_AddUAToCache($this->user_agent,$this->capabilities,$this->device_root);

            $this->_toLog('getDeviceCapabilitiesFromAgent', 'No match was found in DB', LOG_INFO);

            return(false);

        }

    }

    /**

    function _UserAgentInDB($ua){

        //TODO: using LIKE will do the search case-insensitive, but = is much faster

        $res = mysql_query("SELECT * FROM ".$this->devtable." WHERE user_agent LIKE ".$this->_sqlPrep($ua),$this->dbcon);

        $this->num_queries++;

        $curr_device = mysql_fetch_assoc($res);

        $ret = (mysql_num_rows($res) > 0)? $curr_device: false;

        return($ret);

    }

    /**

    function _UserAgentInCache($ua){

        //TODO: using LIKE will do the search case-insensitive, but = is much faster

        $query = "SELECT * FROM ".DB_CACHE_TABLE." WHERE user_agent = ".$this->_sqlPrep($ua);

        $res = mysql_query($query,$this->dbcon);

        $this->num_queries++;

        $cache_data = mysql_fetch_assoc($res);

        $ret = (mysql_num_rows($res) > 0)? $cache_data['cache_data']: false;

        return($ret);

    }

    /**

    function _AddUAToCache($ua,$cap,$devroot){

        if(!WURFL_CACHE_ENABLE)return(true);

        // don't cache UAs that are too short to be real

        if(strlen($ua) < 3)return(true);

        $cache_data = serialize(array("capabilities"=>$cap,"device_root"=>$devroot));

        // FIXME: DELAYED INSERTS only work on MyIASM

        mysql_query("INSERT DELAYED INTO ".DB_CACHE_TABLE." (user_agent,cache_data) VALUES (".$this->_sqlPrep($ua).",".$this->_sqlPrep($cache_data).")",$this->dbcon);

        $this->_toLog('_AddUAToCache', 'Added UA to cache: '.$ua, LOG_INFO);

        $this->num_queries++;

        return(true);

    }

    /**

    function getDeviceCapability($capability) {

        $this->_toLog('_getDeviceCapability', 'Searching for '.$capability.' as a capability', LOG_INFO);

        $deviceCapabilities = $this->capabilities;

        foreach ( $deviceCapabilities as $group ) {

            if ( !is_array($group) ) {

                continue;

            }

            while ( list($key, $value)=each($group) ) {

                if ($key==$capability) {

                    $this->_toLog('_getDeviceCapability', 'I found it, value is '.$value, LOG_INFO);

                    return $value;

                }

            }

        }

        $this->_toLog('_getDeviceCapability', 'I could not find the requested capability, returning false', LOG_WARNING);

        return false;

    }

    /**

    function clearErrors(){

        $this->errors = array();

        return(true);

    }

 

    /**

    function _toLog($func, $text, $requestedLogLevel=LOG_NOTICE){

        if($requestedLogLevel == LOG_ERR) $this->errors[] = $text;

        if ( !defined('LOG_LEVEL') || LOG_LEVEL == 0 || ($requestedLogLevel-1) >= LOG_LEVEL ) {

            return;

        }

        if ( $requestedLogLevel == LOG_ERR ) {

            $warn_banner = 'ERROR: ';

        } else if ( $requestedLogLevel == LOG_WARNING ) {

            $warn_banner = 'WARNING: ';

        } else {

            $warn_banner = '';

        }

        // Thanks laacz

        $_textToLog = date('r')." [".php_uname('n')." ".getmypid()."]"."[$func] ".$warn_banner . $text;

        $_logFP = fopen(WURFL_LOG_FILE, "a+");

        fputs($_logFP, $_textToLog."\n");

        fclose($_logFP);

        return(true);

    }

    /**

    function _dberror(){

        die("Error in query: ".mysql_error($this->dbcon));

    }

    /**

    function _getGenericID($_user_agent){

        $this->_toLog('getGenericID', "I couldn't find the device in my list, the headers are my last chance", LOG_NOTICE);

        if ( strstr($_user_agent, 'UP.Browser/') && strstr($_user_agent, '(GUI)') ) {

            $this->browser_is_wap = true;

            $this->user_agent = $_user_agent;

            $this->wurfl_agent = 'upgui_generic';

            $this->id = 'upgui_generic';

        } else if ( strstr($_user_agent, 'UP.Browser/') ) {

            $this->browser_is_wap = true;

            $this->user_agent = $_user_agent;

            $this->wurfl_agent = 'uptext_generic';

            $this->id = 'uptext_generic';

        } else if ( eregi('wml', $this->http_accept) || eregi('wap', $this->http_accept) ) {

            $this->browser_is_wap = true;

            $this->user_agent = $_user_agent;

            $this->wurfl_agent = 'generic';

            $this->id = 'generic';

        } else {

            $this->_toLog('getGenericID', 'This should not be a WAP device, quitting', LOG_NOTICE);

            $this->browser_is_wap=false;

            $this->user_agent = $_user_agent;

            $this->wurfl_agent = 'generic';

            $this->id = 'generic';

            return(false);

        }

        return(true);

    }

    /**

    function _sqlPrep($value){

        if (get_magic_quotes_gpc()) $value = stripslashes($value);

        if($value == '') $value = 'NULL';

        else if (!is_numeric($value) || $value[0] == '0') $value = "'" . mysql_real_escape_string($value) . "'"; //Quote if not integer

        return($value);

    }