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) && !($v instanceof DB_DataObject_Cast))) {
 132             $e = new Exception();
 133             common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
 134                 str_replace("\n", " ", $e->getTraceAsString()));
 135         }
 136         $vstr = self::valueString($v);
 137         return common_cache_key(strtolower($cls).':'.$k.':'.$vstr);
 138     }
 139
 140     static function getcached($cls, $k, $v) {
 141         $c = Memcached_DataObject::memcache();
 142         if (!$c) {
 143             return false;
 144         } else {
 145             $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
 146             if (0 == strcasecmp($cls, 'User')) {
 147                 // Special case for User
 148                 if (is_object($obj) && is_object($obj->id)) {
 149                     common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
 150                     $c->delete(Memcached_DataObject::cacheKey($cls, $k, $v));
 151                     return false;
 152                 }
 153             }
 154             return $obj;
 155         }
 156     }
 157
 158     function keyTypes()
 159     {
 160         // ini-based classes return number-indexed arrays. handbuilt
 161         // classes return column => keytype. Make this uniform.
 162
 163         $keys = $this->keys();
 164
 165         $keyskeys = array_keys($keys);
 166
 167         if (is_string($keyskeys[0])) {
 168             return $keys;
 169         }
 170
 171         global $_DB_DATAOBJECT;
 172         if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
 173             $this->databaseStructure();
 174
 175         }
 176         return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
 177     }
 178
 179     function encache()
 180     {
 181         $c = $this->memcache();
 182
 183         if (!$c) {
 184             return false;
 185         } else if ($this->tableName() == 'user' && is_object($this->id)) {
 186             // Special case for User bug
 187             $e = new Exception();
 188             common_log(LOG_ERR, __METHOD__ . ' caching user with User object as ID ' .
 189                        str_replace("\n", " ", $e->getTraceAsString()));
 190             return false;
 191         } else {
 192                 $keys = $this->_allCacheKeys();
 193
 194                 foreach ($keys as $key) {
 195                     $c->set($key, $this);
 196                 }
 197         }
 198     }
 199
 200     function decache()
 201     {
 202         $c = $this->memcache();
 203
 204         if (!$c) {
 205             return false;
 206         }
 207
 208         $keys = $this->_allCacheKeys();
 209
 210         foreach ($keys as $key) {
 211             $c->delete($key, $this);
 212         }
 213     }
 214
 215     function _allCacheKeys()
 216     {
 217         $ckeys = array();
 218
 219         $types = $this->keyTypes();
 220         ksort($types);
 221
 222         $pkey = array();
 223         $pval = array();
 224
 225         foreach ($types as $key => $type) {
 226
 227             assert(!empty($key));
 228
 229             if ($type == 'U') {
 230                 if (empty($this->$key)) {
 231                     continue;
 232                 }
 233                 $ckeys[] = $this->cacheKey($this->tableName(), $key, self::valueString($this->$key));
 234             } else if ($type == 'K' || $type == 'N') {
 235                 $pkey[] = $key;
 236                 $pval[] = self::valueString($this->$key);
 237             } else {
 238                 throw new Exception("Unknown key type $key => $type for " . $this->tableName());
 239             }
 240         }
 241
 242         assert(count($pkey) > 0);
 243
 244         // XXX: should work for both compound and scalar pkeys
 245         $pvals = implode(',', $pval);
 246         $pkeys = implode(',', $pkey);
 247
 248         $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);
 249
 250         return $ckeys;
 251     }
 252
 253     function multicache($cls, $kv)
 254     {
 255         ksort($kv);
 256         $c = self::memcache();
 257         if (!$c) {
 258             return false;
 259         } else {
 260             return $c->get(self::multicacheKey($cls, $kv));
 261         }
 262     }
 263
 264     static function multicacheKey($cls, $kv)
 265     {
 266         ksort($kv);
 267         $pkeys = implode(',', array_keys($kv));
 268         $pvals = implode(',', array_values($kv));
 269         return self::cacheKey($cls, $pkeys, $pvals);
 270     }
 271
 272     function getSearchEngine($table)
 273     {
 274         require_once INSTALLDIR.'/lib/search_engines.php';
 275         static $search_engine;
 276         if (!isset($search_engine)) {
 277             if (Event::handle('GetSearchEngine', array($this, $table, &$search_engine))) {
 278                 if ('mysql' === common_config('db', 'type')) {
 279                     $type = common_config('search', 'type');
 280                     if ($type == 'like') {
 281                         $search_engine = new MySQLLikeSearch($this, $table);
 282                     } else if ($type == 'fulltext') {
 283                         $search_engine = new MySQLSearch($this, $table);
 284                     } else {
 285                         throw new ServerException('Unknown search type: ' . $type);
 286                     }
 287                 } else {
 288                     $search_engine = new PGSearch($this, $table);
 289                 }
 290             }
 291         }
 292         return $search_engine;
 293     }
 294
 295     static function cachedQuery($cls, $qry, $expiry=3600)
 296     {
 297         $c = Memcached_DataObject::memcache();
 298         if (!$c) {
 299             $inst = new $cls();
 300             $inst->query($qry);
 301             return $inst;
 302         }
 303         $key_part = common_keyize($cls).':'.md5($qry);
 304         $ckey = common_cache_key($key_part);
 305         $stored = $c->get($ckey);
 306
 307         if ($stored !== false) {
 308             return new ArrayWrapper($stored);
 309         }
 310
 311         $inst = new $cls();
 312         $inst->query($qry);
 313         $cached = array();
 314         while ($inst->fetch()) {
 315             $cached[] = clone($inst);
 316         }
 317         $inst->free();
 318         $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
 319         return new ArrayWrapper($cached);
 320     }
 321
 322     /**
 323      * sends query to database - this is the private one that must work
 324      *   - internal functions use this rather than $this->query()
 325      *
 326      * Overridden to do logging.
 327      *
 328      * @param  string  $string
 329      * @access private
 330      * @return mixed none or PEAR_Error
 331      */
 332     function _query($string)
 333     {
 334         if (common_config('db', 'annotate_queries')) {
 335             $string = $this->annotateQuery($string);
 336         }
 337
 338         $start = microtime(true);
 339         $result = parent::_query($string);
 340         $delta = microtime(true) - $start;
 341
 342         $limit = common_config('db', 'log_slow_queries');
 343         if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
 344             $clean = $this->sanitizeQuery($string);
 345             common_log(LOG_DEBUG, sprintf("DB query (%0.3fs): %s", $delta, $clean));
 346         }
 347         return $result;
 348     }
 349
 350     /**
 351      * Find the first caller in the stack trace that's not a
 352      * low-level database function and add a comment to the
 353      * query string. This should then be visible in process lists
 354      * and slow query logs, to help identify problem areas.
 355      *
 356      * Also marks whether this was a web GET/POST or which daemon
 357      * was running it.
 358      *
 359      * @param string $string SQL query string
 360      * @return string SQL query string, with a comment in it
 361      */
 362     function annotateQuery($string)
 363     {
 364         $ignore = array('annotateQuery',
 365                         '_query',
 366                         'query',
 367                         'get',
 368                         'insert',
 369                         'delete',
 370                         'update',
 371                         'find');
 372         $ignoreStatic = array('staticGet',
 373                               'pkeyGet',
 374                               'cachedQuery');
 375         $here = get_class($this); // if we get confused
 376         $bt = debug_backtrace();
 377
 378         // Find the first caller that's not us?
 379         foreach ($bt as $frame) {
 380             $func = $frame['function'];
 381             if (isset($frame['type']) && $frame['type'] == '::') {
 382                 if (in_array($func, $ignoreStatic)) {
 383                     continue;
 384                 }
 385                 $here = $frame['class'] . '::' . $func;
 386                 break;
 387             } else if (isset($frame['type']) && $frame['type'] == '->') {
 388                 if ($frame['object'] === $this && in_array($func, $ignore)) {
 389                     continue;
 390                 }
 391                 if (in_array($func, $ignoreStatic)) {
 392                     continue; // @fixme this shouldn't be needed?
 393                 }
 394                 $here = get_class($frame['object']) . '->' . $func;
 395                 break;
 396             }
 397             $here = $func;
 398             break;
 399         }
 400
 401         if (php_sapi_name() == 'cli') {
 402             $context = basename($_SERVER['PHP_SELF']);
 403         } else {
 404             $context = $_SERVER['REQUEST_METHOD'];
 405         }
 406
 407         // Slip the comment in after the first command,
 408         // or DB_DataObject gets confused about handling inserts and such.
 409         $parts = explode(' ', $string, 2);
 410         $parts[0] .= " /* $context $here */";
 411         return implode(' ', $parts);
 412     }
 413
 414     // Sanitize a query for logging
 415     // @fixme don't trim spaces in string literals
 416     function sanitizeQuery($string)
 417     {
 418         $string = preg_replace('/\s+/', ' ', $string);
 419         $string = trim($string);
 420         return $string;
 421     }
 422
 423     // We overload so that 'SET NAMES "utf8"' is called for
 424     // each connection
 425
 426     function _connect()
 427     {
 428         global $_DB_DATAOBJECT;
 429
 430         $sum = $this->_getDbDsnMD5();
 431
 432         if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
 433             !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
 434             $exists = true;
 435         } else {
 436             $exists = false;
 437        }
 438
 439         // @fixme horrible evil hack!
 440         //
 441         // In multisite configuration we don't want to keep around a separate
 442         // connection for every database; we could end up with thousands of
 443         // connections open per thread. In an ideal world we might keep
 444         // a connection per server and select different databases, but that'd
 445         // be reliant on having the same db username/pass as well.
 446         //
 447         // MySQL connections are cheap enough we're going to try just
 448         // closing out the old connection and reopening when we encounter
 449         // a new DSN.
 450         //
 451         // WARNING WARNING if we end up actually using multiple DBs at a time
 452         // we'll need some fancier logic here.
 453         if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
 454             foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
 455                 if (!empty($conn)) {
 456                     $conn->disconnect();
 457                 }
 458                 unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
 459             }
 460         }
 461
 462         $result = parent::_connect();
 463
 464         if ($result && !$exists) {
 465             $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
 466             if (common_config('db', 'type') == 'mysql' &&
 467                 common_config('db', 'utf8')) {
 468                 $conn = $DB->connection;
 469                 if (!empty($conn)) {
 470                     if ($DB instanceof DB_mysqli) {
 471                         mysqli_set_charset($conn, 'utf8');
 472                     } else if ($DB instanceof DB_mysql) {
 473                         mysql_set_charset('utf8', $conn);
 474                     }
 475                 }
 476             }
 477         }
 478
 479         return $result;
 480     }
 481
 482     // XXX: largely cadged from DB_DataObject
 483
 484     function _getDbDsnMD5()
 485     {
 486         if ($this->_database_dsn_md5) {
 487             return $this->_database_dsn_md5;
 488         }
 489
 490         $dsn = $this->_getDbDsn();
 491
 492         if (is_string($dsn)) {
 493             $sum = md5($dsn);
 494         } else {
 495             /// support array based dsn's
 496             $sum = md5(serialize($dsn));
 497         }
 498
 499         return $sum;
 500     }
 501
 502     function _getDbDsn()
 503     {
 504         global $_DB_DATAOBJECT;
 505
 506         if (empty($_DB_DATAOBJECT['CONFIG'])) {
 507             DB_DataObject::_loadConfig();
 508         }
 509
 510         $options = &$_DB_DATAOBJECT['CONFIG'];
 511
 512         // if the databse dsn dis defined in the object..
 513
 514         $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
 515
 516         if (!$dsn) {
 517
 518             if (!$this->_database) {
 519                 $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
 520             }
 521
 522             if ($this->_database && !empty($options["database_{$this->_database}"]))  {
 523                 $dsn = $options["database_{$this->_database}"];
 524             } else if (!empty($options['database'])) {
 525                 $dsn = $options['database'];
 526             }
 527         }
 528
 529         if (!$dsn) {
 530             throw new Exception("No database name / dsn found anywhere");
 531         }
 532
 533         return $dsn;
 534     }
 535
 536     static function blow()
 537     {
 538         $c = self::memcache();
 539
 540         if (empty($c)) {
 541             return false;
 542         }
 543
 544         $args = func_get_args();
 545
 546         $format = array_shift($args);
 547
 548         $keyPart = vsprintf($format, $args);
 549
 550         $cacheKey = common_cache_key($keyPart);
 551
 552         return $c->delete($cacheKey);
 553     }
 554
 555     function fixupTimestamps()
 556     {
 557         // Fake up timestamp columns
 558         $columns = $this->table();
 559         foreach ($columns as $name => $type) {
 560             if ($type & DB_DATAOBJECT_MYSQLTIMESTAMP) {
 561                 $this->$name = common_sql_now();
 562             }
 563         }
 564     }
 565
 566     function debugDump()
 567     {
 568         common_debug("debugDump: " . common_log_objstring($this));
 569     }
 570
 571     function raiseError($message, $type = null, $behaviour = null)
 572     {
 573         $id = get_class($this);
 574         if (!empty($this->id)) {
 575             $id .= ':' . $this->id;
 576         }
 577         if ($message instanceof PEAR_Error) {
 578             $message = $message->getMessage();
 579         }
 580         throw new ServerException("[$id] DB_DataObject error [$type]: $message");
 581     }
 582
 583     static function cacheGet($keyPart)
 584     {
 585         $c = self::memcache();
 586
 587         if (empty($c)) {
 588             return false;
 589         }
 590
 591         $cacheKey = common_cache_key($keyPart);
 592
 593         return $c->get($cacheKey);
 594     }
 595
 596     static function cacheSet($keyPart, $value)
 597     {
 598         $c = self::memcache();
 599
 600         if (empty($c)) {
 601             return false;
 602         }
 603
 604         $cacheKey = common_cache_key($keyPart);
 605
 606         return $c->set($cacheKey, $value);
 607     }
 608
 609     static function valueString($v)
 610     {
 611         $vstr = null;
 612         if (is_object($v) && $v instanceof DB_DataObject_Cast) {
 613             switch ($v->type) {
 614             case 'date':
 615                 $vstr = $v->year . '-' . $v->month . '-' . $v->day;
 616                 break;
 617             case 'blob':
 618             case 'string':
 619             case 'sql':
 620             case 'datetime':
 621             case 'time':
 622                 throw new ServerException("Unhandled DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
 623                 break;
 624             default:
 625                 throw new ServerException("Unknown DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
 626                 break;
 627             }
 628         } else {
 629             $vstr = strval($v);
 630         }
 631         return $vstr;
 632     }
 633 }
 634