3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
22 class Memcached_DataObject extends Safe_DataObject
25 * Wrapper for DB_DataObject's static lookup using memcached
26 * as backing instead of an in-process cache array.
28 * @param string $cls classname of object type to load
29 * @param mixed $k key field name, or value for primary key
30 * @param mixed $v key field value, or leave out for primary key lookup
31 * @return mixed Memcached_DataObject subtype or false
33 function &staticGet($cls, $k, $v=null)
43 $i = Memcached_DataObject::getcached($cls, $k, $v);
44 if ($i === false) { // false == cache miss
45 $i = DB_DataObject::factory($cls);
50 $result = $i->get($k, $v);
55 // save the fact that no such row exists
56 $c = self::memcache();
58 $ck = self::cachekey($cls, $k, $v);
68 * Get multiple items from the database by key
70 * @param string $cls Class to fetch
71 * @param string $keyCol name of column for key
72 * @param array $keyVals key values to fetch
73 * @param boolean $skipNulls return only non-null results?
75 * @return array Array of objects, in order
77 function multiGet($cls, $keyCol, $keyVals, $skipNulls=true)
79 $result = self::pivotGet($cls, $keyCol, $keyVals);
81 $values = array_values($result);
85 foreach ($values as $value) {
93 return new ArrayWrapper($values);
97 * Get multiple items from the database by key
99 * @param string $cls Class to fetch
100 * @param string $keyCol name of column for key
101 * @param array $keyVals key values to fetch
102 * @param boolean $otherCols Other columns to hold fixed
104 * @return array Array mapping $keyVals to objects, or null if not found
106 static function pivotGet($cls, $keyCol, $keyVals, $otherCols = array())
108 $result = array_fill_keys($keyVals, null);
112 foreach ($keyVals as $keyVal) {
114 $kv = array_merge($otherCols, array($keyCol => $keyVal));
116 $i = self::multicache($cls, $kv);
119 $result[$keyVal] = $i;
120 } else if (!empty($keyVal)) {
121 $toFetch[] = $keyVal;
125 if (count($toFetch) > 0) {
126 $i = DB_DataObject::factory($cls);
128 throw new Exception(_('Cannot instantiate class ' . $cls));
130 foreach ($otherCols as $otherKeyCol => $otherKeyVal) {
131 $i->$otherKeyCol = $otherKeyVal;
133 $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
135 while ($i->fetch()) {
138 $result[$i->$keyCol] = $copy;
142 // Save state of DB misses
144 foreach ($toFetch as $keyVal) {
145 if (empty($result[$keyVal])) {
146 $kv = array_merge($otherCols, array($keyCol => $keyVal));
147 // save the fact that no such row exists
148 $c = self::memcache();
150 $ck = self::multicacheKey($cls, $kv);
160 function listGet($cls, $keyCol, $keyVals)
162 $result = array_fill_keys($keyVals, array());
166 foreach ($keyVals as $keyVal) {
167 $l = self::cacheGet(sprintf("%s:list:%s:%s", $cls, $keyCol, $keyVal));
169 $result[$keyVal] = $l;
171 $toFetch[] = $keyVal;
175 if (count($toFetch) > 0) {
176 $i = DB_DataObject::factory($cls);
178 throw new Exception(_('Cannot instantiate class ' . $cls));
180 $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
182 while ($i->fetch()) {
185 $result[$i->$keyCol][] = $copy;
188 foreach ($toFetch as $keyVal)
190 self::cacheSet(sprintf("%s:list:%s:%s", $cls, $keyCol, $keyVal),
198 function columnType($columnName)
200 $keys = $this->table();
201 if (!array_key_exists($columnName, $keys)) {
202 throw new Exception('Unknown key column ' . $columnName . ' in ' . join(',', array_keys($keys)));
205 $def = $keys[$columnName];
207 if ($def & DB_DATAOBJECT_INT) {
215 * @fixme Should this return false on lookup fail to match staticGet?
217 function pkeyGet($cls, $kv)
219 $i = Memcached_DataObject::multicache($cls, $kv);
220 if ($i !== false) { // false == cache miss
223 $i = DB_DataObject::factory($cls);
224 if (empty($i) || PEAR::isError($i)) {
227 foreach ($kv as $k => $v) {
229 // XXX: possible SQL injection...? Don't
230 // pass keys from the browser, eh.
231 $i->whereAdd("$k is null");
236 if ($i->find(true)) {
240 $c = self::memcache();
242 $ck = self::multicacheKey($cls, $kv);
252 $result = parent::insert();
254 $this->fixupTimestamps();
255 $this->encache(); // in case of cached negative lookups
260 function update($orig=null)
262 if (is_object($orig) && $orig instanceof Memcached_DataObject) {
263 $orig->decache(); # might be different keys
265 $result = parent::update($orig);
267 $this->fixupTimestamps();
275 $this->decache(); # while we still have the values!
276 return parent::delete();
279 static function memcache() {
280 return Cache::instance();
283 static function cacheKey($cls, $k, $v) {
284 if (is_object($cls) || is_object($k) || (is_object($v) && !($v instanceof DB_DataObject_Cast))) {
285 $e = new Exception();
286 common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
287 str_replace("\n", " ", $e->getTraceAsString()));
289 $vstr = self::valueString($v);
290 return Cache::key(strtolower($cls).':'.$k.':'.$vstr);
293 static function getcached($cls, $k, $v) {
294 $c = Memcached_DataObject::memcache();
298 $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
299 if (0 == strcasecmp($cls, 'User')) {
300 // Special case for User
301 if (is_object($obj) && is_object($obj->id)) {
302 common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
303 $c->delete(Memcached_DataObject::cacheKey($cls, $k, $v));
313 // ini-based classes return number-indexed arrays. handbuilt
314 // classes return column => keytype. Make this uniform.
316 $keys = $this->keys();
318 $keyskeys = array_keys($keys);
320 if (is_string($keyskeys[0])) {
324 global $_DB_DATAOBJECT;
325 if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
326 $this->databaseStructure();
329 return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
334 $c = $this->memcache();
338 } else if ($this->tableName() == 'user' && is_object($this->id)) {
339 // Special case for User bug
340 $e = new Exception();
341 common_log(LOG_ERR, __METHOD__ . ' caching user with User object as ID ' .
342 str_replace("\n", " ", $e->getTraceAsString()));
345 $keys = $this->_allCacheKeys();
347 foreach ($keys as $key) {
348 $c->set($key, $this);
355 $c = $this->memcache();
361 $keys = $this->_allCacheKeys();
363 foreach ($keys as $key) {
364 $c->delete($key, $this);
368 function _allCacheKeys()
372 $types = $this->keyTypes();
378 foreach ($types as $key => $type) {
380 assert(!empty($key));
383 if (empty($this->$key)) {
386 $ckeys[] = $this->cacheKey($this->tableName(), $key, self::valueString($this->$key));
387 } else if ($type == 'K' || $type == 'N') {
389 $pval[] = self::valueString($this->$key);
391 // Low level exception. No need for i18n as discussed with Brion.
392 throw new Exception("Unknown key type $key => $type for " . $this->tableName());
396 assert(count($pkey) > 0);
398 // XXX: should work for both compound and scalar pkeys
399 $pvals = implode(',', $pval);
400 $pkeys = implode(',', $pkey);
402 $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);
407 function multicache($cls, $kv)
410 $c = self::memcache();
414 return $c->get(self::multicacheKey($cls, $kv));
418 static function multicacheKey($cls, $kv)
421 $pkeys = implode(',', array_keys($kv));
422 $pvals = implode(',', array_values($kv));
423 return self::cacheKey($cls, $pkeys, $pvals);
426 function getSearchEngine($table)
428 require_once INSTALLDIR.'/lib/search_engines.php';
430 if (Event::handle('GetSearchEngine', array($this, $table, &$search_engine))) {
431 if ('mysql' === common_config('db', 'type')) {
432 $type = common_config('search', 'type');
433 if ($type == 'like') {
434 $search_engine = new MySQLLikeSearch($this, $table);
435 } else if ($type == 'fulltext') {
436 $search_engine = new MySQLSearch($this, $table);
438 // Low level exception. No need for i18n as discussed with Brion.
439 throw new ServerException('Unknown search type: ' . $type);
442 $search_engine = new PGSearch($this, $table);
446 return $search_engine;
449 static function cachedQuery($cls, $qry, $expiry=3600)
451 $c = Memcached_DataObject::memcache();
457 $key_part = Cache::keyize($cls).':'.md5($qry);
458 $ckey = Cache::key($key_part);
459 $stored = $c->get($ckey);
461 if ($stored !== false) {
462 return new ArrayWrapper($stored);
468 while ($inst->fetch()) {
469 $cached[] = clone($inst);
472 $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
473 return new ArrayWrapper($cached);
477 * sends query to database - this is the private one that must work
478 * - internal functions use this rather than $this->query()
480 * Overridden to do logging.
482 * @param string $string
484 * @return mixed none or PEAR_Error
486 function _query($string)
488 if (common_config('db', 'annotate_queries')) {
489 $string = $this->annotateQuery($string);
492 $start = microtime(true);
495 if (Event::handle('StartDBQuery', array($this, $string, &$result))) {
496 common_perf_counter('query', $string);
498 $result = parent::_query($string);
499 } catch (Exception $e) {
502 Event::handle('EndDBQuery', array($this, $string, &$result));
504 $delta = microtime(true) - $start;
506 $limit = common_config('db', 'log_slow_queries');
507 if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
508 $clean = $this->sanitizeQuery($string);
510 $msg = sprintf("FAILED DB query (%0.3fs): %s - %s", $delta, $fail->getMessage(), $clean);
512 $msg = sprintf("DB query (%0.3fs): %s", $delta, $clean);
514 common_log(LOG_DEBUG, $msg);
524 * Find the first caller in the stack trace that's not a
525 * low-level database function and add a comment to the
526 * query string. This should then be visible in process lists
527 * and slow query logs, to help identify problem areas.
529 * Also marks whether this was a web GET/POST or which daemon
532 * @param string $string SQL query string
533 * @return string SQL query string, with a comment in it
535 function annotateQuery($string)
537 $ignore = array('annotateQuery',
545 $ignoreStatic = array('staticGet',
548 $here = get_class($this); // if we get confused
549 $bt = debug_backtrace();
551 // Find the first caller that's not us?
552 foreach ($bt as $frame) {
553 $func = $frame['function'];
554 if (isset($frame['type']) && $frame['type'] == '::') {
555 if (in_array($func, $ignoreStatic)) {
558 $here = $frame['class'] . '::' . $func;
560 } else if (isset($frame['type']) && $frame['type'] == '->') {
561 if ($frame['object'] === $this && in_array($func, $ignore)) {
564 if (in_array($func, $ignoreStatic)) {
565 continue; // @fixme this shouldn't be needed?
567 $here = get_class($frame['object']) . '->' . $func;
574 if (php_sapi_name() == 'cli') {
575 $context = basename($_SERVER['PHP_SELF']);
577 $context = $_SERVER['REQUEST_METHOD'];
580 // Slip the comment in after the first command,
581 // or DB_DataObject gets confused about handling inserts and such.
582 $parts = explode(' ', $string, 2);
583 $parts[0] .= " /* $context $here */";
584 return implode(' ', $parts);
587 // Sanitize a query for logging
588 // @fixme don't trim spaces in string literals
589 function sanitizeQuery($string)
591 $string = preg_replace('/\s+/', ' ', $string);
592 $string = trim($string);
596 // We overload so that 'SET NAMES "utf8"' is called for
601 global $_DB_DATAOBJECT;
603 $sum = $this->_getDbDsnMD5();
605 if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
606 !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
612 // @fixme horrible evil hack!
614 // In multisite configuration we don't want to keep around a separate
615 // connection for every database; we could end up with thousands of
616 // connections open per thread. In an ideal world we might keep
617 // a connection per server and select different databases, but that'd
618 // be reliant on having the same db username/pass as well.
620 // MySQL connections are cheap enough we're going to try just
621 // closing out the old connection and reopening when we encounter
624 // WARNING WARNING if we end up actually using multiple DBs at a time
625 // we'll need some fancier logic here.
626 if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
627 foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
631 unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
635 $result = parent::_connect();
637 if ($result && !$exists) {
638 $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
639 if (common_config('db', 'type') == 'mysql' &&
640 common_config('db', 'utf8')) {
641 $conn = $DB->connection;
643 if ($DB instanceof DB_mysqli) {
644 mysqli_set_charset($conn, 'utf8');
645 } else if ($DB instanceof DB_mysql) {
646 mysql_set_charset('utf8', $conn);
650 // Needed to make timestamp values usefully comparable.
651 if (common_config('db', 'type') == 'mysql') {
652 parent::_query("set time_zone='+0:00'");
659 // XXX: largely cadged from DB_DataObject
661 function _getDbDsnMD5()
663 if ($this->_database_dsn_md5) {
664 return $this->_database_dsn_md5;
667 $dsn = $this->_getDbDsn();
669 if (is_string($dsn)) {
672 /// support array based dsn's
673 $sum = md5(serialize($dsn));
681 global $_DB_DATAOBJECT;
683 if (empty($_DB_DATAOBJECT['CONFIG'])) {
684 DB_DataObject::_loadConfig();
687 $options = &$_DB_DATAOBJECT['CONFIG'];
689 // if the databse dsn dis defined in the object..
691 $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
695 if (!$this->_database) {
696 $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
699 if ($this->_database && !empty($options["database_{$this->_database}"])) {
700 $dsn = $options["database_{$this->_database}"];
701 } else if (!empty($options['database'])) {
702 $dsn = $options['database'];
707 // TRANS: Exception thrown when database name or Data Source Name could not be found.
708 throw new Exception(_("No database name or DSN found anywhere."));
714 static function blow()
716 $c = self::memcache();
722 $args = func_get_args();
724 $format = array_shift($args);
726 $keyPart = vsprintf($format, $args);
728 $cacheKey = Cache::key($keyPart);
730 return $c->delete($cacheKey);
733 function fixupTimestamps()
735 // Fake up timestamp columns
736 $columns = $this->table();
737 foreach ($columns as $name => $type) {
738 if ($type & DB_DATAOBJECT_MYSQLTIMESTAMP) {
739 $this->$name = common_sql_now();
746 common_debug("debugDump: " . common_log_objstring($this));
749 function raiseError($message, $type = null, $behaviour = null)
751 $id = get_class($this);
752 if (!empty($this->id)) {
753 $id .= ':' . $this->id;
755 if ($message instanceof PEAR_Error) {
756 $message = $message->getMessage();
758 // Low level exception. No need for i18n as discussed with Brion.
759 throw new ServerException("[$id] DB_DataObject error [$type]: $message");
762 static function cacheGet($keyPart)
764 $c = self::memcache();
770 $cacheKey = Cache::key($keyPart);
772 return $c->get($cacheKey);
775 static function cacheSet($keyPart, $value, $flag=null, $expiry=null)
777 $c = self::memcache();
783 $cacheKey = Cache::key($keyPart);
785 return $c->set($cacheKey, $value, $flag, $expiry);
788 static function valueString($v)
791 if (is_object($v) && $v instanceof DB_DataObject_Cast) {
794 $vstr = $v->year . '-' . $v->month . '-' . $v->day;
801 // Low level exception. No need for i18n as discussed with Brion.
802 throw new ServerException("Unhandled DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
805 // Low level exception. No need for i18n as discussed with Brion.
806 throw new ServerException("Unknown DB_DataObject_Cast type passed as cacheKey value: '$v->type'");