Memcached_DataObject.php 28.8 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('GNUSOCIAL')) { 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
    static function getClassKV($cls, $k, $v=null)
34
    {
35 36
        if (is_null($v)) {
            $v = $k;
37 38
            $keys = self::pkeyCols($cls);
            if (count($keys) > 1) {
39 40
                // FIXME: maybe call pkeyGetClass() ourselves?
                throw new Exception('Use pkeyGetClass() for compound primary keys');
41
            }
42 43
            $k = $keys[0];
        }
44
        $i = self::getcached($cls, $k, $v);
45
        if ($i === false) { // false == cache miss
46
            $i = new $cls;
47 48
            $result = $i->get($k, $v);
            if ($result) {
49
                // Hit!
50
                $i->encache();
51
            } else {
52 53 54 55 56 57
                // save the fact that no such row exists
                $c = self::memcache();
                if (!empty($c)) {
                    $ck = self::cachekey($cls, $k, $v);
                    $c->set($ck, null);
                }
58
                $i = false;
59 60
            }
        }
61
        return $i;
62
    }
63

64 65
    /**
     * Get multiple items from the database by key
66
     *
67 68 69
     * @param string  $cls       Class to fetch
     * @param string  $keyCol    name of column for key
     * @param array   $keyVals   key values to fetch
70
     *
71 72
     * @return array Array of objects, in order
     */
73
    static function multiGetClass($cls, $keyCol, array $keyVals)
74
    {
75
        $obj = new $cls;
76

77 78
        // php-compatible, for settype(), datatype
        $colType = $obj->columnType($keyCol);
79

80 81 82 83 84 85 86 87 88 89 90 91
        if (!in_array($colType, array('integer', 'int'))) {
            // This is because I'm afraid to escape strings incorrectly
            // in the way we use them below in FIND_IN_SET for MariaDB
            throw new ServerException('Cannot do multiGet on anything but integer columns');
        }

        $obj->whereAddIn($keyCol, $keyVals, $colType);

        // Since we're inputting straight to a query: format and escape
        foreach ($keyVals as $key=>$val) {
            settype($val, $colType);
            $keyVals[$key] = $obj->escape($val);
92 93
        }

94 95 96 97 98
        // FIND_IN_SET will make sure we keep the desired order
        $obj->orderBy(sprintf("FIND_IN_SET(%s, '%s')", $keyCol, implode(',', $keyVals)));
        $obj->find();

        return $obj;
99
    }
100

101 102
    /**
     * Get multiple items from the database by key
103
     *
104 105 106 107
     * @param string  $cls       Class to fetch
     * @param string  $keyCol    name of column for key
     * @param array   $keyVals   key values to fetch
     * @param boolean $otherCols Other columns to hold fixed
108
     *
109 110
     * @return array Array mapping $keyVals to objects, or null if not found
     */
mmn's avatar
mmn committed
111
    static function pivotGetClass($cls, $keyCol, array $keyVals, array $otherCols = array())
112
    {
113 114 115 116 117 118 119
        if (is_array($keyCol)) {
            foreach ($keyVals as $keyVal) {
                $result[implode(',', $keyVal)] = null;
            }
        } else {
            $result = array_fill_keys($keyVals, null);
        }
Siebrand Mazeland's avatar
Siebrand Mazeland committed
120 121 122 123

        $toFetch = array();

        foreach ($keyVals as $keyVal) {
124 125 126 127 128 129 130

            if (is_array($keyCol)) {
                $kv = array_combine($keyCol, $keyVal);
            } else {
                $kv = array($keyCol => $keyVal);
            }

Siebrand Mazeland's avatar
Siebrand Mazeland committed
131 132 133 134 135
            $kv = array_merge($otherCols, $kv);

            $i = self::multicache($cls, $kv);

            if ($i !== false) {
136 137 138 139 140
                if (is_array($keyCol)) {
                    $result[implode(',', $keyVal)] = $i;
                } else {
                    $result[$keyVal] = $i;
                }
Siebrand Mazeland's avatar
Siebrand Mazeland committed
141 142 143 144 145 146
            } else if (!empty($keyVal)) {
                $toFetch[] = $keyVal;
            }
        }

        if (count($toFetch) > 0) {
147
            $i = new $cls;
148 149
            foreach ($otherCols as $otherKeyCol => $otherKeyVal) {
                $i->$otherKeyCol = $otherKeyVal;
150
            }
151 152 153 154 155
            if (is_array($keyCol)) {
                $i->whereAdd(self::_inMultiKey($i, $keyCol, $toFetch));
            } else {
                $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
            }
Siebrand Mazeland's avatar
Siebrand Mazeland committed
156 157 158 159
            if ($i->find()) {
                while ($i->fetch()) {
                    $copy = clone($i);
                    $copy->encache();
160 161 162 163 164 165 166 167 168
                    if (is_array($keyCol)) {
                        $vals = array();
                        foreach ($keyCol as $k) {
                            $vals[] = $i->$k;
                        }
                        $result[implode(',', $vals)] = $copy;
                    } else {
                        $result[$i->$keyCol] = $copy;
                    }
Siebrand Mazeland's avatar
Siebrand Mazeland committed
169 170 171 172 173 174
                }
            }

            // Save state of DB misses

            foreach ($toFetch as $keyVal) {
175 176 177 178 179 180
                $r = null;
                if (is_array($keyCol)) {
                    $r = $result[implode(',', $keyVal)];
                } else {
                    $r = $result[$keyVal];
                }
Siebrand Mazeland's avatar
Siebrand Mazeland committed
181
                if (empty($r)) {
182 183 184 185 186 187
                    if (is_array($keyCol)) {
                        $kv = array_combine($keyCol, $keyVal);
                    } else {
                        $kv = array($keyCol => $keyVal);
                    }
                    $kv = array_merge($otherCols, $kv);
Siebrand Mazeland's avatar
Siebrand Mazeland committed
188 189 190 191 192 193 194 195 196 197 198
                    // save the fact that no such row exists
                    $c = self::memcache();
                    if (!empty($c)) {
                        $ck = self::multicacheKey($cls, $kv);
                        $c->set($ck, null);
                    }
                }
            }
        }

        return $result;
199
    }
200 201 202 203 204 205 206 207 208 209 210 211 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 238 239 240 241 242 243 244 245 246 247 248 249 250

    static function _inMultiKey($i, $cols, $values)
    {
        $types = array();

        foreach ($cols as $col) {
            $types[$col] = $i->columnType($col);
        }

        $first = true;

        $query = '';

        foreach ($values as $value) {
            if ($first) {
                $query .= '( ';
                $first = false;
            } else {
                $query .= ' OR ';
            }
            $query .= '( ';
            $i = 0;
            $firstc = true;
            foreach ($cols as $col) {
                if (!$firstc) {
                    $query .= ' AND ';
                } else {
                    $firstc = false;
                }
                switch ($types[$col]) {
                case 'string':
                case 'datetime':
                    $query .= sprintf("%s = %s", $col, $i->_quote($value[$i]));
                    break;
                default:
                    $query .= sprintf("%s = %s", $col, $value[$i]);
                    break;
                }
            }
            $query .= ') ';
        }

        if (!$first) {
            $query .= ' )';
        }

        return $query;
    }

    static function pkeyCols($cls)
    {
251
        $i = new $cls;
252 253 254 255 256 257 258 259 260 261 262 263 264 265
        $types = $i->keyTypes();
        ksort($types);

        $pkey = array();

        foreach ($types as $key => $type) {
            if ($type == 'K' || $type == 'N') {
                $pkey[] = $key;
            }
        }

        return $pkey;
    }

266 267 268 269 270 271 272 273 274 275 276
    static function listFindClass($cls, $keyCol, array $keyVals)
    {
        $i = new $cls;
        $i->whereAddIn($keyCol, $keyVals, $i->columnType($keyCol));
        if (!$i->find()) {
            throw new NoResultException($i);
        }

        return $i;
    }

277
    static function listGetClass($cls, $keyCol, array $keyVals)
Evan Prodromou's avatar
Evan Prodromou committed
278
    {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
279
        $pkeyMap = array_fill_keys($keyVals, array());
Evan Prodromou's avatar
Evan Prodromou committed
280
        $result = array_fill_keys($keyVals, array());
281 282

        $pkeyCols = self::pkeyCols($cls);
Evan Prodromou's avatar
Evan Prodromou committed
283

Siebrand Mazeland's avatar
Siebrand Mazeland committed
284
        $toFetch = array();
285 286 287 288
        $allPkeys = array();

        // We only cache keys -- not objects!

Siebrand Mazeland's avatar
Siebrand Mazeland committed
289 290 291 292
        foreach ($keyVals as $keyVal) {
            $l = self::cacheGet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal));
            if ($l !== false) {
                $pkeyMap[$keyVal] = $l;
Evan Prodromou's avatar
Evan Prodromou committed
293 294 295
                foreach ($l as $pkey) {
                    $allPkeys[] = $pkey;
                }
Siebrand Mazeland's avatar
Siebrand Mazeland committed
296 297 298 299
            } else {
                $toFetch[] = $keyVal;
            }
        }
300

Evan Prodromou's avatar
Evan Prodromou committed
301
        if (count($allPkeys) > 0) {
mmn's avatar
mmn committed
302
            $keyResults = self::pivotGetClass($cls, $pkeyCols, $allPkeys);
303

Evan Prodromou's avatar
Evan Prodromou committed
304 305 306 307 308 309
            foreach ($pkeyMap as $keyVal => $pkeyList) {
                foreach ($pkeyList as $pkeyVal) {
                    $i = $keyResults[implode(',',$pkeyVal)];
                    if (!empty($i)) {
                        $result[$keyVal][] = $i;
                    }
310 311 312 313
                }
            }
        }

314
        if (count($toFetch) > 0) {
315 316 317
            try {
                $i = self::listFindClass($cls, $keyCol, $toFetch);

318 319 320 321 322 323 324 325 326 327
                while ($i->fetch()) {
                    $copy = clone($i);
                    $copy->encache();
                    $result[$i->$keyCol][] = $copy;
                    $pkeyVal = array();
                    foreach ($pkeyCols as $pkeyCol) {
                        $pkeyVal[] = $i->$pkeyCol;
                    }
                    $pkeyMap[$i->$keyCol][] = $pkeyVal;
                }
328
            } catch (NoResultException $e) {
329
                // no results found for our keyVals, so we leave them as empty arrays
Siebrand Mazeland's avatar
Siebrand Mazeland committed
330 331
            }
            foreach ($toFetch as $keyVal) {
332
                self::cacheSet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal),
333
                               $pkeyMap[$keyVal]);
Siebrand Mazeland's avatar
Siebrand Mazeland committed
334
            }
Evan Prodromou's avatar
Evan Prodromou committed
335
        }
Evan Prodromou's avatar
Evan Prodromou committed
336

Siebrand Mazeland's avatar
Siebrand Mazeland committed
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
        return $result;
    }

    function columnType($columnName)
    {
        $keys = $this->table();
        if (!array_key_exists($columnName, $keys)) {
            throw new Exception('Unknown key column ' . $columnName . ' in ' . join(',', array_keys($keys)));
        }

        $def = $keys[$columnName];

        if ($def & DB_DATAOBJECT_INT) {
            return 'integer';
        } else {
            return 'string';
        }
Evan Prodromou's avatar
Evan Prodromou committed
354
    }
355

356
    /**
357
     * @todo FIXME: Should this return false on lookup fail to match getKV?
358
     */
359
    static function pkeyGetClass($cls, array $kv)
360
    {
361
        $i = self::multicache($cls, $kv);
362
        if ($i !== false) { // false == cache miss
363 364
            return $i;
        } else {
365
            $i = new $cls;
366
            foreach ($kv as $k => $v) {
367 368 369 370 371 372 373
                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;
                }
374 375 376 377
            }
            if ($i->find(true)) {
                $i->encache();
            } else {
Evan Prodromou's avatar
Evan Prodromou committed
378
                $i = null;
379 380 381 382 383
                $c = self::memcache();
                if (!empty($c)) {
                    $ck = self::multicacheKey($cls, $kv);
                    $c->set($ck, null);
                }
384
            }
385
            return $i;
386 387
        }
    }
388

389 390
    function insert()
    {
391
        $result = parent::insert();
392
        if ($result) {
393
            $this->fixupTimestamps();
394 395
            $this->encache(); // in case of cached negative lookups
        }
396 397
        return $result;
    }
398

399
    function update($dataObject=false)
400
    {
401 402
        if (is_object($dataObject) && $dataObject instanceof Memcached_DataObject) {
            $dataObject->decache(); # might be different keys
403
        }
404 405
        $result = parent::update($dataObject);
        if ($result !== false) {
406
            $this->fixupTimestamps();
407 408 409 410
            $this->encache();
        }
        return $result;
    }
411

412
    function delete($useWhere=false)
413
    {
414
        $this->decache(); # while we still have the values!
415
        return parent::delete($useWhere);
416
    }
417

418
    static function memcache() {
419
        return Cache::instance();
420
    }
421

422
    static function cacheKey($cls, $k, $v) {
423
        if (is_object($cls) || is_object($k) || (is_object($v) && !($v instanceof DB_DataObject_Cast))) {
424 425 426 427
            $e = new Exception();
            common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
                str_replace("\n", " ", $e->getTraceAsString()));
        }
428
        $vstr = self::valueString($v);
429
        return Cache::key(strtolower($cls).':'.$k.':'.$vstr);
430
    }
431

432
    static function getcached($cls, $k, $v) {
433
        $c = self::memcache();
434 435 436
        if (!$c) {
            return false;
        } else {
437
            $obj = $c->get(self::cacheKey($cls, $k, $v));
438 439
            if (0 == strcasecmp($cls, 'User')) {
                // Special case for User
440
                if (is_object($obj) && is_object($obj->id)) {
441
                    common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
442
                    $c->delete(self::cacheKey($cls, $k, $v));
443 444 445 446
                    return false;
                }
            }
            return $obj;
447 448
        }
    }
449

450 451
    function keyTypes()
    {
452 453 454 455 456 457 458 459 460 461 462
        // 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;
        }

463
        global $_DB_DATAOBJECT;
464
        if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
465
            $this->databaseStructure();
466 467

        }
468 469
        return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
    }
470

471 472
    function encache()
    {
473
        $c = self::memcache();
474

475 476
        if (!$c) {
            return false;
477 478 479 480 481 482
        } 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;
483
        } else {
484
            $keys = $this->_allCacheKeys();
485

486 487 488
            foreach ($keys as $key) {
                $c->set($key, $this);
            }
489 490
        }
    }
491

492 493
    function decache()
    {
494
        $c = self::memcache();
495

496 497
        if (!$c) {
            return false;
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
        }

        $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;
524
                }
525
                $ckeys[] = self::cacheKey($this->tableName(), $key, self::valueString($this->$key));
526 527
            } else if ($type == 'K' || $type == 'N') {
                $pkey[] = $key;
528
                $pval[] = self::valueString($this->$key);
529
            } else {
530
                // Low level exception. No need for i18n as discussed with Brion.
531
                throw new Exception("Unknown key type $key => $type for " . $this->tableName());
532 533
            }
        }
534 535 536 537 538 539 540

        assert(count($pkey) > 0);

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

541
        $ckeys[] = self::cacheKey($this->tableName(), $pkeys, $pvals);
542 543

        return $ckeys;
544
    }
545

546
    static function multicache($cls, $kv)
547
    {
548
        ksort($kv);
549
        $c = self::memcache();
550 551 552
        if (!$c) {
            return false;
        } else {
553
            return $c->get(self::multicacheKey($cls, $kv));
554 555
        }
    }
millette's avatar
millette committed
556

557 558 559 560 561 562 563 564
    static function multicacheKey($cls, $kv)
    {
        ksort($kv);
        $pkeys = implode(',', array_keys($kv));
        $pvals = implode(',', array_values($kv));
        return self::cacheKey($cls, $pkeys, $pvals);
    }

565 566
    function getSearchEngine($table)
    {
millette's avatar
millette committed
567
        require_once INSTALLDIR.'/lib/search_engines.php';
568 569 570 571 572 573 574 575

        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);
576
                } else {
577 578
                    // Low level exception. No need for i18n as discussed with Brion.
                    throw new ServerException('Unknown search type: ' . $type);
millette's avatar
millette committed
579
                }
580 581
            } else {
                $search_engine = new PGSearch($this, $table);
582
            }
millette's avatar
millette committed
583
        }
584

millette's avatar
millette committed
585 586
        return $search_engine;
    }
587 588 589

    static function cachedQuery($cls, $qry, $expiry=3600)
    {
590
        $c = self::memcache();
591 592 593
        if (!$c) {
            $inst = new $cls();
            $inst->query($qry);
594
            return $inst;
595
        }
596
        $key_part = Cache::keyize($cls).':'.md5($qry);
597
        $ckey = Cache::key($key_part);
598
        $stored = $c->get($ckey);
599 600

        if ($stored !== false) {
601 602 603 604
            return new ArrayWrapper($stored);
        }

        $inst = new $cls();
605
        $inst->query($qry);
606 607 608 609 610
        $cached = array();
        while ($inst->fetch()) {
            $cached[] = clone($inst);
        }
        $inst->free();
611
        $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
612
        return new ArrayWrapper($cached);
613
    }
614

615
    /**
616
     * sends query to database - this is the private one that must work
617 618 619 620 621 622 623 624 625 626
     *   - 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)
    {
627 628 629 630
        if (common_config('db', 'annotate_queries')) {
            $string = $this->annotateQuery($string);
        }

631
        $start = microtime(true);
632
        $fail = false;
Brion Vibber's avatar
Brion Vibber committed
633 634
        $result = null;
        if (Event::handle('StartDBQuery', array($this, $string, &$result))) {
635
            common_perf_counter('query', $string);
Brion Vibber's avatar
Brion Vibber committed
636 637 638 639 640
            try {
                $result = parent::_query($string);
            } catch (Exception $e) {
                $fail = $e;
            }
Brion Vibber's avatar
Brion Vibber committed
641
            Event::handle('EndDBQuery', array($this, $string, &$result));
642
        }
643 644 645 646 647
        $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);
648 649 650 651 652 653 654 655 656 657
            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;
658 659 660 661
        }
        return $result;
    }

662 663 664 665 666
    /**
     * 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.
667
     *
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
     * 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');
684
        $ignoreStatic = array('getKV',
685
                              'getClassKV',
686
                              'pkeyGet',
687
                              'pkeyGetClass',
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
                              '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)) {
706
                    continue; // @todo FIXME: This shouldn't be needed?
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
                }
                $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);
    }

728 729 730 731 732 733 734 735 736
    // 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;
    }

737
    // We overload so that 'SET NAMES "utf8mb4"' is called for
738 739 740 741
    // each connection

    function _connect()
    {
742
        global $_DB_DATAOBJECT, $_PEAR;
743 744 745 746

        $sum = $this->_getDbDsnMD5();

        if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
747
            !$_PEAR->isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
748 749 750 751 752
            $exists = true;
        } else {
            $exists = false;
       }

753 754 755 756 757 758 759 760 761 762 763 764 765 766
        // @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.
767
        if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
768
            foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
769 770 771
                if ($_PEAR->isError($conn)) {
                    common_log(LOG_WARNING, __METHOD__ . " cannot disconnect failed DB connection: '".$conn->getMessage()."'.");
                } elseif (!empty($conn)) {
772 773 774 775 776
                    $conn->disconnect();
                }
                unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
            }
        }
777

778
        $result = parent::_connect();
779 780

        if ($result && !$exists) {
781
            $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
782 783 784
            if (common_config('db', 'type') == 'mysql' &&
                common_config('db', 'utf8')) {
                $conn = $DB->connection;
785
                if (!empty($conn)) {
mmn's avatar
mmn committed
786
                    if ($DB instanceof DB_mysqli || $DB instanceof MDB2_Driver_mysqli) {
787
                        mysqli_set_charset($conn, 'utf8mb4');
mmn's avatar
mmn committed
788
                    } else if ($DB instanceof DB_mysql || $DB instanceof MDB2_Driver_mysql) {
789
                        mysql_set_charset('utf8mb4', $conn);
790
                    }
791
                }
792
            }
793 794 795 796
            // Needed to make timestamp values usefully comparable.
            if (common_config('db', 'type') == 'mysql') {
                parent::_query("set time_zone='+0:00'");
            }
797
        }
798

799 800
        return $result;
    }
801

802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
    // 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) {
850
            // TRANS: Exception thrown when database name or Data Source Name could not be found.
851
            throw new Exception(_('No database name or DSN found anywhere.'));
852 853 854 855
        }

        return $dsn;
    }
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870

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

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

        $args = func_get_args();

        $format = array_shift($args);

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

871
        $cacheKey = Cache::key($keyPart);
872 873 874

        return $c->delete($cacheKey);
    }
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890

    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));
    }
891 892 893

    function raiseError($message, $type = null, $behaviour = null)
    {
894
        $id = get_class($this);
895
        if (!empty($this->id)) {
896 897
            $id .= ':' . $this->id;
        }
898 899 900
        if ($message instanceof PEAR_Error) {
            $message = $message->getMessage();
        }
901
        // Low level exception. No need for i18n as discussed with Brion.
902
        throw new ServerException("[$id] DB_DataObject error [$type]: $message");
903
    }
904 905 906 907 908 909 910 911 912

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

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

913
        $cacheKey = Cache::key($keyPart);
914 915 916 917

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

918
    static function cacheSet($keyPart, $value, $flag=null, $expiry=null)
919 920 921 922 923 924 925
    {
        $c = self::memcache();

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

926
        $cacheKey = Cache::key($keyPart);
927

928
        return $c->set($cacheKey, $value, $flag, $expiry);
929
    }
930 931 932 933 934 935 936 937 938 939 940 941 942 943

    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':
944
                // Low level exception. No need for i18n as discussed with Brion.
945 946 947
                throw new ServerException("Unhandled DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
                break;
            default:
948
                // Low level exception. No need for i18n as discussed with Brion.
949 950 951 952 953 954 955 956
                throw new ServerException("Unknown DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
                break;
            }
        } else {
            $vstr = strval($v);
        }
        return $vstr;
    }
957
}