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