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 * @fixme Should this return false on lookup fail to match staticGet?
70 function pkeyGet($cls, $kv)
72 $i = Memcached_DataObject::multicache($cls, $kv);
73 if ($i !== false) { // false == cache miss
76 $i = DB_DataObject::factory($cls);
80 foreach ($kv as $k => $v) {
87 $c = self::memcache();
89 $ck = self::multicacheKey($cls, $kv);
99 $result = parent::insert();
101 $this->fixupTimestamps();
102 $this->encache(); // in case of cached negative lookups
107 function update($orig=null)
109 if (is_object($orig) && $orig instanceof Memcached_DataObject) {
110 $orig->decache(); # might be different keys
112 $result = parent::update($orig);
114 $this->fixupTimestamps();
122 $this->decache(); # while we still have the values!
123 return parent::delete();
126 static function memcache() {
127 return common_memcache();
130 static function cacheKey($cls, $k, $v) {
131 if (is_object($cls) || is_object($k) || is_object($v)) {
132 $e = new Exception();
133 common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
134 str_replace("\n", " ", $e->getTraceAsString()));
136 return common_cache_key(strtolower($cls).':'.$k.':'.$v);
139 static function getcached($cls, $k, $v) {
140 $c = Memcached_DataObject::memcache();
144 $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
145 if (0 == strcasecmp($cls, 'User')) {
146 // Special case for User
147 if (is_object($obj) && is_object($obj->id)) {
148 common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
149 $c->delete(Memcached_DataObject::cacheKey($cls, $k, $v));
159 // ini-based classes return number-indexed arrays. handbuilt
160 // classes return column => keytype. Make this uniform.
162 $keys = $this->keys();
164 $keyskeys = array_keys($keys);
166 if (is_string($keyskeys[0])) {
170 global $_DB_DATAOBJECT;
171 if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
172 $this->databaseStructure();
175 return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
180 $c = $this->memcache();
184 } else if ($this->tableName() == 'user' && is_object($this->id)) {
185 // Special case for User bug
186 $e = new Exception();
187 common_log(LOG_ERR, __METHOD__ . ' caching user with User object as ID ' .
188 str_replace("\n", " ", $e->getTraceAsString()));
191 $keys = $this->_allCacheKeys();
193 foreach ($keys as $key) {
194 $c->set($key, $this);
201 $c = $this->memcache();
207 $keys = $this->_allCacheKeys();
209 foreach ($keys as $key) {
210 $c->delete($key, $this);
214 function _allCacheKeys()
218 $types = $this->keyTypes();
224 foreach ($types as $key => $type) {
226 assert(!empty($key));
229 if (empty($this->$key)) {
232 $ckeys[] = $this->cacheKey($this->tableName(), $key, $this->$key);
233 } else if ($type == 'K' || $type == 'N') {
235 $pval[] = $this->$key;
237 throw new Exception("Unknown key type $key => $type for " . $this->tableName());
241 assert(count($pkey) > 0);
243 // XXX: should work for both compound and scalar pkeys
244 $pvals = implode(',', $pval);
245 $pkeys = implode(',', $pkey);
247 $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);
252 function multicache($cls, $kv)
255 $c = self::memcache();
259 return $c->get(self::multicacheKey($cls, $kv));
263 static function multicacheKey($cls, $kv)
266 $pkeys = implode(',', array_keys($kv));
267 $pvals = implode(',', array_values($kv));
268 return self::cacheKey($cls, $pkeys, $pvals);
271 function getSearchEngine($table)
273 require_once INSTALLDIR.'/lib/search_engines.php';
274 static $search_engine;
275 if (!isset($search_engine)) {
276 if (Event::handle('GetSearchEngine', array($this, $table, &$search_engine))) {
277 if ('mysql' === common_config('db', 'type')) {
278 $type = common_config('search', 'type');
279 if ($type == 'like') {
280 $search_engine = new MySQLLikeSearch($this, $table);
281 } else if ($type == 'fulltext') {
282 $search_engine = new MySQLSearch($this, $table);
284 throw new ServerException('Unknown search type: ' . $type);
287 $search_engine = new PGSearch($this, $table);
291 return $search_engine;
294 static function cachedQuery($cls, $qry, $expiry=3600)
296 $c = Memcached_DataObject::memcache();
302 $key_part = common_keyize($cls).':'.md5($qry);
303 $ckey = common_cache_key($key_part);
304 $stored = $c->get($ckey);
306 if ($stored !== false) {
307 return new ArrayWrapper($stored);
313 while ($inst->fetch()) {
314 $cached[] = clone($inst);
317 $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
318 return new ArrayWrapper($cached);
322 * sends query to database - this is the private one that must work
323 * - internal functions use this rather than $this->query()
325 * Overridden to do logging.
327 * @param string $string
329 * @return mixed none or PEAR_Error
331 function _query($string)
333 $start = microtime(true);
334 $result = parent::_query($string);
335 $delta = microtime(true) - $start;
337 $limit = common_config('db', 'log_slow_queries');
338 if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
339 $clean = $this->sanitizeQuery($string);
340 common_log(LOG_DEBUG, sprintf("DB query (%0.3fs): %s", $delta, $clean));
345 // Sanitize a query for logging
346 // @fixme don't trim spaces in string literals
347 function sanitizeQuery($string)
349 $string = preg_replace('/\s+/', ' ', $string);
350 $string = trim($string);
354 // We overload so that 'SET NAMES "utf8"' is called for
359 global $_DB_DATAOBJECT;
361 $sum = $this->_getDbDsnMD5();
363 if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
364 !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
370 // @fixme horrible evil hack!
372 // In multisite configuration we don't want to keep around a separate
373 // connection for every database; we could end up with thousands of
374 // connections open per thread. In an ideal world we might keep
375 // a connection per server and select different databases, but that'd
376 // be reliant on having the same db username/pass as well.
378 // MySQL connections are cheap enough we're going to try just
379 // closing out the old connection and reopening when we encounter
382 // WARNING WARNING if we end up actually using multiple DBs at a time
383 // we'll need some fancier logic here.
384 if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
385 foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
389 unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
393 $result = parent::_connect();
395 if ($result && !$exists) {
396 $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
397 if (common_config('db', 'type') == 'mysql' &&
398 common_config('db', 'utf8')) {
399 $conn = $DB->connection;
401 if ($DB instanceof DB_mysqli) {
402 mysqli_set_charset($conn, 'utf8');
403 } else if ($DB instanceof DB_mysql) {
404 mysql_set_charset('utf8', $conn);
413 // XXX: largely cadged from DB_DataObject
415 function _getDbDsnMD5()
417 if ($this->_database_dsn_md5) {
418 return $this->_database_dsn_md5;
421 $dsn = $this->_getDbDsn();
423 if (is_string($dsn)) {
426 /// support array based dsn's
427 $sum = md5(serialize($dsn));
435 global $_DB_DATAOBJECT;
437 if (empty($_DB_DATAOBJECT['CONFIG'])) {
438 DB_DataObject::_loadConfig();
441 $options = &$_DB_DATAOBJECT['CONFIG'];
443 // if the databse dsn dis defined in the object..
445 $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
449 if (!$this->_database) {
450 $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
453 if ($this->_database && !empty($options["database_{$this->_database}"])) {
454 $dsn = $options["database_{$this->_database}"];
455 } else if (!empty($options['database'])) {
456 $dsn = $options['database'];
461 throw new Exception("No database name / dsn found anywhere");
467 static function blow()
469 $c = self::memcache();
475 $args = func_get_args();
477 $format = array_shift($args);
479 $keyPart = vsprintf($format, $args);
481 $cacheKey = common_cache_key($keyPart);
483 return $c->delete($cacheKey);
486 function fixupTimestamps()
488 // Fake up timestamp columns
489 $columns = $this->table();
490 foreach ($columns as $name => $type) {
491 if ($type & DB_DATAOBJECT_MYSQLTIMESTAMP) {
492 $this->$name = common_sql_now();
499 common_debug("debugDump: " . common_log_objstring($this));
502 function raiseError($message, $type = null, $behaviour = null)
504 $id = get_class($this);
506 $id .= ':' . $this->id;
508 if ($message instanceof PEAR_Error) {
509 $message = $message->getMessage();
511 throw new ServerException("[$id] DB_DataObject error [$type]: $message");
514 static function cacheGet($keyPart)
516 $c = self::memcache();
522 $cacheKey = common_cache_key($keyPart);
524 return $c->get($cacheKey);
527 static function cacheSet($keyPart, $value)
529 $c = self::memcache();
535 $cacheKey = common_cache_key($keyPart);
537 return $c->set($cacheKey, $value);