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 DB_DataObject
25 * Destructor to free global memory resources associated with
26 * this data object when it's unset or goes out of scope.
27 * DB_DataObject doesn't do this yet by itself.
33 if (method_exists('DB_DataObject', '__destruct')) {
39 * Magic function called at serialize() time.
41 * We use this to drop a couple process-specific references
42 * from DB_DataObject which can cause trouble in future
45 * @return array of variable names to include in serialization.
49 $vars = array_keys(get_object_vars($this));
50 $skip = array('_DB_resultid', '_link_loaded');
51 return array_diff($vars, $skip);
55 * Magic function called at unserialize() time.
57 * Clean out some process-specific variables which might
58 * be floating around from a previous process's cached
61 * Old cached objects may still have them.
65 // Refers to global state info from a previous process.
66 // Clear this out so we don't accidentally break global
67 // state in *this* process.
68 $this->_DB_resultid = null;
69 // We don't have any local DBO refs, so clear these out.
70 $this->_link_loaded = false;
74 * Wrapper for DB_DataObject's static lookup using memcached
75 * as backing instead of an in-process cache array.
77 * @param string $cls classname of object type to load
78 * @param mixed $k key field name, or value for primary key
79 * @param mixed $v key field value, or leave out for primary key lookup
80 * @return mixed Memcached_DataObject subtype or false
82 function &staticGet($cls, $k, $v=null)
92 $i = Memcached_DataObject::getcached($cls, $k, $v);
93 if ($i === false) { // false == cache miss
94 $i = DB_DataObject::factory($cls);
99 $result = $i->get($k, $v);
104 // save the fact that no such row exists
105 $c = self::memcache();
107 $ck = self::cachekey($cls, $k, $v);
117 * @fixme Should this return false on lookup fail to match staticGet?
119 function pkeyGet($cls, $kv)
121 $i = Memcached_DataObject::multicache($cls, $kv);
122 if ($i !== false) { // false == cache miss
125 $i = DB_DataObject::factory($cls);
129 foreach ($kv as $k => $v) {
132 if ($i->find(true)) {
136 $c = self::memcache();
138 $ck = self::multicacheKey($cls, $kv);
148 $result = parent::insert();
150 $this->fixupTimestamps();
151 $this->encache(); // in case of cached negative lookups
156 function update($orig=null)
158 if (is_object($orig) && $orig instanceof Memcached_DataObject) {
159 $orig->decache(); # might be different keys
161 $result = parent::update($orig);
163 $this->fixupTimestamps();
171 $this->decache(); # while we still have the values!
172 return parent::delete();
175 static function memcache() {
176 return common_memcache();
179 static function cacheKey($cls, $k, $v) {
180 if (is_object($cls) || is_object($k) || is_object($v)) {
181 $e = new Exception();
182 common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
183 str_replace("\n", " ", $e->getTraceAsString()));
185 return common_cache_key(strtolower($cls).':'.$k.':'.$v);
188 static function getcached($cls, $k, $v) {
189 $c = Memcached_DataObject::memcache();
193 $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
194 if (0 == strcasecmp($cls, 'User')) {
195 // Special case for User
196 if (is_object($obj) && is_object($obj->id)) {
197 common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
198 $c->delete(Memcached_DataObject::cacheKey($cls, $k, $v));
208 // ini-based classes return number-indexed arrays. handbuilt
209 // classes return column => keytype. Make this uniform.
211 $keys = $this->keys();
213 $keyskeys = array_keys($keys);
215 if (is_string($keyskeys[0])) {
219 global $_DB_DATAOBJECT;
220 if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
221 $this->databaseStructure();
224 return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
229 $c = $this->memcache();
233 } else if ($this->tableName() == 'user' && is_object($this->id)) {
234 // Special case for User bug
235 $e = new Exception();
236 common_log(LOG_ERR, __METHOD__ . ' caching user with User object as ID ' .
237 str_replace("\n", " ", $e->getTraceAsString()));
240 $keys = $this->_allCacheKeys();
242 foreach ($keys as $key) {
243 $c->set($key, $this);
250 $c = $this->memcache();
256 $keys = $this->_allCacheKeys();
258 foreach ($keys as $key) {
259 $c->delete($key, $this);
263 function _allCacheKeys()
267 $types = $this->keyTypes();
273 foreach ($types as $key => $type) {
275 assert(!empty($key));
278 if (empty($this->$key)) {
281 $ckeys[] = $this->cacheKey($this->tableName(), $key, $this->$key);
282 } else if ($type == 'K' || $type == 'N') {
284 $pval[] = $this->$key;
286 throw new Exception("Unknown key type $key => $type for " . $this->tableName());
290 assert(count($pkey) > 0);
292 // XXX: should work for both compound and scalar pkeys
293 $pvals = implode(',', $pval);
294 $pkeys = implode(',', $pkey);
296 $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);
301 function multicache($cls, $kv)
304 $c = self::memcache();
308 return $c->get(self::multicacheKey($cls, $kv));
312 static function multicacheKey($cls, $kv)
315 $pkeys = implode(',', array_keys($kv));
316 $pvals = implode(',', array_values($kv));
317 return self::cacheKey($cls, $pkeys, $pvals);
320 function getSearchEngine($table)
322 require_once INSTALLDIR.'/lib/search_engines.php';
323 static $search_engine;
324 if (!isset($search_engine)) {
325 if (Event::handle('GetSearchEngine', array($this, $table, &$search_engine))) {
326 if ('mysql' === common_config('db', 'type')) {
327 $type = common_config('search', 'type');
328 if ($type == 'like') {
329 $search_engine = new MySQLLikeSearch($this, $table);
330 } else if ($type == 'fulltext') {
331 $search_engine = new MySQLSearch($this, $table);
333 throw new ServerException('Unknown search type: ' . $type);
336 $search_engine = new PGSearch($this, $table);
340 return $search_engine;
343 static function cachedQuery($cls, $qry, $expiry=3600)
345 $c = Memcached_DataObject::memcache();
351 $key_part = common_keyize($cls).':'.md5($qry);
352 $ckey = common_cache_key($key_part);
353 $stored = $c->get($ckey);
355 if ($stored !== false) {
356 return new ArrayWrapper($stored);
362 while ($inst->fetch()) {
363 $cached[] = clone($inst);
366 $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
367 return new ArrayWrapper($cached);
371 * sends query to database - this is the private one that must work
372 * - internal functions use this rather than $this->query()
374 * Overridden to do logging.
376 * @param string $string
378 * @return mixed none or PEAR_Error
380 function _query($string)
382 $start = microtime(true);
383 $result = parent::_query($string);
384 $delta = microtime(true) - $start;
386 $limit = common_config('db', 'log_slow_queries');
387 if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
388 $clean = $this->sanitizeQuery($string);
389 common_log(LOG_DEBUG, sprintf("DB query (%0.3fs): %s", $delta, $clean));
394 // Sanitize a query for logging
395 // @fixme don't trim spaces in string literals
396 function sanitizeQuery($string)
398 $string = preg_replace('/\s+/', ' ', $string);
399 $string = trim($string);
403 // We overload so that 'SET NAMES "utf8"' is called for
408 global $_DB_DATAOBJECT;
410 $sum = $this->_getDbDsnMD5();
412 if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
413 !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
419 // @fixme horrible evil hack!
421 // In multisite configuration we don't want to keep around a separate
422 // connection for every database; we could end up with thousands of
423 // connections open per thread. In an ideal world we might keep
424 // a connection per server and select different databases, but that'd
425 // be reliant on having the same db username/pass as well.
427 // MySQL connections are cheap enough we're going to try just
428 // closing out the old connection and reopening when we encounter
431 // WARNING WARNING if we end up actually using multiple DBs at a time
432 // we'll need some fancier logic here.
433 if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
434 foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
438 unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
442 $result = parent::_connect();
444 if ($result && !$exists) {
445 $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
446 if (common_config('db', 'type') == 'mysql' &&
447 common_config('db', 'utf8')) {
448 $conn = $DB->connection;
450 if ($DB instanceof DB_mysqli) {
451 mysqli_set_charset($conn, 'utf8');
452 } else if ($DB instanceof DB_mysql) {
453 mysql_set_charset('utf8', $conn);
462 // XXX: largely cadged from DB_DataObject
464 function _getDbDsnMD5()
466 if ($this->_database_dsn_md5) {
467 return $this->_database_dsn_md5;
470 $dsn = $this->_getDbDsn();
472 if (is_string($dsn)) {
475 /// support array based dsn's
476 $sum = md5(serialize($dsn));
484 global $_DB_DATAOBJECT;
486 if (empty($_DB_DATAOBJECT['CONFIG'])) {
487 DB_DataObject::_loadConfig();
490 $options = &$_DB_DATAOBJECT['CONFIG'];
492 // if the databse dsn dis defined in the object..
494 $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
498 if (!$this->_database) {
499 $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
502 if ($this->_database && !empty($options["database_{$this->_database}"])) {
503 $dsn = $options["database_{$this->_database}"];
504 } else if (!empty($options['database'])) {
505 $dsn = $options['database'];
510 throw new Exception("No database name / dsn found anywhere");
516 static function blow()
518 $c = self::memcache();
524 $args = func_get_args();
526 $format = array_shift($args);
528 $keyPart = vsprintf($format, $args);
530 $cacheKey = common_cache_key($keyPart);
532 return $c->delete($cacheKey);
535 function fixupTimestamps()
537 // Fake up timestamp columns
538 $columns = $this->table();
539 foreach ($columns as $name => $type) {
540 if ($type & DB_DATAOBJECT_MYSQLTIMESTAMP) {
541 $this->$name = common_sql_now();
548 common_debug("debugDump: " . common_log_objstring($this));
551 function raiseError($message, $type = null, $behaviour = null)
553 throw new ServerException("DB_DataObject error [$type]: $message");
556 static function cacheGet($keyPart)
558 $c = self::memcache();
564 $cacheKey = common_cache_key($keyPart);
566 return $c->get($cacheKey);
569 static function cacheSet($keyPart, $value)
571 $c = self::memcache();
577 $cacheKey = common_cache_key($keyPart);
579 return $c->set($cacheKey, $value);