File Source for TeraWurflDatabase

<?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 TeraWurflDatabase
* @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
*/
/**
* Provides connectivity from Tera-WURFL to MySQL 4. This connector is also compatible with MySQL 5.
* @package TeraWurflDatabase
*/
class TeraWurflDatabase_MySQL4 extends TeraWurflDatabase{
// Properties
public $errors;
public $db_implements_ris = false;
public $db_implements_ld = false;
public $numQueries = 0;
public $connected = false;
protected $dbcon;
public $maxquerysize = 0;
/**
* The maximum number of new rows that the database can handle in one INSERT statement
* @var unknown_type
*/
protected static $DB_MAX_INSERTS = 500;
public function __construct(){
parent::__construct();
}
/**
* Destructor, disconnect from database
*/
public function __destruct(){
@$this->dbcon->close();
}
// Device Table Functions (device,hybrid,patch)
public function getDeviceFromID($wurflID){
$this->numQueries++;
$res = $this->dbcon->query("SELECT * FROM `".TeraWurflConfig::$TABLE_PREFIX.'Merge'."` WHERE `deviceID`=".$this->SQLPrep($wurflID)) or die($this->dbcon->error);
if($res->num_rows == 0){
$res->close();
throw new Exception("Tried to lookup an invalid WURFL Device ID: $wurflID");
}
$data = $res->fetch_assoc();
$res->close();
return unserialize($data['capabilities']);
}
public function getActualDeviceAncestor($wurflID){
if($wurflID == "" || $wurflID == WurflConstants::$GENERIC)
return WurflConstants::$GENERIC;
$device = $this->getDeviceFromID($wurflID);
if($device['actual_device_root']){
return $device['id'];
}else{
return $this->getActualDeviceAncestor($device['fall_back']);
}
}
public function getFullDeviceList($tablename){
$this->numQueries++;
$res = $this->dbcon->query("SELECT `deviceID`, `user_agent` FROM `$tablename` WHERE `match`=1");
if($res->num_rows == 0){
$res->close();
return array();
}
$data = array();
while($row = $res->fetch_assoc()){
$data[$row['deviceID']]=$row['user_agent'];
}
return $data;
}
// Exact Match
public function getDeviceFromUA($userAgent){
$this->numQueries++;
$query = "SELECT `deviceID` FROM `".TeraWurflConfig::$TABLE_PREFIX.'Merge'."` WHERE `user_agent`=".$this->SQLPrep($userAgent);
$res = $this->dbcon->query($query);
if($res->num_rows == 0){
$res->close();
return false;
}
$data = $res->fetch_assoc();
$res->close();
return $data['deviceID'];
}
public function loadDevices(&$tables){
$insert_errors = array();
$insertcache = array();
$insertedrows = 0;
$this->createIndexTable();
$this->createSettingsTable();
$this->clearMatcherTables();
foreach($tables as $table => $devices){
// insert records into a new temp table until we know everything is OK
$temptable = $table . (self::$DB_TEMP_EXT);
$parts = explode('_',$table);
$matcher = array_pop($parts);
$this->createGenericDeviceTable($temptable);
foreach($devices as $device){
$this->dbcon->query("INSERT INTO `".TeraWurflConfig::$TABLE_PREFIX.'Index'."` (`deviceID`,`matcher`) VALUE (".$this->SQLPrep($device['id']).",".$this->SQLPrep($matcher).")");
// convert device root to tinyint format (0|1) for db
if(strlen($device['user_agent']) > 255){
$insert_errors[] = "Warning: user agent too long: \"".($device['id']).'"';
}
$insertcache[] = sprintf("(%s,%s,%s,%s,%s,%s)",
$this->SQLPrep($device['id']),
$this->SQLPrep($device['user_agent']),
$this->SQLPrep($device['fall_back']),
$this->SQLPrep((isset($device['actual_device_root']))?$device['actual_device_root']:''),
preg_match('/^DO_NOT_MATCH/',$device['user_agent'])? '0': '1',
$this->SQLPrep(serialize($device))
);
// This batch of records is ready to be inserted
if(count($insertcache) >= self::$DB_MAX_INSERTS){
$query = "INSERT INTO `$temptable` (`deviceID`, `user_agent`, `fall_back`, `actual_device_root`, `match`, `capabilities`) VALUES ".implode(",",$insertcache);
$this->dbcon->query($query) or $insert_errors[] = "DB server reported error on id \"".$device['id']."\": ".$this->dbcon->error;
$insertedrows += $this->dbcon->affected_rows;
$insertcache = array();
$this->numQueries++;
$this->maxquerysize = (strlen($query)>$this->maxquerysize)? strlen($query): $this->maxquerysize;
}
}
// some records are probably left in the insertcache
if(count($insertcache) > 0){
$query = "INSERT INTO `$temptable` (`deviceID`, `user_agent`, `fall_back`, `actual_device_root`, `match`, `capabilities`) VALUES ".implode(",",$insertcache);
$this->dbcon->query($query) or $insert_errors[] = "DB server reported error on id \"".$device['id']."\": ".$this->dbcon->error;
$insertedrows += $this->dbcon->affected_rows;
$insertcache = array();
$this->numQueries++;
$this->maxquerysize = (strlen($query)>$this->maxquerysize)? strlen($query): $this->maxquerysize;
}
if(count($insert_errors) > 0){
// Roll back changes
// leave the temp table in the DB for manual inspection
$this->errors = array_merge($this->errors,$insert_errors);
return false;
}
$this->numQueries++;
$this->dbcon->query("DROP TABLE IF EXISTS `$table`");
$this->numQueries++;
$this->dbcon->query("RENAME TABLE `$temptable` TO `$table`");
}
// Create Merge Table
$this->createMergeTable(array_keys($tables));
return true;
}
/**
* Drops and creates the given device table
*
* @param string Table name (ex: TeraWurflConfig::$HYBRID)
* @return boolean success
*/
public function createGenericDeviceTable($tablename){
$droptable = "DROP TABLE IF EXISTS ".$tablename;
$createtable = "CREATE TABLE `".$tablename."` (
`deviceID` varchar(64) binary NOT NULL default '',
`user_agent` varchar(255) default NULL,
`fall_back` varchar(64) default NULL,
`actual_device_root` tinyint(1) default '0',
`match` tinyint(1) default '1',
`capabilities` mediumtext,
PRIMARY KEY (`deviceID`),
KEY `fallback` (`fall_back`),
KEY `useragent` (`user_agent`),
KEY `dev_root` (`actual_device_root`),
KEY `idxmatch` (`match`)
) ENGINE=MyISAM";
$this->numQueries++;
$this->dbcon->query($droptable);
$this->numQueries++;
$this->dbcon->query($createtable);
return true;
}
/**
* Drops then creates all the UserAgentMatcher device tables
* @return boolean success
*/
protected function clearMatcherTables(){
foreach(UserAgentFactory::$matchers as $matcher){
$table = TeraWurflConfig::$TABLE_PREFIX."_".$matcher;
$this->createGenericDeviceTable($table);
}
return true;
}
/**
* Drops and creates the MERGE table
*
* @param array Table names
* @return boolean success
*/
public function createMergeTable($tables){
$tablename = TeraWurflConfig::$TABLE_PREFIX.'Merge';
foreach($tables as &$table){$table="SELECT * FROM `$table`";}
$droptable = "DROP TABLE IF EXISTS ".$tablename;
$this->createGenericDeviceTable($tablename);
$createtable = "INSERT INTO `$tablename` ".implode(" UNION ALL ",$tables);
$this->numQueries++;
$this->dbcon->query($createtable) or die("ERROR: ".$this->dbcon->error);
return true;
}
/**
* Drops and creates the index table
*
* @return boolean success
*/
public function createIndexTable(){
$tablename = TeraWurflConfig::$TABLE_PREFIX.'Index';
$droptable = "DROP TABLE IF EXISTS ".$tablename;
$createtable = "CREATE TABLE `".$tablename."` (
`deviceID` varchar(64) binary NOT NULL default '',
`matcher` varchar(64) NOT NULL,
PRIMARY KEY (`deviceID`)
) ENGINE=MyISAM";
$this->numQueries++;
$this->dbcon->query($droptable);
$this->numQueries++;
$this->dbcon->query($createtable);
return true;
}
/**
* Creates the settings table if it does not already exist
* @return boolean success
*/
public function createSettingsTable(){
$tablename = TeraWurflConfig::$TABLE_PREFIX.'Settings';
$checktable = "SHOW TABLES LIKE '$tablename'";
$this->numQueries++;
$res = $this->dbcon->query($checktable);
if($res->num_rows > 0) return true;
$createtable = "CREATE TABLE `".$tablename."` (
`id` varchar(64) NOT NULL,
`value` varchar(255) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=MyISAM";
$this->numQueries++;
$this->dbcon->query($createtable);
return true;
}
// Cache Table Functions
// should return (bool)false or the device array
public function getDeviceFromCache($userAgent){
$tablename = TeraWurflConfig::$TABLE_PREFIX.'Cache';
$this->numQueries++;
$res = $this->dbcon->query("SELECT * FROM `$tablename` WHERE `user_agent`=".$this->SQLPrep($userAgent)) or die("Error: ".$this->dbcon->error);
if($res->num_rows == 0){
$res->close();
//echo "[[UA NOT FOUND IN CACHE: $userAgent]]";
return false;
}
$data = $res->fetch_assoc();
$res->close();
return unserialize($data['cache_data']);
}
public function saveDeviceInCache($userAgent,$device){
$tablename = TeraWurflConfig::$TABLE_PREFIX.'Cache';
$ua = $this->SQLPrep($userAgent);
$packed_device = $this->SQLPrep(serialize($device));
$this->numQueries++;
$this->dbcon->query("INSERT DELAYED INTO `$tablename` (`user_agent`,`cache_data`) VALUES ($ua,$packed_device)");
if($this->dbcon->affected_rows > 0){
return true;
}
return false;
}
public function createCacheTable(){
$tablename = TeraWurflConfig::$TABLE_PREFIX.'Cache';
$droptable = "DROP TABLE IF EXISTS `$tablename`";
$createtable = "CREATE TABLE `$tablename` (
`user_agent` varchar(255) binary NOT NULL default '',
`cache_data` mediumtext NOT NULL,
PRIMARY KEY (`user_agent`)
) ENGINE=MyISAM";
$this->numQueries++;
$this->dbcon->query($droptable);
$this->numQueries++;
$this->dbcon->query($createtable);
return true;
}
public function createTempCacheTable(){
$tablename = TeraWurflConfig::$TABLE_PREFIX.'Cache'.self::$DB_TEMP_EXT;
$droptable = "DROP TABLE IF EXISTS `$tablename`";
$createtable = "CREATE TABLE `$tablename` (
`user_agent` varchar(255) binary NOT NULL default '',
`cache_data` mediumtext NOT NULL,
PRIMARY KEY (`user_agent`)
) ENGINE=MyISAM";
$this->numQueries++;
$this->dbcon->query($droptable);
$this->numQueries++;
$this->dbcon->query($createtable);
return true;
}
public function rebuildCacheTable(){
// We'll use this instance to rebuild the cache and to facilitate logging
$rebuilder = new TeraWurfl();
$cachetable = TeraWurflConfig::$TABLE_PREFIX.'Cache';
$temptable = TeraWurflConfig::$TABLE_PREFIX.'Cache'.self::$DB_TEMP_EXT;
$checkcachequery = "SHOW TABLES LIKE '$cachetable'";
$checkres = $this->dbcon->query($checkcachequery);
$this->numQueries++;
if($checkres->num_rows === 0){
// This can only happen if the table doesn't exist
$this->createCacheTable();
$this->numQueries++;
// This table must be empty, so we're finished
// $rebuilder->toLog($query,LOG_ERR,"rebuildCacheTable");
$rebuilder->toLog("Created empty cache table",LOG_NOTICE,"rebuildCacheTable");
return true;
}
$droptemptable = "DROP TABLE IF EXISTS `$temptable`";
$this->numQueries++;
$this->dbcon->query($droptemptable);
$query = "RENAME TABLE `$cachetable` TO `$temptable`";
$this->numQueries++;
$this->dbcon->query($query);
$this->createCacheTable();
$query = "SELECT `user_agent` FROM `$temptable`";
$this->numQueries++;
$res = $this->dbcon->query($query);
if($res->num_rows == 0){
// No records in cache table == nothing to rebuild
$rebuilder->toLog("Rebuilt cache table, existing table was empty - this is very unusual.",LOG_WARNING,"rebuildCacheTable");
return true;
}
while($dev = $res->fetch_assoc()){
// Just looking the device up will force it to be cached
$rebuilder->GetDeviceCapabilitiesFromAgent($dev['user_agent']);
// Reset the number of queries since we're not going to re-instantiate the object
$this->numQueries += $rebuilder->db->numQueries;
$rebuilder->db->numQueries = 0;
}
$droptable = "DROP TABLE IF EXISTS `$temptable`";
$this->numQueries++;
$this->dbcon->query($droptable);
$rebuilder->toLog("Rebuilt cache table.",LOG_NOTICE,"rebuildCacheTable");
return true;
}
// Supporting DB Functions
// truncate or drop+create given table
public function clearTable($tablename){
if($tablename == TeraWurflConfig::$TABLE_PREFIX.'Cache'){
$this->createCacheTable();
}else{
$this->createGenericDeviceTable($tablename);
}
}
/**
* Establishes connection to database (does not check for DB sanity)
*/
public function connect(){
$this->numQueries++;
if(strpos(TeraWurflConfig::$DB_HOST,':')){
list($host,$port) = explode(':',TeraWurflConfig::$DB_HOST,2);
$this->dbcon = @new mysqli($host,TeraWurflConfig::$DB_USER,TeraWurflConfig::$DB_PASS,TeraWurflConfig::$DB_SCHEMA,$port);
}else{
$this->dbcon = @new mysqli(TeraWurflConfig::$DB_HOST,TeraWurflConfig::$DB_USER,TeraWurflConfig::$DB_PASS,TeraWurflConfig::$DB_SCHEMA);
}
if(mysqli_connect_errno()){
$this->errors[]=mysqli_connect_error();
$this->connected = mysqli_connect_errno();
return false;
}
$this->connected = true;
return true;
}
public function updateSetting($key,$value){
$tablename = TeraWurflConfig::$TABLE_PREFIX.'Settings';
$query = sprintf("REPLACE INTO `%s` (`%s`, `%s`) VALUES (%s, %s)", $tablename, 'id', 'value', $this->SQLPrep($key), $this->SQLPrep($value));
$this->numQueries++;
$this->dbcon->query($query);
}
public function getSetting($key){
$query = "SELECT `value` FROM `".TeraWurflConfig::$TABLE_PREFIX.'Settings'."` WHERE `id` = ".$this->SQLPrep($key);
$this->numQueries++;
$res = $this->dbcon->query($query);
if($res->num_rows == 0) return null;
$row = $res->fetch_assoc();
return $row['value'];
}
// prep raw text for use in queries (adding quotes if necessary)
public function SQLPrep($value){
if($value == '') $value = 'NULL';
else if (!is_numeric($value) || $value[0] == '0') $value = "'" . $this->dbcon->real_escape_string($value) . "'"; //Quote if not integer
return $value;
}
public function getTableList(){
$tablesres = $this->dbcon->query("SHOW TABLES");
$tables = array();
while($table = $tablesres->fetch_row())$tables[]=$table[0];
$tablesres->close();
return $tables;
}
public function getMatcherTableList(){
$tablesres = $this->dbcon->query("SHOW TABLES LIKE '".TeraWurflConfig::$TABLE_PREFIX."\\_%'");
$tables = array();
while($table = $tablesres->fetch_row())$tables[]=$table[0];
$tablesres->close();
return $tables;
}
public function getTableStats($table){
$stats = array();
$fields = array();
$fieldnames = array();
$fieldsres = $this->dbcon->query("SHOW COLUMNS FROM ".$table);
while($row = $fieldsres->fetch_assoc()){
$fields[] = 'CHAR_LENGTH(`'.$row['Field'].'`)';
$fieldnames[]=$row['Field'];
}
$fieldsres->close();
$bytesizequery = "SUM(".implode('+',$fields).") AS `bytesize`";
$query = "SELECT COUNT(*) AS `rowcount`, $bytesizequery FROM `$table`";
$res = $this->dbcon->query($query);
$rows = $res->fetch_assoc();
$stats['rows'] = $rows['rowcount'];
$stats['bytesize'] = $rows['bytesize'];
$res->close();
if(in_array("actual_device_root",$fieldnames)){
$res = $this->dbcon->query("SELECT COUNT(*) AS `devcount` FROM `$table` WHERE actual_device_root=1");
$row = $res->fetch_assoc();
$stats['actual_devices'] = $row['devcount'];
$res->close();
}
return $stats;
}
public function getCachedUserAgents(){
$uas = array();
$cacheres = $this->dbcon->query("SELECT user_agent FROM ".TeraWurflConfig::$TABLE_PREFIX.'Cache'." ORDER BY user_agent");
while($ua = $cacheres->fetch_row())$uas[]=$ua[0];
$cacheres->close();
return $uas;
}
public function getServerVersion(){
$res = $this->dbcon->query("SELECT version() AS `version`");
if(!$res || $res->num_rows == 0) return '[not connected]';
$row = $res->fetch_assoc();
return($row['version']);
}
}

Source for file TeraWurflDatabase_MySQL4.php