1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000 |
- <?php
- defined('GNUSOCIAL') || die();
- class Memcached_DataObject extends Safe_DataObject
- {
-
- public static function getClassKV($cls, $k, $v = null)
- {
- if (is_null($v)) {
- $v = $k;
- $keys = static::pkeyCols();
- if (count($keys) > 1) {
-
- throw new Exception('Use pkeyGetClass() for compound primary keys');
- }
- $k = $keys[0];
- }
- $i = self::getcached($cls, $k, $v);
- if ($i === false) {
- $i = new $cls;
- $result = $i->get($k, $v);
- if ($result) {
-
- $i->encache();
- } else {
-
- $c = self::memcache();
- if (!empty($c)) {
- $ck = self::cachekey($cls, $k, $v);
- $c->set($ck, null);
- }
- $i = false;
- }
- }
- return $i;
- }
-
- public static function multiGetClass($cls, $keyCol, array $keyVals, $skipNulls = true)
- {
- $obj = new $cls;
-
- $colType = $obj->columnType($keyCol);
- if (!in_array($colType, array('integer', 'int'))) {
-
-
- throw new ServerException('Cannot do multiGet on anything but integer columns');
- }
- if ($skipNulls) {
- foreach ($keyVals as $key=>$val) {
- if (is_null($val)) {
- unset($keyVals[$key]);
- }
- }
- }
- $obj->whereAddIn($keyCol, $keyVals, $colType);
-
- foreach ($keyVals as $key=>$val) {
- settype($val, $colType);
- $keyVals[$key] = $obj->escape($val);
- }
- switch (common_config('db', 'type')) {
- case 'pgsql':
-
- $obj->orderBy(sprintf(
- "position(',' || CAST(%s AS text) || ',' IN ',%s,')",
- $keyCol,
- implode(',', $keyVals)
- ));
- break;
- case 'mysql':
-
- $obj->orderBy(sprintf(
- "find_in_set(%s, '%s')",
- $keyCol,
- implode(',', $keyVals)
- ));
- break;
- default:
- throw new ServerException('Unknown DB type selected.');
- }
- $obj->find();
- return $obj;
- }
-
- public static function pivotGetClass($cls, $keyCol, array $keyVals, array $otherCols = [])
- {
- if (is_array($keyCol)) {
- foreach ($keyVals as $keyVal) {
- $result[implode(',', $keyVal)] = null;
- }
- } else {
- $result = array_fill_keys($keyVals, null);
- }
- $toFetch = array();
- foreach ($keyVals as $keyVal) {
- if (is_array($keyCol)) {
- $kv = array_combine($keyCol, $keyVal);
- } else {
- $kv = array($keyCol => $keyVal);
- }
- $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;
- }
- } elseif (!empty($keyVal)) {
- $toFetch[] = $keyVal;
- }
- }
- if (count($toFetch) > 0) {
- $i = new $cls;
- foreach ($otherCols as $otherKeyCol => $otherKeyVal) {
- $i->$otherKeyCol = $otherKeyVal;
- }
- if (is_array($keyCol)) {
- $i->whereAdd(self::_inMultiKey($i, $keyCol, $toFetch));
- } else {
- $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
- }
- if ($i->find()) {
- while ($i->fetch()) {
- $copy = clone($i);
- $copy->encache();
- if (is_array($keyCol)) {
- $vals = array();
- foreach ($keyCol as $k) {
- $vals[] = $i->$k;
- }
- $result[implode(',', $vals)] = $copy;
- } else {
- $result[$i->$keyCol] = $copy;
- }
- }
- }
-
- foreach ($toFetch as $keyVal) {
- $r = null;
- if (is_array($keyCol)) {
- $r = $result[implode(',', $keyVal)];
- } else {
- $r = $result[$keyVal];
- }
- if (empty($r)) {
- if (is_array($keyCol)) {
- $kv = array_combine($keyCol, $keyVal);
- } else {
- $kv = array($keyCol => $keyVal);
- }
- $kv = array_merge($otherCols, $kv);
-
- $c = self::memcache();
- if (!empty($c)) {
- $ck = self::multicacheKey($cls, $kv);
- $c->set($ck, null);
- }
- }
- }
- }
- return $result;
- }
- public static function _inMultiKey($i, $cols, $values)
- {
- $types = array();
- foreach ($cols as $col) {
- $types[$col] = $i->columnType($col);
- }
- $first = true;
- $query = '';
- foreach ($values as $value) {
- if ($first) {
- $query .= '( ';
- $first = false;
- } else {
- $query .= ' OR ';
- }
- $query .= '( ';
- $i = 0;
- $firstc = true;
- foreach ($cols as $col) {
- if (!$firstc) {
- $query .= ' AND ';
- } else {
- $firstc = false;
- }
- switch ($types[$col]) {
- case 'string':
- case 'datetime':
- $query .= sprintf("%s = %s", $col, $i->_quote($value[$i]));
- break;
- default:
- $query .= sprintf("%s = %s", $col, $value[$i]);
- break;
- }
- }
- $query .= ') ';
- }
- if (!$first) {
- $query .= ' )';
- }
- return $query;
- }
- public static function pkeyColsClass($cls)
- {
- $i = new $cls;
- $types = $i->keyTypes();
- ksort($types);
- $pkey = array();
- foreach ($types as $key => $type) {
- if ($type == 'K' || $type == 'N') {
- $pkey[] = $key;
- }
- }
- return $pkey;
- }
- public 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;
- }
- public static function listGetClass($cls, $keyCol, array $keyVals)
- {
- $pkeyMap = array_fill_keys($keyVals, array());
- $result = array_fill_keys($keyVals, array());
- $pkeyCols = static::pkeyCols();
- $toFetch = array();
- $allPkeys = array();
-
- 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;
- }
- }
- if (count($allPkeys) > 0) {
- $keyResults = self::pivotGetClass($cls, $pkeyCols, $allPkeys);
- foreach ($pkeyMap as $keyVal => $pkeyList) {
- foreach ($pkeyList as $pkeyVal) {
- $i = $keyResults[implode(',', $pkeyVal)];
- if (!empty($i)) {
- $result[$keyVal][] = $i;
- }
- }
- }
- }
- if (count($toFetch) > 0) {
- try {
- $i = self::listFindClass($cls, $keyCol, $toFetch);
- while ($i->fetch()) {
- $copy = clone($i);
- $copy->encache();
- $result[$i->$keyCol][] = $copy;
- $pkeyVal = array();
- foreach ($pkeyCols as $pkeyCol) {
- $pkeyVal[] = $i->$pkeyCol;
- }
- $pkeyMap[$i->$keyCol][] = $pkeyVal;
- }
- } catch (NoResultException $e) {
-
- }
- foreach ($toFetch as $keyVal) {
- self::cacheSet(
- sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal),
- $pkeyMap[$keyVal]
- );
- }
- }
- return $result;
- }
- public 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';
- }
- }
-
- public static function pkeyGetClass($cls, array $kv)
- {
- $i = self::multicache($cls, $kv);
- if ($i !== false) {
- return $i;
- } else {
- $i = new $cls;
- foreach ($kv as $k => $v) {
- if (is_null($v)) {
-
-
- $i->whereAdd("$k is null");
- } else {
- $i->$k = $v;
- }
- }
- if ($i->find(true)) {
- $i->encache();
- } else {
- $i = null;
- $c = self::memcache();
- if (!empty($c)) {
- $ck = self::multicacheKey($cls, $kv);
- $c->set($ck, null);
- }
- }
- return $i;
- }
- }
- public function insert()
- {
- $result = parent::insert();
- if ($result) {
- $this->fixupTimestamps();
- $this->encache();
- }
- return $result;
- }
- public function update($dataObject = false)
- {
- if (is_object($dataObject) && $dataObject instanceof Memcached_DataObject) {
- $dataObject->decache();
- }
- $result = parent::update($dataObject);
- if ($result !== false) {
- $this->fixupTimestamps();
- $this->encache();
- }
- return $result;
- }
- public function delete($useWhere = false)
- {
- $this->decache();
- return parent::delete($useWhere);
- }
- public static function memcache()
- {
- return Cache::instance();
- }
- public static function cacheKey($cls, $k, $v)
- {
- if (is_object($cls) || is_object($k) || (is_object($v) && !($v instanceof DB_DataObject_Cast))) {
- $e = new Exception();
- common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
- str_replace("\n", " ", $e->getTraceAsString()));
- }
- $vstr = self::valueString($v);
- return Cache::key(strtolower($cls).':'.$k.':'.$vstr);
- }
- public static function getcached($cls, $k, $v)
- {
- $c = self::memcache();
- if (!$c) {
- return false;
- } else {
- $obj = $c->get(self::cacheKey($cls, $k, $v));
- if (0 == strcasecmp($cls, '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(self::cacheKey($cls, $k, $v));
- return false;
- }
- }
- return $obj;
- }
- }
- public function keyTypes()
- {
-
-
- $keys = $this->keys();
- $keyskeys = array_keys($keys);
- if (is_string($keyskeys[0])) {
- return $keys;
- }
- global $_DB_DATAOBJECT;
- if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()."__keys"])) {
- $this->databaseStructure();
- }
- return $_DB_DATAOBJECT['INI'][$this->_database][$this->tableName()."__keys"];
- }
- public function encache()
- {
- $c = self::memcache();
- if (!$c) {
- return false;
- } elseif ($this->tableName() === 'user' && is_object($this->id)) {
-
- $e = new Exception();
- common_log(LOG_ERR, __METHOD__ . ' caching user with User object as ID ' .
- str_replace("\n", " ", $e->getTraceAsString()));
- return false;
- } else {
- $keys = $this->_allCacheKeys();
- foreach ($keys as $key) {
- $c->set($key, $this);
- }
- }
- }
- public function decache()
- {
- $c = self::memcache();
- if (!$c) {
- return false;
- }
- $keys = $this->_allCacheKeys();
- foreach ($keys as $key) {
- $c->delete($key, $this);
- }
- }
- public function _allCacheKeys()
- {
- $ckeys = array();
- $types = $this->keyTypes();
- ksort($types);
- $pkey = array();
- $pval = array();
- foreach ($types as $key => $type) {
- assert(!empty($key));
- if ($type == 'U') {
- if (empty($this->$key)) {
- continue;
- }
- $ckeys[] = self::cacheKey($this->tableName(), $key, self::valueString($this->$key));
- } elseif (in_array($type, ['K', 'N'])) {
- $pkey[] = $key;
- $pval[] = self::valueString($this->$key);
- } else {
-
- throw new Exception("Unknown key type $key => $type for " . $this->tableName());
- }
- }
- assert(count($pkey) > 0);
-
- $pvals = implode(',', $pval);
- $pkeys = implode(',', $pkey);
- $ckeys[] = self::cacheKey($this->tableName(), $pkeys, $pvals);
- return $ckeys;
- }
- public static function multicache($cls, $kv)
- {
- ksort($kv);
- $c = self::memcache();
- if (!$c) {
- return false;
- } else {
- return $c->get(self::multicacheKey($cls, $kv));
- }
- }
- public static function multicacheKey($cls, $kv)
- {
- ksort($kv);
- $pkeys = implode(',', array_keys($kv));
- $pvals = implode(',', array_values($kv));
- return self::cacheKey($cls, $pkeys, $pvals);
- }
- public function getSearchEngine($table)
- {
- require_once INSTALLDIR . '/lib/search/search_engines.php';
- if (Event::handle('GetSearchEngine', [$this, $table, &$search_engine])) {
- $type = common_config('search', 'type');
- if ($type === 'like') {
- $search_engine = new SQLLikeSearch($this, $table);
- } elseif ($type === 'fulltext') {
- switch (common_config('db', 'type')) {
- case 'pgsql':
- $search_engine = new PostgreSQLSearch($this, $table);
- break;
- case 'mysql':
- $search_engine = new MySQLSearch($this, $table);
- break;
- default:
- throw new ServerException('Unknown DB type selected.');
- }
- } else {
-
- throw new ServerException('Unknown search type: ' . $type);
- }
- }
- return $search_engine;
- }
- public static function cachedQuery($cls, $qry, $expiry = 3600)
- {
- $c = self::memcache();
- if (!$c) {
- $inst = new $cls();
- $inst->query($qry);
- return $inst;
- }
- $key_part = Cache::keyize($cls).':'.md5($qry);
- $ckey = Cache::key($key_part);
- $stored = $c->get($ckey);
- if ($stored !== false) {
- return new ArrayWrapper($stored);
- }
- $inst = new $cls();
- $inst->query($qry);
- $cached = array();
- while ($inst->fetch()) {
- $cached[] = clone($inst);
- }
- $inst->free();
- $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
- return new ArrayWrapper($cached);
- }
-
- public function _query($string)
- {
- if (common_config('db', 'annotate_queries')) {
- $string = $this->annotateQuery($string);
- }
- $start = hrtime(true);
- $fail = false;
- $result = null;
- if (Event::handle('StartDBQuery', array($this, $string, &$result))) {
- common_perf_counter('query', $string);
- try {
- $result = parent::_query($string);
- } catch (Exception $e) {
- $fail = $e;
- }
- Event::handle('EndDBQuery', array($this, $string, &$result));
- }
- $delta = (hrtime(true) - $start) / 1000000000;
- $limit = common_config('db', 'log_slow_queries');
- if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
- $clean = $this->sanitizeQuery($string);
- if ($fail) {
- $msg = sprintf("FAILED DB query (%0.3fs): %s - %s", $delta, $fail->getMessage(), $clean);
- } else {
- $msg = sprintf("DB query (%0.3fs): %s", $delta, $clean);
- }
- common_log(LOG_DEBUG, $msg);
- }
- if ($fail) {
- throw $fail;
- }
- return $result;
- }
-
- public function annotateQuery($string)
- {
- $ignore = array('annotateQuery',
- '_query',
- 'query',
- 'get',
- 'insert',
- 'delete',
- 'update',
- 'find');
- $ignoreStatic = array('getKV',
- 'getClassKV',
- 'pkeyGet',
- 'pkeyGetClass',
- 'cachedQuery');
- $here = get_class($this);
- $bt = debug_backtrace();
-
- foreach ($bt as $frame) {
- $func = $frame['function'];
- if (isset($frame['type']) && $frame['type'] == '::') {
- if (in_array($func, $ignoreStatic)) {
- continue;
- }
- $here = $frame['class'] . '::' . $func;
- break;
- } elseif (isset($frame['type']) && $frame['type'] === '->') {
- if ($frame['object'] === $this && in_array($func, $ignore)) {
- continue;
- }
- if (in_array($func, $ignoreStatic)) {
- continue;
- }
- $here = get_class($frame['object']) . '->' . $func;
- break;
- }
- $here = $func;
- break;
- }
- if (php_sapi_name() == 'cli') {
- $context = basename($_SERVER['PHP_SELF']);
- } else {
- $context = $_SERVER['REQUEST_METHOD'];
- }
-
-
- $parts = explode(' ', $string, 2);
- $parts[0] .= " /* $context $here */";
- return implode(' ', $parts);
- }
-
-
- public function sanitizeQuery($string)
- {
- $string = preg_replace('/\s+/', ' ', $string);
- $string = trim($string);
- return $string;
- }
-
-
- public function _connect()
- {
- global $_DB_DATAOBJECT, $_PEAR;
- $sum = $this->_getDbDsnMD5();
- if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
- !$_PEAR->isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
- $exists = true;
- } else {
- $exists = false;
- }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
- foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $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]);
- }
- }
- $result = parent::_connect();
- if ($result && !$exists) {
- $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
- if (common_config('db', 'type') == 'mysql' &&
- common_config('db', 'utf8')) {
- $conn = $DB->connection;
- if (!empty($conn)) {
- if ($DB instanceof DB_mysqli || $DB instanceof MDB2_Driver_mysqli) {
- mysqli_set_charset($conn, 'utf8mb4');
- } elseif ($DB instanceof DB_mysql || $DB instanceof MDB2_Driver_mysql) {
- mysql_set_charset('utf8mb4', $conn);
- }
- }
- }
-
- if (common_config('db', 'type') == 'mysql') {
- parent::_query("set time_zone='+0:00'");
- }
- }
- return $result;
- }
-
- public function _getDbDsnMD5()
- {
- if ($this->_database_dsn_md5) {
- return $this->_database_dsn_md5;
- }
- $dsn = $this->_getDbDsn();
- if (is_string($dsn)) {
- $sum = md5($dsn);
- } else {
-
- $sum = md5(serialize($dsn));
- }
- return $sum;
- }
- public function _getDbDsn()
- {
- global $_DB_DATAOBJECT;
- if (empty($_DB_DATAOBJECT['CONFIG'])) {
- self::_loadConfig();
- }
- $options = &$_DB_DATAOBJECT['CONFIG'];
-
- $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
- if (!$dsn) {
- if (!$this->_database) {
- $this->_database = isset($options["table_{$this->tableName()}"]) ? $options["table_{$this->tableName()}"] : null;
- }
- if ($this->_database && !empty($options["database_{$this->_database}"])) {
- $dsn = $options["database_{$this->_database}"];
- } elseif (!empty($options['database'])) {
- $dsn = $options['database'];
- }
- }
- if (!$dsn) {
-
- throw new Exception(_('No database name or DSN found anywhere.'));
- }
- return $dsn;
- }
- public static function blow()
- {
- $c = self::memcache();
- if (empty($c)) {
- return false;
- }
- $args = func_get_args();
- $format = array_shift($args);
- $keyPart = vsprintf($format, $args);
- $cacheKey = Cache::key($keyPart);
- return $c->delete($cacheKey);
- }
- public function fixupTimestamps()
- {
-
- $columns = $this->table();
- foreach ($columns as $name => $type) {
- if ($type & DB_DATAOBJECT_MYSQLTIMESTAMP) {
- $this->$name = common_sql_now();
- }
- }
- }
- public function debugDump()
- {
- common_debug("debugDump: " . common_log_objstring($this));
- }
- public function raiseError($message, $type = null, $behavior = null)
- {
- $id = get_class($this);
- if (!empty($this->id)) {
- $id .= ':' . $this->id;
- }
- if ($message instanceof PEAR_Error) {
- $message = $message->getMessage();
- }
-
- throw new ServerException("[$id] DB_DataObject error [$type]: $message");
- }
- public static function cacheGet($keyPart)
- {
- $c = self::memcache();
- if (empty($c)) {
- return false;
- }
- $cacheKey = Cache::key($keyPart);
- return $c->get($cacheKey);
- }
- public static function cacheSet($keyPart, $value, $flag = null, $expiry = null)
- {
- $c = self::memcache();
- if (empty($c)) {
- return false;
- }
- $cacheKey = Cache::key($keyPart);
- return $c->set($cacheKey, $value, $flag, $expiry);
- }
- public static function valueString($v)
- {
- $vstr = null;
- if (is_object($v) && $v instanceof DB_DataObject_Cast) {
- switch ($v->type) {
- case 'date':
- $vstr = "{$v->year} - {$v->month} - {$v->day}";
- break;
- case 'sql':
- if (strcasecmp($v->value, 'NULL') == 0) {
-
- $vstr = '';
- break;
- }
-
- case 'blob':
- case 'string':
- case 'datetime':
- case 'time':
-
- throw new ServerException("Unhandled DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
- break;
- default:
-
- throw new ServerException("Unknown DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
- break;
- }
- } else {
- $vstr = strval($v);
- }
- return $vstr;
- }
- }
|