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 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
24 class Memcached_DataObject extends DB_DataObject
27 * Destructor to free global memory resources associated with
28 * this data object when it's unset or goes out of scope.
29 * DB_DataObject doesn't do this yet by itself.
35 if (method_exists('DB_DataObject', '__destruct')) {
41 * Magic function called at serialize() time.
43 * We use this to drop a couple process-specific references
44 * from DB_DataObject which can cause trouble in future
47 * @return array of variable names to include in serialization.
51 $vars = array_keys(get_object_vars($this));
52 $skip = array('_DB_resultid', '_link_loaded');
53 return array_diff($vars, $skip);
57 * Magic function called at unserialize() time.
59 * Clean out some process-specific variables which might
60 * be floating around from a previous process's cached
63 * Old cached objects may still have them.
67 // Refers to global state info from a previous process.
68 // Clear this out so we don't accidentally break global
69 // state in *this* process.
70 $this->_DB_resultid = null;
72 // We don't have any local DBO refs, so clear these out.
73 $this->_link_loaded = false;
77 * Wrapper for DB_DataObject's static lookup using memcached
78 * as backing instead of an in-process cache array.
80 * @param string $cls classname of object type to load
81 * @param mixed $k key field name, or value for primary key
82 * @param mixed $v key field value, or leave out for primary key lookup
83 * @return mixed Memcached_DataObject subtype or false
85 function &staticGet($cls, $k, $v=null)
95 $i = Memcached_DataObject::getcached($cls, $k, $v);
99 $i = DB_DataObject::factory($cls);
104 $result = $i->get($k, $v);
115 function &pkeyGet($cls, $kv)
117 $i = Memcached_DataObject::multicache($cls, $kv);
122 foreach ($kv as $k => $v) {
125 if ($i->find(true)) {
136 $result = parent::insert();
140 function update($orig=null)
142 if (is_object($orig) && $orig instanceof Memcached_DataObject) {
143 $orig->decache(); # might be different keys
145 $result = parent::update($orig);
154 $this->decache(); # while we still have the values!
155 return parent::delete();
158 static function memcache() {
159 return common_memcache();
162 static function cacheKey($cls, $k, $v) {
163 if (is_object($cls) || is_object($k) || is_object($v)) {
164 $e = new Exception();
165 common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
166 str_replace("\n", " ", $e->getTraceAsString()));
168 return common_cache_key(strtolower($cls).':'.$k.':'.$v);
171 static function getcached($cls, $k, $v) {
172 $c = Memcached_DataObject::memcache();
176 $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
177 if (0 == strcasecmp($cls, 'User')) {
178 // Special case for User
179 if (is_object($obj) && is_object($obj->id)) {
180 common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
181 $c->delete(Memcached_DataObject::cacheKey($cls, $k, $v));
191 global $_DB_DATAOBJECT;
192 if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
193 $this->databaseStructure();
196 return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
201 $c = $this->memcache();
204 } else if ($this->tableName() == 'user' && is_object($this->id)) {
205 // Special case for User bug
206 $e = new Exception();
207 common_log(LOG_ERR, __METHOD__ . ' caching user with User object as ID ' .
208 str_replace("\n", " ", $e->getTraceAsString()));
213 $types = $this->keyTypes();
215 foreach ($types as $key => $type) {
218 $pval[] = $this->$key;
220 $c->set($this->cacheKey($this->tableName(), $key, $this->$key), $this);
223 # XXX: should work for both compound and scalar pkeys
224 $pvals = implode(',', $pval);
225 $pkeys = implode(',', $pkey);
226 $c->set($this->cacheKey($this->tableName(), $pkeys, $pvals), $this);
232 $c = $this->memcache();
238 $types = $this->keyTypes();
240 foreach ($types as $key => $type) {
243 $pval[] = $this->$key;
245 $c->delete($this->cacheKey($this->tableName(), $key, $this->$key));
248 # should work for both compound and scalar pkeys
249 # XXX: comma works for now but may not be safe separator for future keys
250 $pvals = implode(',', $pval);
251 $pkeys = implode(',', $pkey);
252 $c->delete($this->cacheKey($this->tableName(), $pkeys, $pvals));
256 function multicache($cls, $kv)
259 $c = Memcached_DataObject::memcache();
263 $pkeys = implode(',', array_keys($kv));
264 $pvals = implode(',', array_values($kv));
265 return $c->get(Memcached_DataObject::cacheKey($cls, $pkeys, $pvals));
269 function getSearchEngine($table)
271 require_once INSTALLDIR.'/lib/search_engines.php';
272 static $search_engine;
273 if (!isset($search_engine)) {
274 if (Event::handle('GetSearchEngine', array($this, $table, &$search_engine))) {
275 if ('mysql' === common_config('db', 'type')) {
276 $type = common_config('search', 'type');
277 if ($type == 'like') {
278 $search_engine = new MySQLLikeSearch($this, $table);
279 } else if ($type == 'fulltext') {
280 $search_engine = new MySQLSearch($this, $table);
282 throw new ServerException('Unknown search type: ' . $type);
285 $search_engine = new PGSearch($this, $table);
289 return $search_engine;
292 static function cachedQuery($cls, $qry, $expiry=3600)
294 $c = Memcached_DataObject::memcache();
300 $key_part = common_keyize($cls).':'.md5($qry);
301 $ckey = common_cache_key($key_part);
302 $stored = $c->get($ckey);
304 return new ArrayWrapper($stored);
310 while ($inst->fetch()) {
311 $cached[] = clone($inst);
314 $c->set($ckey, $cached, MEMCACHE_COMPRESSED, $expiry);
315 return new ArrayWrapper($cached);
319 * sends query to database - this is the private one that must work
320 * - internal functions use this rather than $this->query()
322 * Overridden to do logging.
324 * @param string $string
326 * @return mixed none or PEAR_Error
328 function _query($string)
330 $start = microtime(true);
331 $result = parent::_query($string);
332 $delta = microtime(true) - $start;
334 $limit = common_config('db', 'log_slow_queries');
335 if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
336 $clean = $this->sanitizeQuery($string);
337 common_log(LOG_DEBUG, sprintf("DB query (%0.3fs): %s", $delta, $clean));
342 // Sanitize a query for logging
343 // @fixme don't trim spaces in string literals
344 function sanitizeQuery($string)
346 $string = preg_replace('/\s+/', ' ', $string);
347 $string = trim($string);
351 // We overload so that 'SET NAMES "utf8"' is called for
356 global $_DB_DATAOBJECT;
358 $sum = $this->_getDbDsnMD5();
360 if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
361 !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
367 // @fixme horrible evil hack!
369 // In multisite configuration we don't want to keep around a separate
370 // connection for every database; we could end up with thousands of
371 // connections open per thread. In an ideal world we might keep
372 // a connection per server and select different databases, but that'd
373 // be reliant on having the same db username/pass as well.
375 // MySQL connections are cheap enough we're going to try just
376 // closing out the old connection and reopening when we encounter
379 // WARNING WARNING if we end up actually using multiple DBs at a time
380 // we'll need some fancier logic here.
381 if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS'])) {
382 foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
386 unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
390 $result = parent::_connect();
392 if ($result && !$exists) {
393 $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
394 if (common_config('db', 'type') == 'mysql' &&
395 common_config('db', 'utf8')) {
396 $conn = $DB->connection;
398 if ($DB instanceof DB_mysqli) {
399 mysqli_set_charset($conn, 'utf8');
400 } else if ($DB instanceof DB_mysql) {
401 mysql_set_charset('utf8', $conn);
410 // XXX: largely cadged from DB_DataObject
412 function _getDbDsnMD5()
414 if ($this->_database_dsn_md5) {
415 return $this->_database_dsn_md5;
418 $dsn = $this->_getDbDsn();
420 if (is_string($dsn)) {
423 /// support array based dsn's
424 $sum = md5(serialize($dsn));
432 global $_DB_DATAOBJECT;
434 if (empty($_DB_DATAOBJECT['CONFIG'])) {
435 DB_DataObject::_loadConfig();
438 $options = &$_DB_DATAOBJECT['CONFIG'];
440 // if the databse dsn dis defined in the object..
442 $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
446 if (!$this->_database) {
447 $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
450 if ($this->_database && !empty($options["database_{$this->_database}"])) {
451 $dsn = $options["database_{$this->_database}"];
452 } else if (!empty($options['database'])) {
453 $dsn = $options['database'];
458 throw new Exception("No database name / dsn found anywhere");