We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

Memcached_DataObject.php 20 KB
Newer Older
1 2
<?php
/*
3
 * StatusNet - the distributed open-source microblogging tool
4
 * Copyright (C) 2008, 2009, StatusNet, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

20
if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
21

22
class Memcached_DataObject extends Safe_DataObject
23
{
24 25 26 27 28 29 30 31 32
    /**
     * Wrapper for DB_DataObject's static lookup using memcached
     * as backing instead of an in-process cache array.
     *
     * @param string $cls classname of object type to load
     * @param mixed $k key field name, or value for primary key
     * @param mixed $v key field value, or leave out for primary key lookup
     * @return mixed Memcached_DataObject subtype or false
     */
33 34
    function &staticGet($cls, $k, $v=null)
    {
35 36
        if (is_null($v)) {
            $v = $k;
37
            // XXX: HACK!
38 39 40 41 42
            $i = new $cls;
            $keys = $i->keys();
            $k = $keys[0];
            unset($i);
        }
43
        $i = Memcached_DataObject::getcached($cls, $k, $v);
44
        if ($i === false) { // false == cache miss
45 46
            $i = DB_DataObject::factory($cls);
            if (empty($i)) {
47 48
                $i = false;
                return $i;
49 50 51
            }
            $result = $i->get($k, $v);
            if ($result) {
52
                // Hit!
53
                $i->encache();
54
            } else {
55 56 57 58 59 60
                // save the fact that no such row exists
                $c = self::memcache();
                if (!empty($c)) {
                    $ck = self::cachekey($cls, $k, $v);
                    $c->set($ck, null);
                }
61
                $i = false;
62 63
            }
        }
64
        return $i;
65
    }
66

67 68 69 70
    /**
     * @fixme Should this return false on lookup fail to match staticGet?
     */
    function pkeyGet($cls, $kv)
71
    {
72
        $i = Memcached_DataObject::multicache($cls, $kv);
73
        if ($i !== false) { // false == cache miss
74 75
            return $i;
        } else {
76
            $i = DB_DataObject::factory($cls);
77
            if (empty($i) || PEAR::isError($i)) {
78 79
                return false;
            }
80
            foreach ($kv as $k => $v) {
81 82 83 84 85 86 87
            	if (is_null($v)) {
            		// XXX: possible SQL injection...? Don't 
            		// pass keys from the browser, eh.
            		$i->whereAdd("$k is null");
            	} else {
                	$i->$k = $v;
            	}
88 89 90 91
            }
            if ($i->find(true)) {
                $i->encache();
            } else {
Evan Prodromou's avatar
Evan Prodromou committed
92
                $i = null;
93 94 95 96 97
                $c = self::memcache();
                if (!empty($c)) {
                    $ck = self::multicacheKey($cls, $kv);
                    $c->set($ck, null);
                }
98
            }
99
            return $i;
100 101
        }
    }
102

103 104
    function insert()
    {
105
        $result = parent::insert();
106
        if ($result) {
107
            $this->fixupTimestamps();
108 109
            $this->encache(); // in case of cached negative lookups
        }
110 111
        return $result;
    }
112

113 114
    function update($orig=null)
    {
115 116 117 118 119
        if (is_object($orig) && $orig instanceof Memcached_DataObject) {
            $orig->decache(); # might be different keys
        }
        $result = parent::update($orig);
        if ($result) {
120
            $this->fixupTimestamps();
121 122 123 124
            $this->encache();
        }
        return $result;
    }
125

126 127
    function delete()
    {
128 129 130
        $this->decache(); # while we still have the values!
        return parent::delete();
    }
131

132
    static function memcache() {
133
        return Cache::instance();
134
    }
135

136
    static function cacheKey($cls, $k, $v) {
137
        if (is_object($cls) || is_object($k) || (is_object($v) && !($v instanceof DB_DataObject_Cast))) {
138 139 140 141
            $e = new Exception();
            common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
                str_replace("\n", " ", $e->getTraceAsString()));
        }
142
        $vstr = self::valueString($v);
143
        return Cache::key(strtolower($cls).':'.$k.':'.$vstr);
144
    }
145

146
    static function getcached($cls, $k, $v) {
147
        $c = Memcached_DataObject::memcache();
148 149 150
        if (!$c) {
            return false;
        } else {
151 152 153
            $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
            if (0 == strcasecmp($cls, 'User')) {
                // Special case for User
154
                if (is_object($obj) && is_object($obj->id)) {
155 156 157 158 159 160
                    common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
                    $c->delete(Memcached_DataObject::cacheKey($cls, $k, $v));
                    return false;
                }
            }
            return $obj;
161 162
        }
    }
163

164 165
    function keyTypes()
    {
166 167 168 169 170 171 172 173 174 175 176
        // ini-based classes return number-indexed arrays. handbuilt
        // classes return column => keytype. Make this uniform.

        $keys = $this->keys();

        $keyskeys = array_keys($keys);

        if (is_string($keyskeys[0])) {
            return $keys;
        }

177
        global $_DB_DATAOBJECT;
178
        if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
179
            $this->databaseStructure();
180 181

        }
182 183
        return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
    }
184

185 186
    function encache()
    {
187
        $c = $this->memcache();
188

189 190
        if (!$c) {
            return false;
191 192 193 194 195 196
        } else if ($this->tableName() == 'user' && is_object($this->id)) {
            // Special case for User bug
            $e = new Exception();
            common_log(LOG_ERR, __METHOD__ . ' caching user with User object as ID ' .
                       str_replace("\n", " ", $e->getTraceAsString()));
            return false;
197
        } else {
198
            $keys = $this->_allCacheKeys();
199

200 201 202
            foreach ($keys as $key) {
                $c->set($key, $this);
            }
203 204
        }
    }
205

206 207
    function decache()
    {
208
        $c = $this->memcache();
209

210 211
        if (!$c) {
            return false;
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
        }

        $keys = $this->_allCacheKeys();

        foreach ($keys as $key) {
            $c->delete($key, $this);
        }
    }

    function _allCacheKeys()
    {
        $ckeys = array();

        $types = $this->keyTypes();
        ksort($types);

        $pkey = array();
        $pval = array();

        foreach ($types as $key => $type) {

            assert(!empty($key));

            if ($type == 'U') {
                if (empty($this->$key)) {
                    continue;
238
                }
239
                $ckeys[] = $this->cacheKey($this->tableName(), $key, self::valueString($this->$key));
240 241
            } else if ($type == 'K' || $type == 'N') {
                $pkey[] = $key;
242
                $pval[] = self::valueString($this->$key);
243
            } else {
244
                // Low level exception. No need for i18n as discussed with Brion.
245
                throw new Exception("Unknown key type $key => $type for " . $this->tableName());
246 247
            }
        }
248 249 250 251 252 253 254 255 256 257

        assert(count($pkey) > 0);

        // XXX: should work for both compound and scalar pkeys
        $pvals = implode(',', $pval);
        $pkeys = implode(',', $pkey);

        $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);

        return $ckeys;
258
    }
259

260 261
    function multicache($cls, $kv)
    {
262
        ksort($kv);
263
        $c = self::memcache();
264 265 266
        if (!$c) {
            return false;
        } else {
267
            return $c->get(self::multicacheKey($cls, $kv));
268 269
        }
    }
millette's avatar
millette committed
270

271 272 273 274 275 276 277 278
    static function multicacheKey($cls, $kv)
    {
        ksort($kv);
        $pkeys = implode(',', array_keys($kv));
        $pvals = implode(',', array_values($kv));
        return self::cacheKey($cls, $pkeys, $pvals);
    }

279 280
    function getSearchEngine($table)
    {
millette's avatar
millette committed
281
        require_once INSTALLDIR.'/lib/search_engines.php';
282 283 284 285 286 287 288 289

        if (Event::handle('GetSearchEngine', array($this, $table, &$search_engine))) {
            if ('mysql' === common_config('db', 'type')) {
                $type = common_config('search', 'type');
                if ($type == 'like') {
                    $search_engine = new MySQLLikeSearch($this, $table);
                } else if ($type == 'fulltext') {
                    $search_engine = new MySQLSearch($this, $table);
290
                } else {
291 292
                    // Low level exception. No need for i18n as discussed with Brion.
                    throw new ServerException('Unknown search type: ' . $type);
millette's avatar
millette committed
293
                }
294 295
            } else {
                $search_engine = new PGSearch($this, $table);
296
            }
millette's avatar
millette committed
297
        }
298

millette's avatar
millette committed
299 300
        return $search_engine;
    }
301 302 303

    static function cachedQuery($cls, $qry, $expiry=3600)
    {
304
        $c = Memcached_DataObject::memcache();
305 306 307
        if (!$c) {
            $inst = new $cls();
            $inst->query($qry);
308
            return $inst;
309
        }
310
        $key_part = Cache::keyize($cls).':'.md5($qry);
311
        $ckey = Cache::key($key_part);
312
        $stored = $c->get($ckey);
313 314

        if ($stored !== false) {
315 316 317 318
            return new ArrayWrapper($stored);
        }

        $inst = new $cls();
319
        $inst->query($qry);
320 321 322 323 324
        $cached = array();
        while ($inst->fetch()) {
            $cached[] = clone($inst);
        }
        $inst->free();
325
        $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
326
        return new ArrayWrapper($cached);
327
    }
328

329
    /**
330
     * sends query to database - this is the private one that must work
331 332 333 334 335 336 337 338 339 340
     *   - internal functions use this rather than $this->query()
     *
     * Overridden to do logging.
     *
     * @param  string  $string
     * @access private
     * @return mixed none or PEAR_Error
     */
    function _query($string)
    {
341 342 343 344
        if (common_config('db', 'annotate_queries')) {
            $string = $this->annotateQuery($string);
        }

345
        $start = microtime(true);
346
        $fail = false;
Brion Vibber's avatar
Brion Vibber committed
347 348
        $result = null;
        if (Event::handle('StartDBQuery', array($this, $string, &$result))) {
349
            common_perf_counter('query', $string);
Brion Vibber's avatar
Brion Vibber committed
350 351 352 353 354
            try {
                $result = parent::_query($string);
            } catch (Exception $e) {
                $fail = $e;
            }
Brion Vibber's avatar
Brion Vibber committed
355
            Event::handle('EndDBQuery', array($this, $string, &$result));
356
        }
357 358 359 360 361
        $delta = microtime(true) - $start;

        $limit = common_config('db', 'log_slow_queries');
        if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
            $clean = $this->sanitizeQuery($string);
362 363 364 365 366 367 368 369 370 371
            if ($fail) {
                $msg = sprintf("FAILED DB query (%0.3fs): %s - %s", $delta, $fail->getMessage(), $clean);
            } else {
                $msg = sprintf("DB query (%0.3fs): %s", $delta, $clean);
            }
            common_log(LOG_DEBUG, $msg);
        }

        if ($fail) {
            throw $fail;
372 373 374 375
        }
        return $result;
    }

376 377 378 379 380
    /**
     * Find the first caller in the stack trace that's not a
     * low-level database function and add a comment to the
     * query string. This should then be visible in process lists
     * and slow query logs, to help identify problem areas.
381
     *
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
     * Also marks whether this was a web GET/POST or which daemon
     * was running it.
     *
     * @param string $string SQL query string
     * @return string SQL query string, with a comment in it
     */
    function annotateQuery($string)
    {
        $ignore = array('annotateQuery',
                        '_query',
                        'query',
                        'get',
                        'insert',
                        'delete',
                        'update',
                        'find');
        $ignoreStatic = array('staticGet',
                              'pkeyGet',
                              'cachedQuery');
        $here = get_class($this); // if we get confused
        $bt = debug_backtrace();

        // Find the first caller that's not us?
        foreach ($bt as $frame) {
            $func = $frame['function'];
            if (isset($frame['type']) && $frame['type'] == '::') {
                if (in_array($func, $ignoreStatic)) {
                    continue;
                }
                $here = $frame['class'] . '::' . $func;
                break;
            } else if (isset($frame['type']) && $frame['type'] == '->') {
                if ($frame['object'] === $this && in_array($func, $ignore)) {
                    continue;
                }
                if (in_array($func, $ignoreStatic)) {
                    continue; // @fixme this shouldn't be needed?
                }
                $here = get_class($frame['object']) . '->' . $func;
                break;
            }
            $here = $func;
            break;
        }

        if (php_sapi_name() == 'cli') {
            $context = basename($_SERVER['PHP_SELF']);
        } else {
            $context = $_SERVER['REQUEST_METHOD'];
        }

        // Slip the comment in after the first command,
        // or DB_DataObject gets confused about handling inserts and such.
        $parts = explode(' ', $string, 2);
        $parts[0] .= " /* $context $here */";
        return implode(' ', $parts);
    }

440 441 442 443 444 445 446 447 448
    // Sanitize a query for logging
    // @fixme don't trim spaces in string literals
    function sanitizeQuery($string)
    {
        $string = preg_replace('/\s+/', ' ', $string);
        $string = trim($string);
        return $string;
    }

449 450 451 452 453 454
    // We overload so that 'SET NAMES "utf8"' is called for
    // each connection

    function _connect()
    {
        global $_DB_DATAOBJECT;
455 456 457 458 459 460 461 462 463 464

        $sum = $this->_getDbDsnMD5();

        if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
            !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
            $exists = true;
        } else {
            $exists = false;
       }

465 466 467 468 469 470 471 472 473 474 475 476 477 478
        // @fixme horrible evil hack!
        //
        // In multisite configuration we don't want to keep around a separate
        // connection for every database; we could end up with thousands of
        // connections open per thread. In an ideal world we might keep
        // a connection per server and select different databases, but that'd
        // be reliant on having the same db username/pass as well.
        //
        // MySQL connections are cheap enough we're going to try just
        // closing out the old connection and reopening when we encounter
        // a new DSN.
        //
        // WARNING WARNING if we end up actually using multiple DBs at a time
        // we'll need some fancier logic here.
479
        if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
480 481 482 483 484 485 486
            foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
                if (!empty($conn)) {
                    $conn->disconnect();
                }
                unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
            }
        }
487

488
        $result = parent::_connect();
489 490

        if ($result && !$exists) {
491
            $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
492 493 494
            if (common_config('db', 'type') == 'mysql' &&
                common_config('db', 'utf8')) {
                $conn = $DB->connection;
495 496 497 498 499 500
                if (!empty($conn)) {
                    if ($DB instanceof DB_mysqli) {
                        mysqli_set_charset($conn, 'utf8');
                    } else if ($DB instanceof DB_mysql) {
                        mysql_set_charset('utf8', $conn);
                    }
501
                }
502
            }
503 504 505 506
            // Needed to make timestamp values usefully comparable.
            if (common_config('db', 'type') == 'mysql') {
                parent::_query("set time_zone='+0:00'");
            }
507
        }
508

509 510
        return $result;
    }
511

512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
    // XXX: largely cadged from DB_DataObject

    function _getDbDsnMD5()
    {
        if ($this->_database_dsn_md5) {
            return $this->_database_dsn_md5;
        }

        $dsn = $this->_getDbDsn();

        if (is_string($dsn)) {
            $sum = md5($dsn);
        } else {
            /// support array based dsn's
            $sum = md5(serialize($dsn));
        }

        return $sum;
    }

    function _getDbDsn()
    {
        global $_DB_DATAOBJECT;

        if (empty($_DB_DATAOBJECT['CONFIG'])) {
            DB_DataObject::_loadConfig();
        }

        $options = &$_DB_DATAOBJECT['CONFIG'];

        // if the databse dsn dis defined in the object..

        $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;

        if (!$dsn) {

            if (!$this->_database) {
                $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
            }

            if ($this->_database && !empty($options["database_{$this->_database}"]))  {
                $dsn = $options["database_{$this->_database}"];
            } else if (!empty($options['database'])) {
                $dsn = $options['database'];
            }
        }

        if (!$dsn) {
560
            // TRANS: Exception thrown when database name or Data Source Name could not be found.
561
            throw new Exception(_("No database name or DSN found anywhere."));
562 563 564 565
        }

        return $dsn;
    }
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580

    static function blow()
    {
        $c = self::memcache();

        if (empty($c)) {
            return false;
        }

        $args = func_get_args();

        $format = array_shift($args);

        $keyPart = vsprintf($format, $args);

581
        $cacheKey = Cache::key($keyPart);
582 583 584

        return $c->delete($cacheKey);
    }
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600

    function fixupTimestamps()
    {
        // Fake up timestamp columns
        $columns = $this->table();
        foreach ($columns as $name => $type) {
            if ($type & DB_DATAOBJECT_MYSQLTIMESTAMP) {
                $this->$name = common_sql_now();
            }
        }
    }

    function debugDump()
    {
        common_debug("debugDump: " . common_log_objstring($this));
    }
601 602 603

    function raiseError($message, $type = null, $behaviour = null)
    {
604
        $id = get_class($this);
605
        if (!empty($this->id)) {
606 607
            $id .= ':' . $this->id;
        }
608 609 610
        if ($message instanceof PEAR_Error) {
            $message = $message->getMessage();
        }
611
        // Low level exception. No need for i18n as discussed with Brion.
612
        throw new ServerException("[$id] DB_DataObject error [$type]: $message");
613
    }
614 615 616 617 618 619 620 621 622

    static function cacheGet($keyPart)
    {
        $c = self::memcache();

        if (empty($c)) {
            return false;
        }

623
        $cacheKey = Cache::key($keyPart);
624 625 626 627

        return $c->get($cacheKey);
    }

628
    static function cacheSet($keyPart, $value, $flag=null, $expiry=null)
629 630 631 632 633 634 635
    {
        $c = self::memcache();

        if (empty($c)) {
            return false;
        }

636
        $cacheKey = Cache::key($keyPart);
637

638
        return $c->set($cacheKey, $value, $flag, $expiry);
639
    }
640 641 642 643 644 645 646 647 648 649 650 651 652 653

    static function valueString($v)
    {
        $vstr = null;
        if (is_object($v) && $v instanceof DB_DataObject_Cast) {
            switch ($v->type) {
            case 'date':
                $vstr = $v->year . '-' . $v->month . '-' . $v->day;
                break;
            case 'blob':
            case 'string':
            case 'sql':
            case 'datetime':
            case 'time':
654
                // Low level exception. No need for i18n as discussed with Brion.
655 656 657
                throw new ServerException("Unhandled DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
                break;
            default:
658
                // Low level exception. No need for i18n as discussed with Brion.
659 660 661 662 663 664 665 666
                throw new ServerException("Unknown DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
                break;
            }
        } else {
            $vstr = strval($v);
        }
        return $vstr;
    }
667
}