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 columnType($columnName)
162 $keys = $this->table();
163 if (!array_key_exists($columnName, $keys)) {
164 throw new Exception('Unknown key column ' . $columnName . ' in ' . join(',', array_keys($keys)));
167 $def = $keys[$columnName];
169 if ($def & DB_DATAOBJECT_INT) {
177 * @fixme Should this return false on lookup fail to match staticGet?
179 function pkeyGet($cls, $kv)
181 $i = Memcached_DataObject::multicache($cls, $kv);
182 if ($i !== false) { // false == cache miss
185 $i = DB_DataObject::factory($cls);
186 if (empty($i) || PEAR::isError($i)) {
189 foreach ($kv as $k => $v) {
191 // XXX: possible SQL injection...? Don't
192 // pass keys from the browser, eh.
193 $i->whereAdd("$k is null");
198 if ($i->find(true)) {
202 $c = self::memcache();
204 $ck = self::multicacheKey($cls, $kv);
214 $result = parent::insert();
216 $this->fixupTimestamps();
217 $this->encache(); // in case of cached negative lookups
222 function update($orig=null)
224 if (is_object($orig) && $orig instanceof Memcached_DataObject) {
225 $orig->decache(); # might be different keys
227 $result = parent::update($orig);
229 $this->fixupTimestamps();
237 $this->decache(); # while we still have the values!
238 return parent::delete();
241 static function memcache() {
242 return Cache::instance();
245 static function cacheKey($cls, $k, $v) {
246 if (is_object($cls) || is_object($k) || (is_object($v) && !($v instanceof DB_DataObject_Cast))) {
247 $e = new Exception();
248 common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
249 str_replace("\n", " ", $e->getTraceAsString()));
251 $vstr = self::valueString($v);
252 return Cache::key(strtolower($cls).':'.$k.':'.$vstr);
255 static function getcached($cls, $k, $v) {
256 $c = Memcached_DataObject::memcache();
260 $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
261 if (0 == strcasecmp($cls, 'User')) {
262 // Special case for User
263 if (is_object($obj) && is_object($obj->id)) {
264 common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
265 $c->delete(Memcached_DataObject::cacheKey($cls, $k, $v));
275 // ini-based classes return number-indexed arrays. handbuilt
276 // classes return column => keytype. Make this uniform.
278 $keys = $this->keys();
280 $keyskeys = array_keys($keys);
282 if (is_string($keyskeys[0])) {
286 global $_DB_DATAOBJECT;
287 if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
288 $this->databaseStructure();
291 return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
296 $c = $this->memcache();
300 } else if ($this->tableName() == 'user' && is_object($this->id)) {
301 // Special case for User bug
302 $e = new Exception();
303 common_log(LOG_ERR, __METHOD__ . ' caching user with User object as ID ' .
304 str_replace("\n", " ", $e->getTraceAsString()));
307 $keys = $this->_allCacheKeys();
309 foreach ($keys as $key) {
310 $c->set($key, $this);
317 $c = $this->memcache();
323 $keys = $this->_allCacheKeys();
325 foreach ($keys as $key) {
326 $c->delete($key, $this);
330 function _allCacheKeys()
334 $types = $this->keyTypes();
340 foreach ($types as $key => $type) {
342 assert(!empty($key));
345 if (empty($this->$key)) {
348 $ckeys[] = $this->cacheKey($this->tableName(), $key, self::valueString($this->$key));
349 } else if ($type == 'K' || $type == 'N') {
351 $pval[] = self::valueString($this->$key);
353 // Low level exception. No need for i18n as discussed with Brion.
354 throw new Exception("Unknown key type $key => $type for " . $this->tableName());
358 assert(count($pkey) > 0);
360 // XXX: should work for both compound and scalar pkeys
361 $pvals = implode(',', $pval);
362 $pkeys = implode(',', $pkey);
364 $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);
369 function multicache($cls, $kv)
372 $c = self::memcache();
376 return $c->get(self::multicacheKey($cls, $kv));
380 static function multicacheKey($cls, $kv)
383 $pkeys = implode(',', array_keys($kv));
384 $pvals = implode(',', array_values($kv));
385 return self::cacheKey($cls, $pkeys, $pvals);
388 function getSearchEngine($table)
390 require_once INSTALLDIR.'/lib/search_engines.php';
392 if (Event::handle('GetSearchEngine', array($this, $table, &$search_engine))) {
393 if ('mysql' === common_config('db', 'type')) {
394 $type = common_config('search', 'type');
395 if ($type == 'like') {
396 $search_engine = new MySQLLikeSearch($this, $table);
397 } else if ($type == 'fulltext') {
398 $search_engine = new MySQLSearch($this, $table);
400 // Low level exception. No need for i18n as discussed with Brion.
401 throw new ServerException('Unknown search type: ' . $type);
404 $search_engine = new PGSearch($this, $table);
408 return $search_engine;
411 static function cachedQuery($cls, $qry, $expiry=3600)
413 $c = Memcached_DataObject::memcache();
419 $key_part = Cache::keyize($cls).':'.md5($qry);
420 $ckey = Cache::key($key_part);
421 $stored = $c->get($ckey);
423 if ($stored !== false) {
424 return new ArrayWrapper($stored);
430 while ($inst->fetch()) {
431 $cached[] = clone($inst);
434 $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
435 return new ArrayWrapper($cached);
439 * sends query to database - this is the private one that must work
440 * - internal functions use this rather than $this->query()
442 * Overridden to do logging.
444 * @param string $string
446 * @return mixed none or PEAR_Error
448 function _query($string)
450 if (common_config('db', 'annotate_queries')) {
451 $string = $this->annotateQuery($string);
454 $start = microtime(true);
457 if (Event::handle('StartDBQuery', array($this, $string, &$result))) {
458 common_perf_counter('query', $string);
460 $result = parent::_query($string);
461 } catch (Exception $e) {
464 Event::handle('EndDBQuery', array($this, $string, &$result));
466 $delta = microtime(true) - $start;
468 $limit = common_config('db', 'log_slow_queries');
469 if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
470 $clean = $this->sanitizeQuery($string);
472 $msg = sprintf("FAILED DB query (%0.3fs): %s - %s", $delta, $fail->getMessage(), $clean);
474 $msg = sprintf("DB query (%0.3fs): %s", $delta, $clean);
476 common_log(LOG_DEBUG, $msg);
486 * Find the first caller in the stack trace that's not a
487 * low-level database function and add a comment to the
488 * query string. This should then be visible in process lists
489 * and slow query logs, to help identify problem areas.
491 * Also marks whether this was a web GET/POST or which daemon
494 * @param string $string SQL query string
495 * @return string SQL query string, with a comment in it
497 function annotateQuery($string)
499 $ignore = array('annotateQuery',
507 $ignoreStatic = array('staticGet',
510 $here = get_class($this); // if we get confused
511 $bt = debug_backtrace();
513 // Find the first caller that's not us?
514 foreach ($bt as $frame) {
515 $func = $frame['function'];
516 if (isset($frame['type']) && $frame['type'] == '::') {
517 if (in_array($func, $ignoreStatic)) {
520 $here = $frame['class'] . '::' . $func;
522 } else if (isset($frame['type']) && $frame['type'] == '->') {
523 if ($frame['object'] === $this && in_array($func, $ignore)) {
526 if (in_array($func, $ignoreStatic)) {
527 continue; // @fixme this shouldn't be needed?
529 $here = get_class($frame['object']) . '->' . $func;
536 if (php_sapi_name() == 'cli') {
537 $context = basename($_SERVER['PHP_SELF']);
539 $context = $_SERVER['REQUEST_METHOD'];
542 // Slip the comment in after the first command,
543 // or DB_DataObject gets confused about handling inserts and such.
544 $parts = explode(' ', $string, 2);
545 $parts[0] .= " /* $context $here */";
546 return implode(' ', $parts);
549 // Sanitize a query for logging
550 // @fixme don't trim spaces in string literals
551 function sanitizeQuery($string)
553 $string = preg_replace('/\s+/', ' ', $string);
554 $string = trim($string);
558 // We overload so that 'SET NAMES "utf8"' is called for
563 global $_DB_DATAOBJECT;
565 $sum = $this->_getDbDsnMD5();
567 if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
568 !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
574 // @fixme horrible evil hack!
576 // In multisite configuration we don't want to keep around a separate
577 // connection for every database; we could end up with thousands of
578 // connections open per thread. In an ideal world we might keep
579 // a connection per server and select different databases, but that'd
580 // be reliant on having the same db username/pass as well.
582 // MySQL connections are cheap enough we're going to try just
583 // closing out the old connection and reopening when we encounter
586 // WARNING WARNING if we end up actually using multiple DBs at a time
587 // we'll need some fancier logic here.
588 if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
589 foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
593 unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
597 $result = parent::_connect();
599 if ($result && !$exists) {
600 $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
601 if (common_config('db', 'type') == 'mysql' &&
602 common_config('db', 'utf8')) {
603 $conn = $DB->connection;
605 if ($DB instanceof DB_mysqli) {
606 mysqli_set_charset($conn, 'utf8');
607 } else if ($DB instanceof DB_mysql) {
608 mysql_set_charset('utf8', $conn);
612 // Needed to make timestamp values usefully comparable.
613 if (common_config('db', 'type') == 'mysql') {
614 parent::_query("set time_zone='+0:00'");
621 // XXX: largely cadged from DB_DataObject
623 function _getDbDsnMD5()
625 if ($this->_database_dsn_md5) {
626 return $this->_database_dsn_md5;
629 $dsn = $this->_getDbDsn();
631 if (is_string($dsn)) {
634 /// support array based dsn's
635 $sum = md5(serialize($dsn));
643 global $_DB_DATAOBJECT;
645 if (empty($_DB_DATAOBJECT['CONFIG'])) {
646 DB_DataObject::_loadConfig();
649 $options = &$_DB_DATAOBJECT['CONFIG'];
651 // if the databse dsn dis defined in the object..
653 $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
657 if (!$this->_database) {
658 $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
661 if ($this->_database && !empty($options["database_{$this->_database}"])) {
662 $dsn = $options["database_{$this->_database}"];
663 } else if (!empty($options['database'])) {
664 $dsn = $options['database'];
669 // TRANS: Exception thrown when database name or Data Source Name could not be found.
670 throw new Exception(_("No database name or DSN found anywhere."));
676 static function blow()
678 $c = self::memcache();
684 $args = func_get_args();
686 $format = array_shift($args);
688 $keyPart = vsprintf($format, $args);
690 $cacheKey = Cache::key($keyPart);
692 return $c->delete($cacheKey);
695 function fixupTimestamps()
697 // Fake up timestamp columns
698 $columns = $this->table();
699 foreach ($columns as $name => $type) {
700 if ($type & DB_DATAOBJECT_MYSQLTIMESTAMP) {
701 $this->$name = common_sql_now();
708 common_debug("debugDump: " . common_log_objstring($this));
711 function raiseError($message, $type = null, $behaviour = null)
713 $id = get_class($this);
714 if (!empty($this->id)) {
715 $id .= ':' . $this->id;
717 if ($message instanceof PEAR_Error) {
718 $message = $message->getMessage();
720 // Low level exception. No need for i18n as discussed with Brion.
721 throw new ServerException("[$id] DB_DataObject error [$type]: $message");
724 static function cacheGet($keyPart)
726 $c = self::memcache();
732 $cacheKey = Cache::key($keyPart);
734 return $c->get($cacheKey);
737 static function cacheSet($keyPart, $value, $flag=null, $expiry=null)
739 $c = self::memcache();
745 $cacheKey = Cache::key($keyPart);
747 return $c->set($cacheKey, $value, $flag, $expiry);
750 static function valueString($v)
753 if (is_object($v) && $v instanceof DB_DataObject_Cast) {
756 $vstr = $v->year . '-' . $v->month . '-' . $v->day;
763 // Low level exception. No need for i18n as discussed with Brion.
764 throw new ServerException("Unhandled DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
767 // Low level exception. No need for i18n as discussed with Brion.
768 throw new ServerException("Unknown DB_DataObject_Cast type passed as cacheKey value: '$v->type'");