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 static function getClassKV($cls, $k, $v=null)
35 if (!is_a($cls, __CLASS__, true)) {
36 throw new Exception('Trying to fetch ' . __CLASS__ . ' into a non-related class');
40 $keys = self::pkeyCols($cls);
41 if (count($keys) > 1) {
42 // FIXME: maybe call pkeyGetClass() ourselves?
43 throw new Exception('Use pkeyGetClass() for compound primary keys');
47 $i = self::getcached($cls, $k, $v);
48 if ($i === false) { // false == cache miss
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 static function multiGetClass($cls, $keyCol, array $keyVals, $skipNulls=true)
79 $result = self::pivotGetClass($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 pivotGetClass($cls, $keyCol, array $keyVals, array $otherCols = array())
108 if (!is_a($cls, __CLASS__, true)) {
109 throw new Exception('Trying to fetch ' . __CLASS__ . ' into a non-related class');
111 if (is_array($keyCol)) {
112 foreach ($keyVals as $keyVal) {
113 $result[implode(',', $keyVal)] = null;
116 $result = array_fill_keys($keyVals, null);
121 foreach ($keyVals as $keyVal) {
123 if (is_array($keyCol)) {
124 $kv = array_combine($keyCol, $keyVal);
126 $kv = array($keyCol => $keyVal);
129 $kv = array_merge($otherCols, $kv);
131 $i = self::multicache($cls, $kv);
134 if (is_array($keyCol)) {
135 $result[implode(',', $keyVal)] = $i;
137 $result[$keyVal] = $i;
139 } else if (!empty($keyVal)) {
140 $toFetch[] = $keyVal;
144 if (count($toFetch) > 0) {
146 foreach ($otherCols as $otherKeyCol => $otherKeyVal) {
147 $i->$otherKeyCol = $otherKeyVal;
149 if (is_array($keyCol)) {
150 $i->whereAdd(self::_inMultiKey($i, $keyCol, $toFetch));
152 $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
155 while ($i->fetch()) {
158 if (is_array($keyCol)) {
160 foreach ($keyCol as $k) {
163 $result[implode(',', $vals)] = $copy;
165 $result[$i->$keyCol] = $copy;
170 // Save state of DB misses
172 foreach ($toFetch as $keyVal) {
174 if (is_array($keyCol)) {
175 $r = $result[implode(',', $keyVal)];
177 $r = $result[$keyVal];
180 if (is_array($keyCol)) {
181 $kv = array_combine($keyCol, $keyVal);
183 $kv = array($keyCol => $keyVal);
185 $kv = array_merge($otherCols, $kv);
186 // save the fact that no such row exists
187 $c = self::memcache();
189 $ck = self::multicacheKey($cls, $kv);
199 static function _inMultiKey($i, $cols, $values)
203 foreach ($cols as $col) {
204 $types[$col] = $i->columnType($col);
211 foreach ($values as $value) {
221 foreach ($cols as $col) {
227 switch ($types[$col]) {
230 $query .= sprintf("%s = %s", $col, $i->_quote($value[$i]));
233 $query .= sprintf("%s = %s", $col, $value[$i]);
247 static function pkeyCols($cls)
249 if (!is_a($cls, __CLASS__, true)) {
250 throw new Exception('Trying to fetch ' . __CLASS__ . ' into a non-related class');
253 $types = $i->keyTypes();
258 foreach ($types as $key => $type) {
259 if ($type == 'K' || $type == 'N') {
267 static function listFindClass($cls, $keyCol, array $keyVals)
269 if (!is_a($cls, __CLASS__, true)) {
270 throw new Exception('Trying to fetch ' . __CLASS__ . ' into a non-related class');
274 $i->whereAddIn($keyCol, $keyVals, $i->columnType($keyCol));
276 throw new NoResultException($i);
282 static function listGetClass($cls, $keyCol, array $keyVals)
284 if (!is_a($cls, __CLASS__, true)) {
285 throw new Exception('Trying to fetch ' . __CLASS__ . ' into a non-related class');
287 $pkeyMap = array_fill_keys($keyVals, array());
288 $result = array_fill_keys($keyVals, array());
290 $pkeyCols = self::pkeyCols($cls);
295 // We only cache keys -- not objects!
297 foreach ($keyVals as $keyVal) {
298 $l = self::cacheGet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal));
300 $pkeyMap[$keyVal] = $l;
301 foreach ($l as $pkey) {
305 $toFetch[] = $keyVal;
309 if (count($allPkeys) > 0) {
310 $keyResults = self::pivotGetClass($cls, $pkeyCols, $allPkeys);
312 foreach ($pkeyMap as $keyVal => $pkeyList) {
313 foreach ($pkeyList as $pkeyVal) {
314 $i = $keyResults[implode(',',$pkeyVal)];
316 $result[$keyVal][] = $i;
322 if (count($toFetch) > 0) {
324 $i = self::listFindClass($cls, $keyCol, $toFetch);
326 while ($i->fetch()) {
329 $result[$i->$keyCol][] = $copy;
331 foreach ($pkeyCols as $pkeyCol) {
332 $pkeyVal[] = $i->$pkeyCol;
334 $pkeyMap[$i->$keyCol][] = $pkeyVal;
336 } catch (NoResultException $e) {
337 // no results found for our keyVals, so we leave them as empty arrays
339 foreach ($toFetch as $keyVal) {
340 self::cacheSet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal),
348 function columnType($columnName)
350 $keys = $this->table();
351 if (!array_key_exists($columnName, $keys)) {
352 throw new Exception('Unknown key column ' . $columnName . ' in ' . join(',', array_keys($keys)));
355 $def = $keys[$columnName];
357 if ($def & DB_DATAOBJECT_INT) {
365 * @todo FIXME: Should this return false on lookup fail to match getKV?
367 static function pkeyGetClass($cls, array $kv)
369 if (!is_a($cls, __CLASS__, true)) {
370 throw new Exception('Trying to fetch ' . __CLASS__ . ' into a non-related class');
372 $i = Memcached_DataObject::multicache($cls, $kv);
373 if ($i !== false) { // false == cache miss
377 foreach ($kv as $k => $v) {
379 // XXX: possible SQL injection...? Don't
380 // pass keys from the browser, eh.
381 $i->whereAdd("$k is null");
386 if ($i->find(true)) {
390 $c = self::memcache();
392 $ck = self::multicacheKey($cls, $kv);
402 $result = parent::insert();
404 $this->fixupTimestamps();
405 $this->encache(); // in case of cached negative lookups
410 function update($orig=null)
412 if (is_object($orig) && $orig instanceof Memcached_DataObject) {
413 $orig->decache(); # might be different keys
415 $result = parent::update($orig);
417 $this->fixupTimestamps();
425 $this->decache(); # while we still have the values!
426 return parent::delete();
429 static function memcache() {
430 return Cache::instance();
433 static function cacheKey($cls, $k, $v) {
434 if (is_object($cls) || is_object($k) || (is_object($v) && !($v instanceof DB_DataObject_Cast))) {
435 $e = new Exception();
436 common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
437 str_replace("\n", " ", $e->getTraceAsString()));
439 $vstr = self::valueString($v);
440 return Cache::key(strtolower($cls).':'.$k.':'.$vstr);
443 static function getcached($cls, $k, $v) {
444 $c = Memcached_DataObject::memcache();
448 $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
449 if (0 == strcasecmp($cls, 'User')) {
450 // Special case for User
451 if (is_object($obj) && is_object($obj->id)) {
452 common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
453 $c->delete(Memcached_DataObject::cacheKey($cls, $k, $v));
463 // ini-based classes return number-indexed arrays. handbuilt
464 // classes return column => keytype. Make this uniform.
466 $keys = $this->keys();
468 $keyskeys = array_keys($keys);
470 if (is_string($keyskeys[0])) {
474 global $_DB_DATAOBJECT;
475 if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
476 $this->databaseStructure();
479 return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
484 $c = $this->memcache();
488 } else if ($this->tableName() == 'user' && is_object($this->id)) {
489 // Special case for User bug
490 $e = new Exception();
491 common_log(LOG_ERR, __METHOD__ . ' caching user with User object as ID ' .
492 str_replace("\n", " ", $e->getTraceAsString()));
495 $keys = $this->_allCacheKeys();
497 foreach ($keys as $key) {
498 $c->set($key, $this);
505 $c = $this->memcache();
511 $keys = $this->_allCacheKeys();
513 foreach ($keys as $key) {
514 $c->delete($key, $this);
518 function _allCacheKeys()
522 $types = $this->keyTypes();
528 foreach ($types as $key => $type) {
530 assert(!empty($key));
533 if (empty($this->$key)) {
536 $ckeys[] = $this->cacheKey($this->tableName(), $key, self::valueString($this->$key));
537 } else if ($type == 'K' || $type == 'N') {
539 $pval[] = self::valueString($this->$key);
541 // Low level exception. No need for i18n as discussed with Brion.
542 throw new Exception("Unknown key type $key => $type for " . $this->tableName());
546 assert(count($pkey) > 0);
548 // XXX: should work for both compound and scalar pkeys
549 $pvals = implode(',', $pval);
550 $pkeys = implode(',', $pkey);
552 $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);
557 static function multicache($cls, $kv)
560 $c = self::memcache();
564 return $c->get(self::multicacheKey($cls, $kv));
568 static function multicacheKey($cls, $kv)
571 $pkeys = implode(',', array_keys($kv));
572 $pvals = implode(',', array_values($kv));
573 return self::cacheKey($cls, $pkeys, $pvals);
576 function getSearchEngine($table)
578 require_once INSTALLDIR.'/lib/search_engines.php';
580 if (Event::handle('GetSearchEngine', array($this, $table, &$search_engine))) {
581 if ('mysql' === common_config('db', 'type')) {
582 $type = common_config('search', 'type');
583 if ($type == 'like') {
584 $search_engine = new MySQLLikeSearch($this, $table);
585 } else if ($type == 'fulltext') {
586 $search_engine = new MySQLSearch($this, $table);
588 // Low level exception. No need for i18n as discussed with Brion.
589 throw new ServerException('Unknown search type: ' . $type);
592 $search_engine = new PGSearch($this, $table);
596 return $search_engine;
599 static function cachedQuery($cls, $qry, $expiry=3600)
601 $c = Memcached_DataObject::memcache();
607 $key_part = Cache::keyize($cls).':'.md5($qry);
608 $ckey = Cache::key($key_part);
609 $stored = $c->get($ckey);
611 if ($stored !== false) {
612 return new ArrayWrapper($stored);
618 while ($inst->fetch()) {
619 $cached[] = clone($inst);
622 $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
623 return new ArrayWrapper($cached);
627 * sends query to database - this is the private one that must work
628 * - internal functions use this rather than $this->query()
630 * Overridden to do logging.
632 * @param string $string
634 * @return mixed none or PEAR_Error
636 function _query($string)
638 if (common_config('db', 'annotate_queries')) {
639 $string = $this->annotateQuery($string);
642 $start = microtime(true);
645 if (Event::handle('StartDBQuery', array($this, $string, &$result))) {
646 common_perf_counter('query', $string);
648 $result = parent::_query($string);
649 } catch (Exception $e) {
652 Event::handle('EndDBQuery', array($this, $string, &$result));
654 $delta = microtime(true) - $start;
656 $limit = common_config('db', 'log_slow_queries');
657 if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
658 $clean = $this->sanitizeQuery($string);
660 $msg = sprintf("FAILED DB query (%0.3fs): %s - %s", $delta, $fail->getMessage(), $clean);
662 $msg = sprintf("DB query (%0.3fs): %s", $delta, $clean);
664 common_log(LOG_DEBUG, $msg);
674 * Find the first caller in the stack trace that's not a
675 * low-level database function and add a comment to the
676 * query string. This should then be visible in process lists
677 * and slow query logs, to help identify problem areas.
679 * Also marks whether this was a web GET/POST or which daemon
682 * @param string $string SQL query string
683 * @return string SQL query string, with a comment in it
685 function annotateQuery($string)
687 $ignore = array('annotateQuery',
695 $ignoreStatic = array('getKV',
700 $here = get_class($this); // if we get confused
701 $bt = debug_backtrace();
703 // Find the first caller that's not us?
704 foreach ($bt as $frame) {
705 $func = $frame['function'];
706 if (isset($frame['type']) && $frame['type'] == '::') {
707 if (in_array($func, $ignoreStatic)) {
710 $here = $frame['class'] . '::' . $func;
712 } else if (isset($frame['type']) && $frame['type'] == '->') {
713 if ($frame['object'] === $this && in_array($func, $ignore)) {
716 if (in_array($func, $ignoreStatic)) {
717 continue; // @todo FIXME: This shouldn't be needed?
719 $here = get_class($frame['object']) . '->' . $func;
726 if (php_sapi_name() == 'cli') {
727 $context = basename($_SERVER['PHP_SELF']);
729 $context = $_SERVER['REQUEST_METHOD'];
732 // Slip the comment in after the first command,
733 // or DB_DataObject gets confused about handling inserts and such.
734 $parts = explode(' ', $string, 2);
735 $parts[0] .= " /* $context $here */";
736 return implode(' ', $parts);
739 // Sanitize a query for logging
740 // @fixme don't trim spaces in string literals
741 function sanitizeQuery($string)
743 $string = preg_replace('/\s+/', ' ', $string);
744 $string = trim($string);
748 // We overload so that 'SET NAMES "utf8"' is called for
753 global $_DB_DATAOBJECT, $_PEAR;
755 $sum = $this->_getDbDsnMD5();
757 if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
758 !$_PEAR->isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
764 // @fixme horrible evil hack!
766 // In multisite configuration we don't want to keep around a separate
767 // connection for every database; we could end up with thousands of
768 // connections open per thread. In an ideal world we might keep
769 // a connection per server and select different databases, but that'd
770 // be reliant on having the same db username/pass as well.
772 // MySQL connections are cheap enough we're going to try just
773 // closing out the old connection and reopening when we encounter
776 // WARNING WARNING if we end up actually using multiple DBs at a time
777 // we'll need some fancier logic here.
778 if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
779 foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
783 unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
787 $result = parent::_connect();
789 if ($result && !$exists) {
790 $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
791 if (common_config('db', 'type') == 'mysql' &&
792 common_config('db', 'utf8')) {
793 $conn = $DB->connection;
795 if ($DB instanceof DB_mysqli) {
796 mysqli_set_charset($conn, 'utf8');
797 } else if ($DB instanceof DB_mysql) {
798 mysql_set_charset('utf8', $conn);
802 // Needed to make timestamp values usefully comparable.
803 if (common_config('db', 'type') == 'mysql') {
804 parent::_query("set time_zone='+0:00'");
811 // XXX: largely cadged from DB_DataObject
813 function _getDbDsnMD5()
815 if ($this->_database_dsn_md5) {
816 return $this->_database_dsn_md5;
819 $dsn = $this->_getDbDsn();
821 if (is_string($dsn)) {
824 /// support array based dsn's
825 $sum = md5(serialize($dsn));
833 global $_DB_DATAOBJECT;
835 if (empty($_DB_DATAOBJECT['CONFIG'])) {
836 DB_DataObject::_loadConfig();
839 $options = &$_DB_DATAOBJECT['CONFIG'];
841 // if the databse dsn dis defined in the object..
843 $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
847 if (!$this->_database) {
848 $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
851 if ($this->_database && !empty($options["database_{$this->_database}"])) {
852 $dsn = $options["database_{$this->_database}"];
853 } else if (!empty($options['database'])) {
854 $dsn = $options['database'];
859 // TRANS: Exception thrown when database name or Data Source Name could not be found.
860 throw new Exception(_('No database name or DSN found anywhere.'));
866 static function blow()
868 $c = self::memcache();
874 $args = func_get_args();
876 $format = array_shift($args);
878 $keyPart = vsprintf($format, $args);
880 $cacheKey = Cache::key($keyPart);
882 return $c->delete($cacheKey);
885 function fixupTimestamps()
887 // Fake up timestamp columns
888 $columns = $this->table();
889 foreach ($columns as $name => $type) {
890 if ($type & DB_DATAOBJECT_MYSQLTIMESTAMP) {
891 $this->$name = common_sql_now();
898 common_debug("debugDump: " . common_log_objstring($this));
901 function raiseError($message, $type = null, $behaviour = null)
903 $id = get_class($this);
904 if (!empty($this->id)) {
905 $id .= ':' . $this->id;
907 if ($message instanceof PEAR_Error) {
908 $message = $message->getMessage();
910 // Low level exception. No need for i18n as discussed with Brion.
911 throw new ServerException("[$id] DB_DataObject error [$type]: $message");
914 static function cacheGet($keyPart)
916 $c = self::memcache();
922 $cacheKey = Cache::key($keyPart);
924 return $c->get($cacheKey);
927 static function cacheSet($keyPart, $value, $flag=null, $expiry=null)
929 $c = self::memcache();
935 $cacheKey = Cache::key($keyPart);
937 return $c->set($cacheKey, $value, $flag, $expiry);
940 static function valueString($v)
943 if (is_object($v) && $v instanceof DB_DataObject_Cast) {
946 $vstr = $v->year . '-' . $v->month . '-' . $v->day;
953 // Low level exception. No need for i18n as discussed with Brion.
954 throw new ServerException("Unhandled DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
957 // Low level exception. No need for i18n as discussed with Brion.
958 throw new ServerException("Unknown DB_DataObject_Cast type passed as cacheKey value: '$v->type'");