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 DB_DataObject
  23 {
  24     /**
  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.
  28      */
  29
  30     function __destruct()
  31     {
  32         $this->free();
  33         if (method_exists('DB_DataObject', '__destruct')) {
  34             parent::__destruct();
  35         }
  36     }
  37
  38     /**
  39      * Magic function called at serialize() time.
  40      *
  41      * We use this to drop a couple process-specific references
  42      * from DB_DataObject which can cause trouble in future
  43      * processes.
  44      *
  45      * @return array of variable names to include in serialization.
  46      */
  47     function __sleep()
  48     {
  49         $vars = array_keys(get_object_vars($this));
  50         $skip = array('_DB_resultid', '_link_loaded');
  51         return array_diff($vars, $skip);
  52     }
  53
  54     /**
  55      * Magic function called at unserialize() time.
  56      *
  57      * Clean out some process-specific variables which might
  58      * be floating around from a previous process's cached
  59      * objects.
  60      *
  61      * Old cached objects may still have them.
  62      */
  63     function __wakeup()
  64     {
  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;
  71     }
  72
  73     /**
  74      * Wrapper for DB_DataObject's static lookup using memcached
  75      * as backing instead of an in-process cache array.
  76      *
  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
  81      */
  82     function &staticGet($cls, $k, $v=null)
  83     {
  84         if (is_null($v)) {
  85             $v = $k;
  86             # XXX: HACK!
  87             $i = new $cls;
  88             $keys = $i->keys();
  89             $k = $keys[0];
  90             unset($i);
  91         }
  92         $i = Memcached_DataObject::getcached($cls, $k, $v);
  93         if ($i === false) { // false == cache miss
  94             $i = DB_DataObject::factory($cls);
  95             if (empty($i)) {
  96                 $i = false;
  97                 return $i;
  98             }
  99             $result = $i->get($k, $v);
 100             if ($result) {
 101                 // Hit!
 102                 $i->encache();
 103             } else {
 104                 // save the fact that no such row exists
 105                 $c = self::memcache();
 106                 if (!empty($c)) {
 107                     $ck = self::cachekey($cls, $k, $v);
 108                     $c->set($ck, null);
 109                 }
 110                 $i = false;
 111             }
 112         }
 113         return $i;
 114     }
 115
 116     /**
 117      * @fixme Should this return false on lookup fail to match staticGet?
 118      */
 119     function pkeyGet($cls, $kv)
 120     {
 121         $i = Memcached_DataObject::multicache($cls, $kv);
 122         if ($i !== false) { // false == cache miss
 123             return $i;
 124         } else {
 125             $i = DB_DataObject::factory($cls);
 126             if (empty($i)) {
 127                 return false;
 128             }
 129             foreach ($kv as $k => $v) {
 130                 $i->$k = $v;
 131             }
 132             if ($i->find(true)) {
 133                 $i->encache();
 134             } else {
 135                 $i = null;
 136                 $c = self::memcache();
 137                 if (!empty($c)) {
 138                     $ck = self::multicacheKey($cls, $kv);
 139                     $c->set($ck, null);
 140                 }
 141             }
 142             return $i;
 143         }
 144     }
 145
 146     function insert()
 147     {
 148         $result = parent::insert();
 149         if ($result) {
 150             $this->encache(); // in case of cached negative lookups
 151         }
 152         return $result;
 153     }
 154
 155     function update($orig=null)
 156     {
 157         if (is_object($orig) && $orig instanceof Memcached_DataObject) {
 158             $orig->decache(); # might be different keys
 159         }
 160         $result = parent::update($orig);
 161         if ($result) {
 162             $this->encache();
 163         }
 164         return $result;
 165     }
 166
 167     function delete()
 168     {
 169         $this->decache(); # while we still have the values!
 170         return parent::delete();
 171     }
 172
 173     static function memcache() {
 174         return common_memcache();
 175     }
 176
 177     static function cacheKey($cls, $k, $v) {
 178         if (is_object($cls) || is_object($k) || is_object($v)) {
 179             $e = new Exception();
 180             common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
 181                 str_replace("\n", " ", $e->getTraceAsString()));
 182         }
 183         return common_cache_key(strtolower($cls).':'.$k.':'.$v);
 184     }
 185
 186     static function getcached($cls, $k, $v) {
 187         $c = Memcached_DataObject::memcache();
 188         if (!$c) {
 189             return false;
 190         } else {
 191             return $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
 192         }
 193     }
 194
 195     function keyTypes()
 196     {
 197         global $_DB_DATAOBJECT;
 198         if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
 199             $this->databaseStructure();
 200
 201         }
 202         return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
 203     }
 204
 205     function encache()
 206     {
 207         $c = $this->memcache();
 208
 209         if (!$c) {
 210             return false;
 211         }
 212
 213         $keys = $this->_allCacheKeys();
 214
 215         foreach ($keys as $key) {
 216             $c->set($key, $this);
 217         }
 218     }
 219
 220     function decache()
 221     {
 222         $c = $this->memcache();
 223
 224         if (!$c) {
 225             return false;
 226         }
 227
 228         $keys = $this->_allCacheKeys();
 229
 230         foreach ($keys as $key) {
 231             $c->delete($key, $this);
 232         }
 233     }
 234
 235     function _allCacheKeys()
 236     {
 237         $ckeys = array();
 238
 239         $types = $this->keyTypes();
 240         ksort($types);
 241
 242         $pkey = array();
 243         $pval = array();
 244
 245         foreach ($types as $key => $type) {
 246
 247             assert(!empty($key));
 248
 249             if ($type == 'U') {
 250                 if (empty($this->$key)) {
 251                     continue;
 252                 }
 253                 $ckeys[] = $this->cacheKey($this->tableName(), $key, $this->$key);
 254             } else if ($type == 'K' || $type == 'N') {
 255                 $pkey[] = $key;
 256                 $pval[] = $this->$key;
 257             } else {
 258                 throw new Exception("Unknown key type $key => $type for " . $this->tableName());
 259             }
 260         }
 261
 262         assert(count($pkey) > 0);
 263
 264         // XXX: should work for both compound and scalar pkeys
 265         $pvals = implode(',', $pval);
 266         $pkeys = implode(',', $pkey);
 267
 268         $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);
 269
 270         return $ckeys;
 271     }
 272
 273     function multicache($cls, $kv)
 274     {
 275         ksort($kv);
 276         $c = self::memcache();
 277         if (!$c) {
 278             return false;
 279         } else {
 280             return $c->get(self::multicacheKey($cls, $kv));
 281         }
 282     }
 283
 284     static function multicacheKey($cls, $kv)
 285     {
 286         ksort($kv);
 287         $pkeys = implode(',', array_keys($kv));
 288         $pvals = implode(',', array_values($kv));
 289         return self::cacheKey($cls, $pkeys, $pvals);
 290     }
 291
 292     function getSearchEngine($table)
 293     {
 294         require_once INSTALLDIR.'/lib/search_engines.php';
 295         static $search_engine;
 296         if (!isset($search_engine)) {
 297             if (Event::handle('GetSearchEngine', array($this, $table, &$search_engine))) {
 298                 if ('mysql' === common_config('db', 'type')) {
 299                     $type = common_config('search', 'type');
 300                     if ($type == 'like') {
 301                         $search_engine = new MySQLLikeSearch($this, $table);
 302                     } else if ($type == 'fulltext') {
 303                         $search_engine = new MySQLSearch($this, $table);
 304                     } else {
 305                         throw new ServerException('Unknown search type: ' . $type);
 306                     }
 307                 } else {
 308                     $search_engine = new PGSearch($this, $table);
 309                 }
 310             }
 311         }
 312         return $search_engine;
 313     }
 314
 315     static function cachedQuery($cls, $qry, $expiry=3600)
 316     {
 317         $c = Memcached_DataObject::memcache();
 318         if (!$c) {
 319             $inst = new $cls();
 320             $inst->query($qry);
 321             return $inst;
 322         }
 323         $key_part = common_keyize($cls).':'.md5($qry);
 324         $ckey = common_cache_key($key_part);
 325         $stored = $c->get($ckey);
 326
 327         if ($stored !== false) {
 328             return new ArrayWrapper($stored);
 329         }
 330
 331         $inst = new $cls();
 332         $inst->query($qry);
 333         $cached = array();
 334         while ($inst->fetch()) {
 335             $cached[] = clone($inst);
 336         }
 337         $inst->free();
 338         $c->set($ckey, $cached, MEMCACHE_COMPRESSED, $expiry);
 339         return new ArrayWrapper($cached);
 340     }
 341
 342     // We overload so that 'SET NAMES "utf8"' is called for
 343     // each connection
 344
 345     function _connect()
 346     {
 347         global $_DB_DATAOBJECT;
 348
 349         $sum = $this->_getDbDsnMD5();
 350
 351         if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
 352             !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
 353             $exists = true;
 354         } else {
 355             $exists = false;
 356        }
 357
 358         $result = parent::_connect();
 359
 360         if ($result && !$exists) {
 361             $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
 362             if (common_config('db', 'type') == 'mysql' &&
 363                 common_config('db', 'utf8')) {
 364                 $conn = $DB->connection;
 365                 if (!empty($conn)) {
 366                     if ($DB instanceof DB_mysqli) {
 367                         mysqli_set_charset($conn, 'utf8');
 368                     } else if ($DB instanceof DB_mysql) {
 369                         mysql_set_charset('utf8', $conn);
 370                     }
 371                 }
 372             }
 373         }
 374
 375         return $result;
 376     }
 377
 378     // XXX: largely cadged from DB_DataObject
 379
 380     function _getDbDsnMD5()
 381     {
 382         if ($this->_database_dsn_md5) {
 383             return $this->_database_dsn_md5;
 384         }
 385
 386         $dsn = $this->_getDbDsn();
 387
 388         if (is_string($dsn)) {
 389             $sum = md5($dsn);
 390         } else {
 391             /// support array based dsn's
 392             $sum = md5(serialize($dsn));
 393         }
 394
 395         return $sum;
 396     }
 397
 398     function _getDbDsn()
 399     {
 400         global $_DB_DATAOBJECT;
 401
 402         if (empty($_DB_DATAOBJECT['CONFIG'])) {
 403             DB_DataObject::_loadConfig();
 404         }
 405
 406         $options = &$_DB_DATAOBJECT['CONFIG'];
 407
 408         // if the databse dsn dis defined in the object..
 409
 410         $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
 411
 412         if (!$dsn) {
 413
 414             if (!$this->_database) {
 415                 $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
 416             }
 417
 418             if ($this->_database && !empty($options["database_{$this->_database}"]))  {
 419                 $dsn = $options["database_{$this->_database}"];
 420             } else if (!empty($options['database'])) {
 421                 $dsn = $options['database'];
 422             }
 423         }
 424
 425         if (!$dsn) {
 426             throw new Exception("No database name / dsn found anywhere");
 427         }
 428
 429         return $dsn;
 430     }
 431 }