* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
+if (!defined('GNUSOCIAL')) { exit(1); }
class Memcached_DataObject extends Safe_DataObject
{
* @param mixed $v key field value, or leave out for primary key lookup
* @return mixed Memcached_DataObject subtype or false
*/
- function &staticGet($cls, $k, $v=null)
+ static function getClassKV($cls, $k, $v=null)
{
if (is_null($v)) {
$v = $k;
- // XXX: HACK!
- $i = new $cls;
- $keys = $i->keys();
+ $keys = static::pkeyCols();
+ if (count($keys) > 1) {
+ // FIXME: maybe call pkeyGetClass() ourselves?
+ throw new Exception('Use pkeyGetClass() for compound primary keys');
+ }
$k = $keys[0];
- unset($i);
}
- $i = Memcached_DataObject::getcached($cls, $k, $v);
+ $i = self::getcached($cls, $k, $v);
if ($i === false) { // false == cache miss
- $i = DB_DataObject::factory($cls);
- if (empty($i)) {
- $i = false;
- return $i;
- }
+ $i = new $cls;
$result = $i->get($k, $v);
if ($result) {
// Hit!
}
return $i;
}
-
+
/**
* Get multiple items from the database by key
- *
+ *
* @param string $cls Class to fetch
* @param string $keyCol name of column for key
* @param array $keyVals key values to fetch
- * @param boolean $skipNulls return only non-null results?
- *
+ *
* @return array Array of objects, in order
*/
- function multiGet($cls, $keyCol, $keyVals, $skipNulls=true)
- {
- $result = self::pivotGet($cls, $keyCol, $keyVals);
-
- $values = array_values($result);
-
- if ($skipNulls) {
- $tmp = array();
- foreach ($values as $value) {
- if (!empty($value)) {
- $tmp[] = $value;
- }
- }
- $values = $tmp;
- }
-
- return new ArrayWrapper($values);
- }
-
+ static function multiGetClass($cls, $keyCol, array $keyVals)
+ {
+ $obj = new $cls;
+
+ // PHP compatible datatype for settype() below
+ $colType = $obj->columnType($keyCol);
+
+ if (!in_array($colType, array('integer', 'int'))) {
+ // This is because I'm afraid to escape strings incorrectly
+ // in the way we use them below in FIND_IN_SET for MariaDB
+ throw new ServerException('Cannot do multiGet on anything but integer columns');
+ }
+
+ $obj->whereAddIn($keyCol, $keyVals, $colType);
+
+ // Since we're inputting straight to a query: format and escape
+ foreach ($keyVals as $key=>$val) {
+ settype($val, $colType);
+ $keyVals[$key] = $obj->escape($val);
+ }
+
+ // FIND_IN_SET will make sure we keep the desired order
+ $obj->orderBy(sprintf("FIND_IN_SET(%s, '%s')", $keyCol, implode(',', $keyVals)));
+ $obj->find();
+
+ return $obj;
+ }
+
/**
* Get multiple items from the database by key
- *
+ *
* @param string $cls Class to fetch
* @param string $keyCol name of column for key
* @param array $keyVals key values to fetch
* @param boolean $otherCols Other columns to hold fixed
- *
+ *
* @return array Array mapping $keyVals to objects, or null if not found
*/
- static function pivotGet($cls, $keyCol, $keyVals, $otherCols = array())
+ static function pivotGetClass($cls, $keyCol, array $keyVals, array $otherCols = array())
{
if (is_array($keyCol)) {
foreach ($keyVals as $keyVal) {
} else {
$result = array_fill_keys($keyVals, null);
}
-
- $toFetch = array();
-
- foreach ($keyVals as $keyVal) {
+
+ $toFetch = array();
+
+ foreach ($keyVals as $keyVal) {
if (is_array($keyCol)) {
$kv = array_combine($keyCol, $keyVal);
$kv = array($keyCol => $keyVal);
}
- $kv = array_merge($otherCols, $kv);
-
- $i = self::multicache($cls, $kv);
-
- if ($i !== false) {
+ $kv = array_merge($otherCols, $kv);
+
+ $i = self::multicache($cls, $kv);
+
+ if ($i !== false) {
if (is_array($keyCol)) {
$result[implode(',', $keyVal)] = $i;
} else {
$result[$keyVal] = $i;
}
- } else if (!empty($keyVal)) {
- $toFetch[] = $keyVal;
- }
- }
-
- if (count($toFetch) > 0) {
- $i = DB_DataObject::factory($cls);
- if (empty($i)) {
- throw new Exception(_('Cannot instantiate class ' . $cls));
+ } else if (!empty($keyVal)) {
+ $toFetch[] = $keyVal;
}
+ }
+
+ if (count($toFetch) > 0) {
+ $i = new $cls;
foreach ($otherCols as $otherKeyCol => $otherKeyVal) {
$i->$otherKeyCol = $otherKeyVal;
}
} else {
$i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
}
- if ($i->find()) {
- while ($i->fetch()) {
- $copy = clone($i);
- $copy->encache();
+ if ($i->find()) {
+ while ($i->fetch()) {
+ $copy = clone($i);
+ $copy->encache();
if (is_array($keyCol)) {
$vals = array();
foreach ($keyCol as $k) {
} else {
$result[$i->$keyCol] = $copy;
}
- }
- }
-
- // Save state of DB misses
-
- foreach ($toFetch as $keyVal) {
+ }
+ }
+
+ // Save state of DB misses
+
+ foreach ($toFetch as $keyVal) {
$r = null;
if (is_array($keyCol)) {
$r = $result[implode(',', $keyVal)];
} else {
$r = $result[$keyVal];
}
- if (empty($r)) {
+ if (empty($r)) {
if (is_array($keyCol)) {
$kv = array_combine($keyCol, $keyVal);
} else {
$kv = array($keyCol => $keyVal);
}
$kv = array_merge($otherCols, $kv);
- // save the fact that no such row exists
- $c = self::memcache();
- if (!empty($c)) {
- $ck = self::multicacheKey($cls, $kv);
- $c->set($ck, null);
- }
- }
- }
- }
+ // save the fact that no such row exists
+ $c = self::memcache();
+ if (!empty($c)) {
+ $ck = self::multicacheKey($cls, $kv);
+ $c->set($ck, null);
+ }
+ }
+ }
+ }
- return $result;
+ return $result;
}
static function _inMultiKey($i, $cols, $values)
return $query;
}
- static function pkeyCols($cls)
+ static function pkeyColsClass($cls)
{
- $i = DB_DataObject::factory($cls);
- if (empty($i)) {
- throw new Exception(_('Cannot instantiate a ' . $cls));
- }
+ $i = new $cls;
$types = $i->keyTypes();
ksort($types);
return $pkey;
}
- function listGet($cls, $keyCol, $keyVals)
+ static function listFindClass($cls, $keyCol, array $keyVals)
+ {
+ $i = new $cls;
+ $i->whereAddIn($keyCol, $keyVals, $i->columnType($keyCol));
+ if (!$i->find()) {
+ throw new NoResultException($i);
+ }
+
+ return $i;
+ }
+
+ static function listGetClass($cls, $keyCol, array $keyVals)
{
- $pkeyMap = array_fill_keys($keyVals, array());
+ $pkeyMap = array_fill_keys($keyVals, array());
$result = array_fill_keys($keyVals, array());
- $pkeyCols = self::pkeyCols($cls);
+ $pkeyCols = static::pkeyCols();
- $toFetch = array();
+ $toFetch = array();
$allPkeys = array();
// We only cache keys -- not objects!
- foreach ($keyVals as $keyVal) {
- $l = self::cacheGet(sprintf("%s:list-ids:%s:%s", $cls, $keyCol, $keyVal));
- if ($l !== false) {
- $pkeyMap[$keyVal] = $l;
+ foreach ($keyVals as $keyVal) {
+ $l = self::cacheGet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal));
+ if ($l !== false) {
+ $pkeyMap[$keyVal] = $l;
foreach ($l as $pkey) {
$allPkeys[] = $pkey;
}
- } else {
- $toFetch[] = $keyVal;
- }
- }
+ } else {
+ $toFetch[] = $keyVal;
+ }
+ }
if (count($allPkeys) > 0) {
- $keyResults = self::pivotGet($cls, $pkeyCols, $allPkeys);
+ $keyResults = self::pivotGetClass($cls, $pkeyCols, $allPkeys);
foreach ($pkeyMap as $keyVal => $pkeyList) {
foreach ($pkeyList as $pkeyVal) {
}
if (count($toFetch) > 0) {
- $i = DB_DataObject::factory($cls);
- if (empty($i)) {
- throw new Exception(_('Cannot instantiate class ' . $cls));
- }
- $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
- if ($i->find()) {
- sprintf("listGet() got {$i->N} results for class $cls key $keyCol");
+ try {
+ $i = self::listFindClass($cls, $keyCol, $toFetch);
+
while ($i->fetch()) {
$copy = clone($i);
$copy->encache();
}
$pkeyMap[$i->$keyCol][] = $pkeyVal;
}
- }
- foreach ($toFetch as $keyVal) {
- self::cacheSet(sprintf("%s:list-ids:%s:%s", $cls, $keyCol, $keyVal),
+ } catch (NoResultException $e) {
+ // no results found for our keyVals, so we leave them as empty arrays
+ }
+ foreach ($toFetch as $keyVal) {
+ self::cacheSet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal),
$pkeyMap[$keyVal]);
- }
- }
-
- return $result;
- }
-
- function columnType($columnName)
- {
- $keys = $this->table();
- if (!array_key_exists($columnName, $keys)) {
- throw new Exception('Unknown key column ' . $columnName . ' in ' . join(',', array_keys($keys)));
- }
-
- $def = $keys[$columnName];
-
- if ($def & DB_DATAOBJECT_INT) {
- return 'integer';
- } else {
- return 'string';
- }
- }
-
+ }
+ }
+
+ return $result;
+ }
+
+ function columnType($columnName)
+ {
+ $keys = $this->table();
+ if (!array_key_exists($columnName, $keys)) {
+ throw new Exception('Unknown key column ' . $columnName . ' in ' . join(',', array_keys($keys)));
+ }
+
+ $def = $keys[$columnName];
+
+ if ($def & DB_DATAOBJECT_INT) {
+ return 'integer';
+ } else {
+ return 'string';
+ }
+ }
+
/**
- * @fixme Should this return false on lookup fail to match staticGet?
+ * @todo FIXME: Should this return false on lookup fail to match getKV?
*/
- function pkeyGet($cls, $kv)
+ static function pkeyGetClass($cls, array $kv)
{
- $i = Memcached_DataObject::multicache($cls, $kv);
+ $i = self::multicache($cls, $kv);
if ($i !== false) { // false == cache miss
return $i;
} else {
- $i = DB_DataObject::factory($cls);
- if (empty($i) || PEAR::isError($i)) {
- return false;
- }
+ $i = new $cls;
foreach ($kv as $k => $v) {
- if (is_null($v)) {
- // XXX: possible SQL injection...? Don't
- // pass keys from the browser, eh.
- $i->whereAdd("$k is null");
- } else {
- $i->$k = $v;
- }
+ if (is_null($v)) {
+ // XXX: possible SQL injection...? Don't
+ // pass keys from the browser, eh.
+ $i->whereAdd("$k is null");
+ } else {
+ $i->$k = $v;
+ }
}
if ($i->find(true)) {
$i->encache();
return $result;
}
- function update($orig=null)
+ function update($dataObject=false)
{
- if (is_object($orig) && $orig instanceof Memcached_DataObject) {
- $orig->decache(); # might be different keys
+ if (is_object($dataObject) && $dataObject instanceof Memcached_DataObject) {
+ $dataObject->decache(); # might be different keys
}
- $result = parent::update($orig);
- if ($result) {
+ $result = parent::update($dataObject);
+ if ($result !== false) {
$this->fixupTimestamps();
$this->encache();
}
return $result;
}
- function delete()
+ function delete($useWhere=false)
{
$this->decache(); # while we still have the values!
- return parent::delete();
+ return parent::delete($useWhere);
}
static function memcache() {
}
static function getcached($cls, $k, $v) {
- $c = Memcached_DataObject::memcache();
+ $c = self::memcache();
if (!$c) {
return false;
} else {
- $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
+ $obj = $c->get(self::cacheKey($cls, $k, $v));
if (0 == strcasecmp($cls, 'User')) {
// Special case for User
if (is_object($obj) && is_object($obj->id)) {
common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
- $c->delete(Memcached_DataObject::cacheKey($cls, $k, $v));
+ $c->delete(self::cacheKey($cls, $k, $v));
return false;
}
}
}
global $_DB_DATAOBJECT;
- if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
+ if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()."__keys"])) {
$this->databaseStructure();
}
- return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
+ return $_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()."__keys"];
}
function encache()
{
- $c = $this->memcache();
+ $c = self::memcache();
if (!$c) {
return false;
function decache()
{
- $c = $this->memcache();
+ $c = self::memcache();
if (!$c) {
return false;
if (empty($this->$key)) {
continue;
}
- $ckeys[] = $this->cacheKey($this->tableName(), $key, self::valueString($this->$key));
+ $ckeys[] = self::cacheKey($this->tableName(), $key, self::valueString($this->$key));
} else if ($type == 'K' || $type == 'N') {
$pkey[] = $key;
$pval[] = self::valueString($this->$key);
$pvals = implode(',', $pval);
$pkeys = implode(',', $pkey);
- $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);
+ $ckeys[] = self::cacheKey($this->tableName(), $pkeys, $pvals);
return $ckeys;
}
- function multicache($cls, $kv)
+ static function multicache($cls, $kv)
{
ksort($kv);
$c = self::memcache();
static function cachedQuery($cls, $qry, $expiry=3600)
{
- $c = Memcached_DataObject::memcache();
+ $c = self::memcache();
if (!$c) {
$inst = new $cls();
$inst->query($qry);
'delete',
'update',
'find');
- $ignoreStatic = array('staticGet',
+ $ignoreStatic = array('getKV',
+ 'getClassKV',
'pkeyGet',
+ 'pkeyGetClass',
'cachedQuery');
$here = get_class($this); // if we get confused
$bt = debug_backtrace();
continue;
}
if (in_array($func, $ignoreStatic)) {
- continue; // @fixme this shouldn't be needed?
+ continue; // @todo FIXME: This shouldn't be needed?
}
$here = get_class($frame['object']) . '->' . $func;
break;
return $string;
}
- // We overload so that 'SET NAMES "utf8"' is called for
+ // We overload so that 'SET NAMES "utf8mb4"' is called for
// each connection
function _connect()
{
- global $_DB_DATAOBJECT;
+ global $_DB_DATAOBJECT, $_PEAR;
$sum = $this->_getDbDsnMD5();
if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
- !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
+ !$_PEAR->isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
$exists = true;
} else {
$exists = false;
// we'll need some fancier logic here.
if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
- if (!empty($conn)) {
+ if ($_PEAR->isError($conn)) {
+ common_log(LOG_WARNING, __METHOD__ . " cannot disconnect failed DB connection: '".$conn->getMessage()."'.");
+ } elseif (!empty($conn)) {
$conn->disconnect();
}
unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
common_config('db', 'utf8')) {
$conn = $DB->connection;
if (!empty($conn)) {
- if ($DB instanceof DB_mysqli) {
- mysqli_set_charset($conn, 'utf8');
- } else if ($DB instanceof DB_mysql) {
- mysql_set_charset('utf8', $conn);
+ if ($DB instanceof DB_mysqli || $DB instanceof MDB2_Driver_mysqli) {
+ mysqli_set_charset($conn, 'utf8mb4');
+ } else if ($DB instanceof DB_mysql || $DB instanceof MDB2_Driver_mysql) {
+ mysql_set_charset('utf8mb4', $conn);
}
}
}
global $_DB_DATAOBJECT;
if (empty($_DB_DATAOBJECT['CONFIG'])) {
- DB_DataObject::_loadConfig();
+ self::_loadConfig();
}
$options = &$_DB_DATAOBJECT['CONFIG'];
if (!$dsn) {
if (!$this->_database) {
- $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
+ $this->_database = isset($options["table_{$this->tableName()}"]) ? $options["table_{$this->tableName()}"] : null;
}
if ($this->_database && !empty($options["database_{$this->_database}"])) {
if (!$dsn) {
// TRANS: Exception thrown when database name or Data Source Name could not be found.
- throw new Exception(_("No database name or DSN found anywhere."));
+ throw new Exception(_('No database name or DSN found anywhere.'));
}
return $dsn;