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)
37 $keys = self::pkeyCols($cls);
38 if (count($keys) > 1) {
39 // FIXME: maybe call pkeyGet() ourselves?
40 throw new Exception('Use pkeyGet() for compound primary keys');
44 $i = Memcached_DataObject::getcached($cls, $k, $v);
45 if ($i === false) { // false == cache miss
46 $i = DB_DataObject::factory($cls);
51 $result = $i->get($k, $v);
56 // save the fact that no such row exists
57 $c = self::memcache();
59 $ck = self::cachekey($cls, $k, $v);
69 * Get multiple items from the database by key
71 * @param string $cls Class to fetch
72 * @param string $keyCol name of column for key
73 * @param array $keyVals key values to fetch
74 * @param boolean $skipNulls return only non-null results?
76 * @return array Array of objects, in order
78 function multiGet($cls, $keyCol, $keyVals, $skipNulls=true)
80 $result = self::pivotGet($cls, $keyCol, $keyVals);
82 $values = array_values($result);
86 foreach ($values as $value) {
94 return new ArrayWrapper($values);
98 * Get multiple items from the database by key
100 * @param string $cls Class to fetch
101 * @param string $keyCol name of column for key
102 * @param array $keyVals key values to fetch
103 * @param boolean $otherCols Other columns to hold fixed
105 * @return array Array mapping $keyVals to objects, or null if not found
107 static function pivotGet($cls, $keyCol, $keyVals, $otherCols = array())
109 if (is_array($keyCol)) {
110 foreach ($keyVals as $keyVal) {
111 $result[implode(',', $keyVal)] = null;
114 $result = array_fill_keys($keyVals, null);
119 foreach ($keyVals as $keyVal) {
121 if (is_array($keyCol)) {
122 $kv = array_combine($keyCol, $keyVal);
124 $kv = array($keyCol => $keyVal);
127 $kv = array_merge($otherCols, $kv);
129 $i = self::multicache($cls, $kv);
132 if (is_array($keyCol)) {
133 $result[implode(',', $keyVal)] = $i;
135 $result[$keyVal] = $i;
137 } else if (!empty($keyVal)) {
138 $toFetch[] = $keyVal;
142 if (count($toFetch) > 0) {
143 $i = DB_DataObject::factory($cls);
145 // TRANS: Exception thrown when a program code class (%s) cannot be instantiated.
146 throw new Exception(sprintf(_('Cannot instantiate class %s.'),$cls));
148 foreach ($otherCols as $otherKeyCol => $otherKeyVal) {
149 $i->$otherKeyCol = $otherKeyVal;
151 if (is_array($keyCol)) {
152 $i->whereAdd(self::_inMultiKey($i, $keyCol, $toFetch));
154 $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
157 while ($i->fetch()) {
160 if (is_array($keyCol)) {
162 foreach ($keyCol as $k) {
165 $result[implode(',', $vals)] = $copy;
167 $result[$i->$keyCol] = $copy;
172 // Save state of DB misses
174 foreach ($toFetch as $keyVal) {
176 if (is_array($keyCol)) {
177 $r = $result[implode(',', $keyVal)];
179 $r = $result[$keyVal];
182 if (is_array($keyCol)) {
183 $kv = array_combine($keyCol, $keyVal);
185 $kv = array($keyCol => $keyVal);
187 $kv = array_merge($otherCols, $kv);
188 // save the fact that no such row exists
189 $c = self::memcache();
191 $ck = self::multicacheKey($cls, $kv);
201 static function _inMultiKey($i, $cols, $values)
205 foreach ($cols as $col) {
206 $types[$col] = $i->columnType($col);
213 foreach ($values as $value) {
223 foreach ($cols as $col) {
229 switch ($types[$col]) {
232 $query .= sprintf("%s = %s", $col, $i->_quote($value[$i]));
235 $query .= sprintf("%s = %s", $col, $value[$i]);
249 static function pkeyCols($cls)
251 $i = DB_DataObject::factory($cls);
253 throw new Exception(_('Cannot instantiate a ' . $cls));
255 $types = $i->keyTypes();
260 foreach ($types as $key => $type) {
261 if ($type == 'K' || $type == 'N') {
269 function listGet($cls, $keyCol, $keyVals)
271 $pkeyMap = array_fill_keys($keyVals, array());
272 $result = array_fill_keys($keyVals, array());
274 $pkeyCols = self::pkeyCols($cls);
279 // We only cache keys -- not objects!
281 foreach ($keyVals as $keyVal) {
282 $l = self::cacheGet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal));
284 $pkeyMap[$keyVal] = $l;
285 foreach ($l as $pkey) {
289 $toFetch[] = $keyVal;
293 if (count($allPkeys) > 0) {
294 $keyResults = self::pivotGet($cls, $pkeyCols, $allPkeys);
296 foreach ($pkeyMap as $keyVal => $pkeyList) {
297 foreach ($pkeyList as $pkeyVal) {
298 $i = $keyResults[implode(',',$pkeyVal)];
300 $result[$keyVal][] = $i;
306 if (count($toFetch) > 0) {
307 $i = DB_DataObject::factory($cls);
309 throw new Exception(_('Cannot instantiate class ' . $cls));
311 $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
313 sprintf("listGet() got {$i->N} results for class $cls key $keyCol");
314 while ($i->fetch()) {
317 $result[$i->$keyCol][] = $copy;
319 foreach ($pkeyCols as $pkeyCol) {
320 $pkeyVal[] = $i->$pkeyCol;
322 $pkeyMap[$i->$keyCol][] = $pkeyVal;
325 foreach ($toFetch as $keyVal) {
326 self::cacheSet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal),
334 function columnType($columnName)
336 $keys = $this->table();
337 if (!array_key_exists($columnName, $keys)) {
338 throw new Exception('Unknown key column ' . $columnName . ' in ' . join(',', array_keys($keys)));
341 $def = $keys[$columnName];
343 if ($def & DB_DATAOBJECT_INT) {
351 * @todo FIXME: Should this return false on lookup fail to match staticGet?
353 function pkeyGet($cls, $kv)
355 $i = Memcached_DataObject::multicache($cls, $kv);
356 if ($i !== false) { // false == cache miss
359 $i = DB_DataObject::factory($cls);
360 if (empty($i) || PEAR::isError($i)) {
363 foreach ($kv as $k => $v) {
365 // XXX: possible SQL injection...? Don't
366 // pass keys from the browser, eh.
367 $i->whereAdd("$k is null");
372 if ($i->find(true)) {
376 $c = self::memcache();
378 $ck = self::multicacheKey($cls, $kv);
388 $result = parent::insert();
390 $this->fixupTimestamps();
391 $this->encache(); // in case of cached negative lookups
396 function update($orig=null)
398 if (is_object($orig) && $orig instanceof Memcached_DataObject) {
399 $orig->decache(); # might be different keys
401 $result = parent::update($orig);
403 $this->fixupTimestamps();
411 $this->decache(); # while we still have the values!
412 return parent::delete();
415 static function memcache() {
416 return Cache::instance();
419 static function cacheKey($cls, $k, $v) {
420 if (is_object($cls) || is_object($k) || (is_object($v) && !($v instanceof DB_DataObject_Cast))) {
421 $e = new Exception();
422 common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
423 str_replace("\n", " ", $e->getTraceAsString()));
425 $vstr = self::valueString($v);
426 return Cache::key(strtolower($cls).':'.$k.':'.$vstr);
429 static function getcached($cls, $k, $v) {
430 $c = Memcached_DataObject::memcache();
434 $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
435 if (0 == strcasecmp($cls, 'User')) {
436 // Special case for User
437 if (is_object($obj) && is_object($obj->id)) {
438 common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
439 $c->delete(Memcached_DataObject::cacheKey($cls, $k, $v));
449 // ini-based classes return number-indexed arrays. handbuilt
450 // classes return column => keytype. Make this uniform.
452 $keys = $this->keys();
454 $keyskeys = array_keys($keys);
456 if (is_string($keyskeys[0])) {
460 global $_DB_DATAOBJECT;
461 if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
462 $this->databaseStructure();
465 return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
470 $c = $this->memcache();
474 } else if ($this->tableName() == 'user' && is_object($this->id)) {
475 // Special case for User bug
476 $e = new Exception();
477 common_log(LOG_ERR, __METHOD__ . ' caching user with User object as ID ' .
478 str_replace("\n", " ", $e->getTraceAsString()));
481 $keys = $this->_allCacheKeys();
483 foreach ($keys as $key) {
484 $c->set($key, $this);
491 $c = $this->memcache();
497 $keys = $this->_allCacheKeys();
499 foreach ($keys as $key) {
500 $c->delete($key, $this);
504 function _allCacheKeys()
508 $types = $this->keyTypes();
514 foreach ($types as $key => $type) {
516 assert(!empty($key));
519 if (empty($this->$key)) {
522 $ckeys[] = $this->cacheKey($this->tableName(), $key, self::valueString($this->$key));
523 } else if ($type == 'K' || $type == 'N') {
525 $pval[] = self::valueString($this->$key);
527 // Low level exception. No need for i18n as discussed with Brion.
528 throw new Exception("Unknown key type $key => $type for " . $this->tableName());
532 assert(count($pkey) > 0);
534 // XXX: should work for both compound and scalar pkeys
535 $pvals = implode(',', $pval);
536 $pkeys = implode(',', $pkey);
538 $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);
543 function multicache($cls, $kv)
546 $c = self::memcache();
550 return $c->get(self::multicacheKey($cls, $kv));
554 static function multicacheKey($cls, $kv)
557 $pkeys = implode(',', array_keys($kv));
558 $pvals = implode(',', array_values($kv));
559 return self::cacheKey($cls, $pkeys, $pvals);
562 function getSearchEngine($table)
564 require_once INSTALLDIR.'/lib/search_engines.php';
566 if (Event::handle('GetSearchEngine', array($this, $table, &$search_engine))) {
567 if ('mysql' === common_config('db', 'type')) {
568 $type = common_config('search', 'type');
569 if ($type == 'like') {
570 $search_engine = new MySQLLikeSearch($this, $table);
571 } else if ($type == 'fulltext') {
572 $search_engine = new MySQLSearch($this, $table);
574 // Low level exception. No need for i18n as discussed with Brion.
575 throw new ServerException('Unknown search type: ' . $type);
578 $search_engine = new PGSearch($this, $table);
582 return $search_engine;
585 static function cachedQuery($cls, $qry, $expiry=3600)
587 $c = Memcached_DataObject::memcache();
593 $key_part = Cache::keyize($cls).':'.md5($qry);
594 $ckey = Cache::key($key_part);
595 $stored = $c->get($ckey);
597 if ($stored !== false) {
598 return new ArrayWrapper($stored);
604 while ($inst->fetch()) {
605 $cached[] = clone($inst);
608 $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
609 return new ArrayWrapper($cached);
613 * sends query to database - this is the private one that must work
614 * - internal functions use this rather than $this->query()
616 * Overridden to do logging.
618 * @param string $string
620 * @return mixed none or PEAR_Error
622 function _query($string)
624 if (common_config('db', 'annotate_queries')) {
625 $string = $this->annotateQuery($string);
628 $start = microtime(true);
631 if (Event::handle('StartDBQuery', array($this, $string, &$result))) {
632 common_perf_counter('query', $string);
634 $result = parent::_query($string);
635 } catch (Exception $e) {
638 Event::handle('EndDBQuery', array($this, $string, &$result));
640 $delta = microtime(true) - $start;
642 $limit = common_config('db', 'log_slow_queries');
643 if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
644 $clean = $this->sanitizeQuery($string);
646 $msg = sprintf("FAILED DB query (%0.3fs): %s - %s", $delta, $fail->getMessage(), $clean);
648 $msg = sprintf("DB query (%0.3fs): %s", $delta, $clean);
650 common_log(LOG_DEBUG, $msg);
660 * Find the first caller in the stack trace that's not a
661 * low-level database function and add a comment to the
662 * query string. This should then be visible in process lists
663 * and slow query logs, to help identify problem areas.
665 * Also marks whether this was a web GET/POST or which daemon
668 * @param string $string SQL query string
669 * @return string SQL query string, with a comment in it
671 function annotateQuery($string)
673 $ignore = array('annotateQuery',
681 $ignoreStatic = array('staticGet',
684 $here = get_class($this); // if we get confused
685 $bt = debug_backtrace();
687 // Find the first caller that's not us?
688 foreach ($bt as $frame) {
689 $func = $frame['function'];
690 if (isset($frame['type']) && $frame['type'] == '::') {
691 if (in_array($func, $ignoreStatic)) {
694 $here = $frame['class'] . '::' . $func;
696 } else if (isset($frame['type']) && $frame['type'] == '->') {
697 if ($frame['object'] === $this && in_array($func, $ignore)) {
700 if (in_array($func, $ignoreStatic)) {
701 continue; // @todo FIXME: This shouldn't be needed?
703 $here = get_class($frame['object']) . '->' . $func;
710 if (php_sapi_name() == 'cli') {
711 $context = basename($_SERVER['PHP_SELF']);
713 $context = $_SERVER['REQUEST_METHOD'];
716 // Slip the comment in after the first command,
717 // or DB_DataObject gets confused about handling inserts and such.
718 $parts = explode(' ', $string, 2);
719 $parts[0] .= " /* $context $here */";
720 return implode(' ', $parts);
723 // Sanitize a query for logging
724 // @fixme don't trim spaces in string literals
725 function sanitizeQuery($string)
727 $string = preg_replace('/\s+/', ' ', $string);
728 $string = trim($string);
732 // We overload so that 'SET NAMES "utf8"' is called for
737 global $_DB_DATAOBJECT;
739 $sum = $this->_getDbDsnMD5();
741 if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
742 !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
748 // @fixme horrible evil hack!
750 // In multisite configuration we don't want to keep around a separate
751 // connection for every database; we could end up with thousands of
752 // connections open per thread. In an ideal world we might keep
753 // a connection per server and select different databases, but that'd
754 // be reliant on having the same db username/pass as well.
756 // MySQL connections are cheap enough we're going to try just
757 // closing out the old connection and reopening when we encounter
760 // WARNING WARNING if we end up actually using multiple DBs at a time
761 // we'll need some fancier logic here.
762 if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
763 foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
767 unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
771 $result = parent::_connect();
773 if ($result && !$exists) {
774 $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
775 if (common_config('db', 'type') == 'mysql' &&
776 common_config('db', 'utf8')) {
777 $conn = $DB->connection;
779 if ($DB instanceof DB_mysqli) {
780 mysqli_set_charset($conn, 'utf8');
781 } else if ($DB instanceof DB_mysql) {
782 mysql_set_charset('utf8', $conn);
786 // Needed to make timestamp values usefully comparable.
787 if (common_config('db', 'type') == 'mysql') {
788 parent::_query("set time_zone='+0:00'");
795 // XXX: largely cadged from DB_DataObject
797 function _getDbDsnMD5()
799 if ($this->_database_dsn_md5) {
800 return $this->_database_dsn_md5;
803 $dsn = $this->_getDbDsn();
805 if (is_string($dsn)) {
808 /// support array based dsn's
809 $sum = md5(serialize($dsn));
817 global $_DB_DATAOBJECT;
819 if (empty($_DB_DATAOBJECT['CONFIG'])) {
820 DB_DataObject::_loadConfig();
823 $options = &$_DB_DATAOBJECT['CONFIG'];
825 // if the databse dsn dis defined in the object..
827 $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
831 if (!$this->_database) {
832 $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
835 if ($this->_database && !empty($options["database_{$this->_database}"])) {
836 $dsn = $options["database_{$this->_database}"];
837 } else if (!empty($options['database'])) {
838 $dsn = $options['database'];
843 // TRANS: Exception thrown when database name or Data Source Name could not be found.
844 throw new Exception(_('No database name or DSN found anywhere.'));
850 static function blow()
852 $c = self::memcache();
858 $args = func_get_args();
860 $format = array_shift($args);
862 $keyPart = vsprintf($format, $args);
864 $cacheKey = Cache::key($keyPart);
866 return $c->delete($cacheKey);
869 function fixupTimestamps()
871 // Fake up timestamp columns
872 $columns = $this->table();
873 foreach ($columns as $name => $type) {
874 if ($type & DB_DATAOBJECT_MYSQLTIMESTAMP) {
875 $this->$name = common_sql_now();
882 common_debug("debugDump: " . common_log_objstring($this));
885 function raiseError($message, $type = null, $behaviour = null)
887 $id = get_class($this);
888 if (!empty($this->id)) {
889 $id .= ':' . $this->id;
891 if ($message instanceof PEAR_Error) {
892 $message = $message->getMessage();
894 // Low level exception. No need for i18n as discussed with Brion.
895 throw new ServerException("[$id] DB_DataObject error [$type]: $message");
898 static function cacheGet($keyPart)
900 $c = self::memcache();
906 $cacheKey = Cache::key($keyPart);
908 return $c->get($cacheKey);
911 static function cacheSet($keyPart, $value, $flag=null, $expiry=null)
913 $c = self::memcache();
919 $cacheKey = Cache::key($keyPart);
921 return $c->set($cacheKey, $value, $flag, $expiry);
924 static function valueString($v)
927 if (is_object($v) && $v instanceof DB_DataObject_Cast) {
930 $vstr = $v->year . '-' . $v->month . '-' . $v->day;
937 // Low level exception. No need for i18n as discussed with Brion.
938 throw new ServerException("Unhandled DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
941 // Low level exception. No need for i18n as discussed with Brion.
942 throw new ServerException("Unknown DB_DataObject_Cast type passed as cacheKey value: '$v->type'");