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 // TRANS: Exception thrown when a class (%s) could not be instantiated.
129 throw new Exception(sprintf(_('Cannot instantiate class %s.'),$cls));
131 foreach ($otherCols as $otherKeyCol => $otherKeyVal) {
132 $i->$otherKeyCol = $otherKeyVal;
134 $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
136 while ($i->fetch()) {
139 $result[$i->$keyCol] = $copy;
143 // Save state of DB misses
145 foreach ($toFetch as $keyVal) {
146 if (empty($result[$keyVal])) {
147 $kv = array_merge($otherCols, array($keyCol => $keyVal));
148 // save the fact that no such row exists
149 $c = self::memcache();
151 $ck = self::multicacheKey($cls, $kv);
161 function listGet($cls, $keyCol, $keyVals)
163 $result = array_fill_keys($keyVals, array());
167 foreach ($keyVals as $keyVal) {
168 $l = self::cacheGet(sprintf("%s:list:%s:%s", $cls, $keyCol, $keyVal));
170 $result[$keyVal] = $l;
172 $toFetch[] = $keyVal;
176 if (count($toFetch) > 0) {
177 $i = DB_DataObject::factory($cls);
179 // TRANS: Exception thrown when a class (%s) could not be instantiated.
180 throw new Exception(sprintf(_('Cannot instantiate class %s.'),$cls));
182 $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
184 while ($i->fetch()) {
187 $result[$i->$keyCol][] = $copy;
190 foreach ($toFetch as $keyVal)
192 self::cacheSet(sprintf("%s:list:%s:%s", $cls, $keyCol, $keyVal),
200 function columnType($columnName)
202 $keys = $this->table();
203 if (!array_key_exists($columnName, $keys)) {
204 throw new Exception('Unknown key column ' . $columnName . ' in ' . join(',', array_keys($keys)));
207 $def = $keys[$columnName];
209 if ($def & DB_DATAOBJECT_INT) {
217 * @todo FIXME: Should this return false on lookup fail to match staticGet?
219 function pkeyGet($cls, $kv)
221 $i = Memcached_DataObject::multicache($cls, $kv);
222 if ($i !== false) { // false == cache miss
225 $i = DB_DataObject::factory($cls);
226 if (empty($i) || PEAR::isError($i)) {
229 foreach ($kv as $k => $v) {
231 // XXX: possible SQL injection...? Don't
232 // pass keys from the browser, eh.
233 $i->whereAdd("$k is null");
238 if ($i->find(true)) {
242 $c = self::memcache();
244 $ck = self::multicacheKey($cls, $kv);
254 $result = parent::insert();
256 $this->fixupTimestamps();
257 $this->encache(); // in case of cached negative lookups
262 function update($orig=null)
264 if (is_object($orig) && $orig instanceof Memcached_DataObject) {
265 $orig->decache(); # might be different keys
267 $result = parent::update($orig);
269 $this->fixupTimestamps();
277 $this->decache(); # while we still have the values!
278 return parent::delete();
281 static function memcache() {
282 return Cache::instance();
285 static function cacheKey($cls, $k, $v) {
286 if (is_object($cls) || is_object($k) || (is_object($v) && !($v instanceof DB_DataObject_Cast))) {
287 $e = new Exception();
288 common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
289 str_replace("\n", " ", $e->getTraceAsString()));
291 $vstr = self::valueString($v);
292 return Cache::key(strtolower($cls).':'.$k.':'.$vstr);
295 static function getcached($cls, $k, $v) {
296 $c = Memcached_DataObject::memcache();
300 $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
301 if (0 == strcasecmp($cls, 'User')) {
302 // Special case for User
303 if (is_object($obj) && is_object($obj->id)) {
304 common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
305 $c->delete(Memcached_DataObject::cacheKey($cls, $k, $v));
315 // ini-based classes return number-indexed arrays. handbuilt
316 // classes return column => keytype. Make this uniform.
318 $keys = $this->keys();
320 $keyskeys = array_keys($keys);
322 if (is_string($keyskeys[0])) {
326 global $_DB_DATAOBJECT;
327 if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
328 $this->databaseStructure();
331 return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
336 $c = $this->memcache();
340 } else if ($this->tableName() == 'user' && is_object($this->id)) {
341 // Special case for User bug
342 $e = new Exception();
343 common_log(LOG_ERR, __METHOD__ . ' caching user with User object as ID ' .
344 str_replace("\n", " ", $e->getTraceAsString()));
347 $keys = $this->_allCacheKeys();
349 foreach ($keys as $key) {
350 $c->set($key, $this);
357 $c = $this->memcache();
363 $keys = $this->_allCacheKeys();
365 foreach ($keys as $key) {
366 $c->delete($key, $this);
370 function _allCacheKeys()
374 $types = $this->keyTypes();
380 foreach ($types as $key => $type) {
382 assert(!empty($key));
385 if (empty($this->$key)) {
388 $ckeys[] = $this->cacheKey($this->tableName(), $key, self::valueString($this->$key));
389 } else if ($type == 'K' || $type == 'N') {
391 $pval[] = self::valueString($this->$key);
393 // Low level exception. No need for i18n as discussed with Brion.
394 throw new Exception("Unknown key type $key => $type for " . $this->tableName());
398 assert(count($pkey) > 0);
400 // XXX: should work for both compound and scalar pkeys
401 $pvals = implode(',', $pval);
402 $pkeys = implode(',', $pkey);
404 $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);
409 function multicache($cls, $kv)
412 $c = self::memcache();
416 return $c->get(self::multicacheKey($cls, $kv));
420 static function multicacheKey($cls, $kv)
423 $pkeys = implode(',', array_keys($kv));
424 $pvals = implode(',', array_values($kv));
425 return self::cacheKey($cls, $pkeys, $pvals);
428 function getSearchEngine($table)
430 require_once INSTALLDIR.'/lib/search_engines.php';
432 if (Event::handle('GetSearchEngine', array($this, $table, &$search_engine))) {
433 if ('mysql' === common_config('db', 'type')) {
434 $type = common_config('search', 'type');
435 if ($type == 'like') {
436 $search_engine = new MySQLLikeSearch($this, $table);
437 } else if ($type == 'fulltext') {
438 $search_engine = new MySQLSearch($this, $table);
440 // Low level exception. No need for i18n as discussed with Brion.
441 throw new ServerException('Unknown search type: ' . $type);
444 $search_engine = new PGSearch($this, $table);
448 return $search_engine;
451 static function cachedQuery($cls, $qry, $expiry=3600)
453 $c = Memcached_DataObject::memcache();
459 $key_part = Cache::keyize($cls).':'.md5($qry);
460 $ckey = Cache::key($key_part);
461 $stored = $c->get($ckey);
463 if ($stored !== false) {
464 return new ArrayWrapper($stored);
470 while ($inst->fetch()) {
471 $cached[] = clone($inst);
474 $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
475 return new ArrayWrapper($cached);
479 * sends query to database - this is the private one that must work
480 * - internal functions use this rather than $this->query()
482 * Overridden to do logging.
484 * @param string $string
486 * @return mixed none or PEAR_Error
488 function _query($string)
490 if (common_config('db', 'annotate_queries')) {
491 $string = $this->annotateQuery($string);
494 $start = microtime(true);
497 if (Event::handle('StartDBQuery', array($this, $string, &$result))) {
498 common_perf_counter('query', $string);
500 $result = parent::_query($string);
501 } catch (Exception $e) {
504 Event::handle('EndDBQuery', array($this, $string, &$result));
506 $delta = microtime(true) - $start;
508 $limit = common_config('db', 'log_slow_queries');
509 if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
510 $clean = $this->sanitizeQuery($string);
512 $msg = sprintf("FAILED DB query (%0.3fs): %s - %s", $delta, $fail->getMessage(), $clean);
514 $msg = sprintf("DB query (%0.3fs): %s", $delta, $clean);
516 common_log(LOG_DEBUG, $msg);
526 * Find the first caller in the stack trace that's not a
527 * low-level database function and add a comment to the
528 * query string. This should then be visible in process lists
529 * and slow query logs, to help identify problem areas.
531 * Also marks whether this was a web GET/POST or which daemon
534 * @param string $string SQL query string
535 * @return string SQL query string, with a comment in it
537 function annotateQuery($string)
539 $ignore = array('annotateQuery',
547 $ignoreStatic = array('staticGet',
550 $here = get_class($this); // if we get confused
551 $bt = debug_backtrace();
553 // Find the first caller that's not us?
554 foreach ($bt as $frame) {
555 $func = $frame['function'];
556 if (isset($frame['type']) && $frame['type'] == '::') {
557 if (in_array($func, $ignoreStatic)) {
560 $here = $frame['class'] . '::' . $func;
562 } else if (isset($frame['type']) && $frame['type'] == '->') {
563 if ($frame['object'] === $this && in_array($func, $ignore)) {
566 if (in_array($func, $ignoreStatic)) {
567 continue; // @todo FIXME: This shouldn't be needed?
569 $here = get_class($frame['object']) . '->' . $func;
576 if (php_sapi_name() == 'cli') {
577 $context = basename($_SERVER['PHP_SELF']);
579 $context = $_SERVER['REQUEST_METHOD'];
582 // Slip the comment in after the first command,
583 // or DB_DataObject gets confused about handling inserts and such.
584 $parts = explode(' ', $string, 2);
585 $parts[0] .= " /* $context $here */";
586 return implode(' ', $parts);
589 // Sanitize a query for logging
590 // @fixme don't trim spaces in string literals
591 function sanitizeQuery($string)
593 $string = preg_replace('/\s+/', ' ', $string);
594 $string = trim($string);
598 // We overload so that 'SET NAMES "utf8"' is called for
603 global $_DB_DATAOBJECT;
605 $sum = $this->_getDbDsnMD5();
607 if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
608 !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
614 // @fixme horrible evil hack!
616 // In multisite configuration we don't want to keep around a separate
617 // connection for every database; we could end up with thousands of
618 // connections open per thread. In an ideal world we might keep
619 // a connection per server and select different databases, but that'd
620 // be reliant on having the same db username/pass as well.
622 // MySQL connections are cheap enough we're going to try just
623 // closing out the old connection and reopening when we encounter
626 // WARNING WARNING if we end up actually using multiple DBs at a time
627 // we'll need some fancier logic here.
628 if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
629 foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
633 unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
637 $result = parent::_connect();
639 if ($result && !$exists) {
640 $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
641 if (common_config('db', 'type') == 'mysql' &&
642 common_config('db', 'utf8')) {
643 $conn = $DB->connection;
645 if ($DB instanceof DB_mysqli) {
646 mysqli_set_charset($conn, 'utf8');
647 } else if ($DB instanceof DB_mysql) {
648 mysql_set_charset('utf8', $conn);
652 // Needed to make timestamp values usefully comparable.
653 if (common_config('db', 'type') == 'mysql') {
654 parent::_query("set time_zone='+0:00'");
661 // XXX: largely cadged from DB_DataObject
663 function _getDbDsnMD5()
665 if ($this->_database_dsn_md5) {
666 return $this->_database_dsn_md5;
669 $dsn = $this->_getDbDsn();
671 if (is_string($dsn)) {
674 /// support array based dsn's
675 $sum = md5(serialize($dsn));
683 global $_DB_DATAOBJECT;
685 if (empty($_DB_DATAOBJECT['CONFIG'])) {
686 DB_DataObject::_loadConfig();
689 $options = &$_DB_DATAOBJECT['CONFIG'];
691 // if the databse dsn dis defined in the object..
693 $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
697 if (!$this->_database) {
698 $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
701 if ($this->_database && !empty($options["database_{$this->_database}"])) {
702 $dsn = $options["database_{$this->_database}"];
703 } else if (!empty($options['database'])) {
704 $dsn = $options['database'];
709 // TRANS: Exception thrown when database name or Data Source Name could not be found.
710 throw new Exception(_('No database name or DSN found anywhere.'));
716 static function blow()
718 $c = self::memcache();
724 $args = func_get_args();
726 $format = array_shift($args);
728 $keyPart = vsprintf($format, $args);
730 $cacheKey = Cache::key($keyPart);
732 return $c->delete($cacheKey);
735 function fixupTimestamps()
737 // Fake up timestamp columns
738 $columns = $this->table();
739 foreach ($columns as $name => $type) {
740 if ($type & DB_DATAOBJECT_MYSQLTIMESTAMP) {
741 $this->$name = common_sql_now();
748 common_debug("debugDump: " . common_log_objstring($this));
751 function raiseError($message, $type = null, $behaviour = null)
753 $id = get_class($this);
754 if (!empty($this->id)) {
755 $id .= ':' . $this->id;
757 if ($message instanceof PEAR_Error) {
758 $message = $message->getMessage();
760 // Low level exception. No need for i18n as discussed with Brion.
761 throw new ServerException("[$id] DB_DataObject error [$type]: $message");
764 static function cacheGet($keyPart)
766 $c = self::memcache();
772 $cacheKey = Cache::key($keyPart);
774 return $c->get($cacheKey);
777 static function cacheSet($keyPart, $value, $flag=null, $expiry=null)
779 $c = self::memcache();
785 $cacheKey = Cache::key($keyPart);
787 return $c->set($cacheKey, $value, $flag, $expiry);
790 static function valueString($v)
793 if (is_object($v) && $v instanceof DB_DataObject_Cast) {
796 $vstr = $v->year . '-' . $v->month . '-' . $v->day;
803 // Low level exception. No need for i18n as discussed with Brion.
804 throw new ServerException("Unhandled DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
807 // Low level exception. No need for i18n as discussed with Brion.
808 throw new ServerException("Unknown DB_DataObject_Cast type passed as cacheKey value: '$v->type'");