classes/Memcached_DataObject.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 class Memcached_DataObject extends Safe_DataObject
  23 {
  24     /**
  25      * Wrapper for DB_DataObject's static lookup using memcached
  26      * as backing instead of an in-process cache array.
  27      *
  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
  32      */
  33     function &staticGet($cls, $k, $v=null)
  34     {
  35         if (is_null($v)) {
  36             $v = $k;
  37             # XXX: HACK!
  38             $i = new $cls;
  39             $keys = $i->keys();
  40             $k = $keys[0];
  41             unset($i);
  42         }
  43         $i = Memcached_DataObject::getcached($cls, $k, $v);
  44         if ($i === false) { // false == cache miss
  45             $i = DB_DataObject::factory($cls);
  46             if (empty($i)) {
  47                 $i = false;
  48                 return $i;
  49             }
  50             $result = $i->get($k, $v);
  51             if ($result) {
  52                 // Hit!
  53                 $i->encache();
  54             } else {
  55                 // save the fact that no such row exists
  56                 $c = self::memcache();
  57                 if (!empty($c)) {
  58                     $ck = self::cachekey($cls, $k, $v);
  59                     $c->set($ck, null);
  60                 }
  61                 $i = false;
  62             }
  63         }
  64         return $i;
  65     }
  66
  67     /**
  68      * @fixme Should this return false on lookup fail to match staticGet?
  69      */
  70     function pkeyGet($cls, $kv)
  71     {
  72         $i = Memcached_DataObject::multicache($cls, $kv);
  73         if ($i !== false) { // false == cache miss
  74             return $i;
  75         } else {
  76             $i = DB_DataObject::factory($cls);
  77             if (empty($i)) {
  78                 return false;
  79             }
  80             foreach ($kv as $k => $v) {
  81                 $i->$k = $v;
  82             }
  83             if ($i->find(true)) {
  84                 $i->encache();
  85             } else {
  86                 $i = null;
  87                 $c = self::memcache();
  88                 if (!empty($c)) {
  89                     $ck = self::multicacheKey($cls, $kv);
  90                     $c->set($ck, null);
  91                 }
  92             }
  93             return $i;
  94         }
  95     }
  96
  97     function insert()
  98     {
  99         $result = parent::insert();
 100         if ($result) {
 101             $this->fixupTimestamps();
 102             $this->encache(); // in case of cached negative lookups
 103         }
 104         return $result;
 105     }
 106
 107     function update($orig=null)
 108     {
 109         if (is_object($orig) && $orig instanceof Memcached_DataObject) {
 110             $orig->decache(); # might be different keys
 111         }
 112         $result = parent::update($orig);
 113         if ($result) {
 114             $this->fixupTimestamps();
 115             $this->encache();
 116         }
 117         return $result;
 118     }
 119
 120     function delete()
 121     {
 122         $this->decache(); # while we still have the values!
 123         return parent::delete();
 124     }
 125
 126     static function memcache() {
 127         return common_memcache();
 128     }
 129
 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()));
 135         }
 136         return common_cache_key(strtolower($cls).':'.$k.':'.$v);
 137     }
 138
 139     static function getcached($cls, $k, $v) {
 140         $c = Memcached_DataObject::memcache();
 141         if (!$c) {
 142             return false;
 143         } else {
 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));
 150                     return false;
 151                 }
 152             }
 153             return $obj;
 154         }
 155     }
 156
 157     function keyTypes()
 158     {
 159         // ini-based classes return number-indexed arrays. handbuilt
 160         // classes return column => keytype. Make this uniform.
 161
 162         $keys = $this->keys();
 163
 164         $keyskeys = array_keys($keys);
 165
 166         if (is_string($keyskeys[0])) {
 167             return $keys;
 168         }
 169
 170         global $_DB_DATAOBJECT;
 171         if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
 172             $this->databaseStructure();
 173
 174         }
 175         return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
 176     }
 177
 178     function encache()
 179     {
 180         $c = $this->memcache();
 181
 182         if (!$c) {
 183             return false;
 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()));
 189             return false;
 190         } else {
 191                 $keys = $this->_allCacheKeys();
 192
 193                 foreach ($keys as $key) {
 194                     $c->set($key, $this);
 195                 }
 196         }
 197     }
 198
 199     function decache()
 200     {
 201         $c = $this->memcache();
 202
 203         if (!$c) {
 204             return false;
 205         }
 206
 207         $keys = $this->_allCacheKeys();
 208
 209         foreach ($keys as $key) {
 210             $c->delete($key, $this);
 211         }
 212     }
 213
 214     function _allCacheKeys()
 215     {
 216         $ckeys = array();
 217
 218         $types = $this->keyTypes();
 219         ksort($types);
 220
 221         $pkey = array();
 222         $pval = array();
 223
 224         foreach ($types as $key => $type) {
 225
 226             assert(!empty($key));
 227
 228             if ($type == 'U') {
 229                 if (empty($this->$key)) {
 230                     continue;
 231                 }
 232                 $ckeys[] = $this->cacheKey($this->tableName(), $key, $this->$key);
 233             } else if ($type == 'K' || $type == 'N') {
 234                 $pkey[] = $key;
 235                 $pval[] = $this->$key;
 236             } else {
 237                 throw new Exception("Unknown key type $key => $type for " . $this->tableName());
 238             }
 239         }
 240
 241         assert(count($pkey) > 0);
 242
 243         // XXX: should work for both compound and scalar pkeys
 244         $pvals = implode(',', $pval);
 245         $pkeys = implode(',', $pkey);
 246
 247         $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);
 248
 249         return $ckeys;
 250     }
 251
 252     function multicache($cls, $kv)
 253     {
 254         ksort($kv);
 255         $c = self::memcache();
 256         if (!$c) {
 257             return false;
 258         } else {
 259             return $c->get(self::multicacheKey($cls, $kv));
 260         }
 261     }
 262
 263     static function multicacheKey($cls, $kv)
 264     {
 265         ksort($kv);
 266         $pkeys = implode(',', array_keys($kv));
 267         $pvals = implode(',', array_values($kv));
 268         return self::cacheKey($cls, $pkeys, $pvals);
 269     }
 270
 271     function getSearchEngine($table)
 272     {
 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);
 283                     } else {
 284                         throw new ServerException('Unknown search type: ' . $type);
 285                     }
 286                 } else {
 287                     $search_engine = new PGSearch($this, $table);
 288                 }
 289             }
 290         }
 291         return $search_engine;
 292     }
 293
 294     static function cachedQuery($cls, $qry, $expiry=3600)
 295     {
 296         $c = Memcached_DataObject::memcache();
 297         if (!$c) {
 298             $inst = new $cls();
 299             $inst->query($qry);
 300             return $inst;
 301         }
 302         $key_part = common_keyize($cls).':'.md5($qry);
 303         $ckey = common_cache_key($key_part);
 304         $stored = $c->get($ckey);
 305
 306         if ($stored !== false) {
 307             return new ArrayWrapper($stored);
 308         }
 309
 310         $inst = new $cls();
 311         $inst->query($qry);
 312         $cached = array();
 313         while ($inst->fetch()) {
 314             $cached[] = clone($inst);
 315         }
 316         $inst->free();
 317         $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
 318         return new ArrayWrapper($cached);
 319     }
 320
 321     /**
 322      * sends query to database - this is the private one that must work
 323      *   - internal functions use this rather than $this->query()
 324      *
 325      * Overridden to do logging.
 326      *
 327      * @param  string  $string
 328      * @access private
 329      * @return mixed none or PEAR_Error
 330      */
 331     function _query($string)
 332     {
 333         if (common_config('db', 'annotate_queries')) {
 334             $string = $this->annotateQuery($string);
 335         }
 336
 337         $start = microtime(true);
 338         $result = parent::_query($string);
 339         $delta = microtime(true) - $start;
 340
 341         $limit = common_config('db', 'log_slow_queries');
 342         if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
 343             $clean = $this->sanitizeQuery($string);
 344             common_log(LOG_DEBUG, sprintf("DB query (%0.3fs): %s", $delta, $clean));
 345         }
 346         return $result;
 347     }
 348
 349     /**
 350      * Find the first caller in the stack trace that's not a
 351      * low-level database function and add a comment to the
 352      * query string. This should then be visible in process lists
 353      * and slow query logs, to help identify problem areas.
 354      *
 355      * Also marks whether this was a web GET/POST or which daemon
 356      * was running it.
 357      *
 358      * @param string $string SQL query string
 359      * @return string SQL query string, with a comment in it
 360      */
 361     function annotateQuery($string)
 362     {
 363         $ignore = array('annotateQuery',
 364                         '_query',
 365                         'query',
 366                         'get',
 367                         'insert',
 368                         'delete',
 369                         'update',
 370                         'find');
 371         $ignoreStatic = array('staticGet',
 372                               'pkeyGet',
 373                               'cachedQuery');
 374         $here = get_class($this); // if we get confused
 375         $bt = debug_backtrace();
 376
 377         // Find the first caller that's not us?
 378         foreach ($bt as $frame) {
 379             $func = $frame['function'];
 380             if (isset($frame['type']) && $frame['type'] == '::') {
 381                 if (in_array($func, $ignoreStatic)) {
 382                     continue;
 383                 }
 384                 $here = $frame['class'] . '::' . $func;
 385                 break;
 386             } else if (isset($frame['type']) && $frame['type'] == '->') {
 387                 if ($frame['object'] === $this && in_array($func, $ignore)) {
 388                     continue;
 389                 }
 390                 if (in_array($func, $ignoreStatic)) {
 391                     continue; // @fixme this shouldn't be needed?
 392                 }
 393                 $here = get_class($frame['object']) . '->' . $func;
 394                 break;
 395             }
 396             $here = $func;
 397             break;
 398         }
 399
 400         if (php_sapi_name() == 'cli') {
 401             $context = basename($_SERVER['PHP_SELF']);
 402         } else {
 403             $context = $_SERVER['REQUEST_METHOD'];
 404         }
 405
 406         // Slip the comment in after the first command,
 407         // or DB_DataObject gets confused about handling inserts and such.
 408         $parts = explode(' ', $string, 2);
 409         $parts[0] .= " /* $context $here */";
 410         return implode(' ', $parts);
 411     }
 412
 413     // Sanitize a query for logging
 414     // @fixme don't trim spaces in string literals
 415     function sanitizeQuery($string)
 416     {
 417         $string = preg_replace('/\s+/', ' ', $string);
 418         $string = trim($string);
 419         return $string;
 420     }
 421
 422     // We overload so that 'SET NAMES "utf8"' is called for
 423     // each connection
 424
 425     function _connect()
 426     {
 427         global $_DB_DATAOBJECT;
 428
 429         $sum = $this->_getDbDsnMD5();
 430
 431         if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
 432             !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
 433             $exists = true;
 434         } else {
 435             $exists = false;
 436        }
 437
 438         // @fixme horrible evil hack!
 439         //
 440         // In multisite configuration we don't want to keep around a separate
 441         // connection for every database; we could end up with thousands of
 442         // connections open per thread. In an ideal world we might keep
 443         // a connection per server and select different databases, but that'd
 444         // be reliant on having the same db username/pass as well.
 445         //
 446         // MySQL connections are cheap enough we're going to try just
 447         // closing out the old connection and reopening when we encounter
 448         // a new DSN.
 449         //
 450         // WARNING WARNING if we end up actually using multiple DBs at a time
 451         // we'll need some fancier logic here.
 452         if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
 453             foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
 454                 if (!empty($conn)) {
 455                     $conn->disconnect();
 456                 }
 457                 unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
 458             }
 459         }
 460
 461         $result = parent::_connect();
 462
 463         if ($result && !$exists) {
 464             $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
 465             if (common_config('db', 'type') == 'mysql' &&
 466                 common_config('db', 'utf8')) {
 467                 $conn = $DB->connection;
 468                 if (!empty($conn)) {
 469                     if ($DB instanceof DB_mysqli) {
 470                         mysqli_set_charset($conn, 'utf8');
 471                     } else if ($DB instanceof DB_mysql) {
 472                         mysql_set_charset('utf8', $conn);
 473                     }
 474                 }
 475             }
 476         }
 477
 478         return $result;
 479     }
 480
 481     // XXX: largely cadged from DB_DataObject
 482
 483     function _getDbDsnMD5()
 484     {
 485         if ($this->_database_dsn_md5) {
 486             return $this->_database_dsn_md5;
 487         }
 488
 489         $dsn = $this->_getDbDsn();
 490
 491         if (is_string($dsn)) {
 492             $sum = md5($dsn);
 493         } else {
 494             /// support array based dsn's
 495             $sum = md5(serialize($dsn));
 496         }
 497
 498         return $sum;
 499     }
 500
 501     function _getDbDsn()
 502     {
 503         global $_DB_DATAOBJECT;
 504
 505         if (empty($_DB_DATAOBJECT['CONFIG'])) {
 506             DB_DataObject::_loadConfig();
 507         }
 508
 509         $options = &$_DB_DATAOBJECT['CONFIG'];
 510
 511         // if the databse dsn dis defined in the object..
 512
 513         $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
 514
 515         if (!$dsn) {
 516
 517             if (!$this->_database) {
 518                 $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
 519             }
 520
 521             if ($this->_database && !empty($options["database_{$this->_database}"]))  {
 522                 $dsn = $options["database_{$this->_database}"];
 523             } else if (!empty($options['database'])) {
 524                 $dsn = $options['database'];
 525             }
 526         }
 527
 528         if (!$dsn) {
 529             throw new Exception("No database name / dsn found anywhere");
 530         }
 531
 532         return $dsn;
 533     }
 534
 535     static function blow()
 536     {
 537         $c = self::memcache();
 538
 539         if (empty($c)) {
 540             return false;
 541         }
 542
 543         $args = func_get_args();
 544
 545         $format = array_shift($args);
 546
 547         $keyPart = vsprintf($format, $args);
 548
 549         $cacheKey = common_cache_key($keyPart);
 550
 551         return $c->delete($cacheKey);
 552     }
 553
 554     function fixupTimestamps()
 555     {
 556         // Fake up timestamp columns
 557         $columns = $this->table();
 558         foreach ($columns as $name => $type) {
 559             if ($type & DB_DATAOBJECT_MYSQLTIMESTAMP) {
 560                 $this->$name = common_sql_now();
 561             }
 562         }
 563     }
 564
 565     function debugDump()
 566     {
 567         common_debug("debugDump: " . common_log_objstring($this));
 568     }
 569
 570     function raiseError($message, $type = null, $behaviour = null)
 571     {
 572         $id = get_class($this);
 573         if (!empty($this->id)) {
 574             $id .= ':' . $this->id;
 575         }
 576         if ($message instanceof PEAR_Error) {
 577             $message = $message->getMessage();
 578         }
 579         throw new ServerException("[$id] DB_DataObject error [$type]: $message");
 580     }
 581
 582     static function cacheGet($keyPart)
 583     {
 584         $c = self::memcache();
 585
 586         if (empty($c)) {
 587             return false;
 588         }
 589
 590         $cacheKey = common_cache_key($keyPart);
 591
 592         return $c->get($cacheKey);
 593     }
 594
 595     static function cacheSet($keyPart, $value)
 596     {
 597         $c = self::memcache();
 598
 599         if (empty($c)) {
 600             return false;
 601         }
 602
 603         $cacheKey = common_cache_key($keyPart);
 604
 605         return $c->set($cacheKey, $value);
 606     }
 607 }
 608