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

Memcached_DataObject.php 28.2 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
    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 70
     * @param string  $cls       Class to fetch
     * @param string  $keyCol    name of column for key
     * @param array   $keyVals   key values to fetch
     * @param boolean $skipNulls return only non-null results?
71
     *
72 73
     * @return array Array of objects, in order
     */
mattl's avatar
mattl committed
74
    static function multiGetClass($cls, $keyCol, array $keyVals, $skipNulls=true)
75
    {
mattl's avatar
mattl committed
76
        $result = self::pivotGetClass($cls, $keyCol, $keyVals);
77 78 79 80 81 82 83 84 85 86 87 88 89 90

        $values = array_values($result);

        if ($skipNulls) {
            $tmp = array();
            foreach ($values as $value) {
                if (!empty($value)) {
                    $tmp[] = $value;
                }
            }
            $values = $tmp;
        }

        return new ArrayWrapper($values);
91
    }
92

93 94
    /**
     * Get multiple items from the database by key
95
     *
96 97 98 99
     * @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
100
     *
101 102
     * @return array Array mapping $keyVals to objects, or null if not found
     */
mattl's avatar
mattl committed
103
    static function pivotGetClass($cls, $keyCol, array $keyVals, array $otherCols = array())
104
    {
105 106 107 108 109 110 111
        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
112 113 114 115

        $toFetch = array();

        foreach ($keyVals as $keyVal) {
116 117 118 119 120 121 122

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

Siebrand Mazeland's avatar
Siebrand Mazeland committed
123 124 125 126 127
            $kv = array_merge($otherCols, $kv);

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

            if ($i !== false) {
128 129 130 131 132
                if (is_array($keyCol)) {
                    $result[implode(',', $keyVal)] = $i;
                } else {
                    $result[$keyVal] = $i;
                }
Siebrand Mazeland's avatar
Siebrand Mazeland committed
133 134 135 136 137 138
            } else if (!empty($keyVal)) {
                $toFetch[] = $keyVal;
            }
        }

        if (count($toFetch) > 0) {
139
            $i = new $cls;
140 141
            foreach ($otherCols as $otherKeyCol => $otherKeyVal) {
                $i->$otherKeyCol = $otherKeyVal;
142
            }
143 144 145 146 147
            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
148 149 150 151
            if ($i->find()) {
                while ($i->fetch()) {
                    $copy = clone($i);
                    $copy->encache();
152 153 154 155 156 157 158 159 160
                    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
161 162 163 164 165 166
                }
            }

            // Save state of DB misses

            foreach ($toFetch as $keyVal) {
167 168 169 170 171 172
                $r = null;
                if (is_array($keyCol)) {
                    $r = $result[implode(',', $keyVal)];
                } else {
                    $r = $result[$keyVal];
                }
Siebrand Mazeland's avatar
Siebrand Mazeland committed
173
                if (empty($r)) {
174 175 176 177 178 179
                    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
180 181 182 183 184 185 186 187 188 189 190
                    // 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;
191
    }
192 193 194 195 196 197 198 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

    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)
    {
243
        $i = new $cls;
244 245 246 247 248 249 250 251 252 253 254 255 256 257
        $types = $i->keyTypes();
        ksort($types);

        $pkey = array();

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

        return $pkey;
    }

258 259 260 261 262 263 264 265 266 267 268
    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;
    }

269
    static function listGetClass($cls, $keyCol, array $keyVals)
Evan Prodromou's avatar
Evan Prodromou committed
270
    {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
271
        $pkeyMap = array_fill_keys($keyVals, array());
Evan Prodromou's avatar
Evan Prodromou committed
272
        $result = array_fill_keys($keyVals, array());
273 274

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

Siebrand Mazeland's avatar
Siebrand Mazeland committed
276
        $toFetch = array();
277 278 279 280
        $allPkeys = array();

        // We only cache keys -- not objects!

Siebrand Mazeland's avatar
Siebrand Mazeland committed
281 282 283 284
        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
285 286 287
                foreach ($l as $pkey) {
                    $allPkeys[] = $pkey;
                }
Siebrand Mazeland's avatar
Siebrand Mazeland committed
288 289 290 291
            } else {
                $toFetch[] = $keyVal;
            }
        }
292

Evan Prodromou's avatar
Evan Prodromou committed
293
        if (count($allPkeys) > 0) {
mattl's avatar
mattl committed
294
            $keyResults = self::pivotGetClass($cls, $pkeyCols, $allPkeys);
295

Evan Prodromou's avatar
Evan Prodromou committed
296 297 298 299 300 301
            foreach ($pkeyMap as $keyVal => $pkeyList) {
                foreach ($pkeyList as $pkeyVal) {
                    $i = $keyResults[implode(',',$pkeyVal)];
                    if (!empty($i)) {
                        $result[$keyVal][] = $i;
                    }
302 303 304 305
                }
            }
        }

306
        if (count($toFetch) > 0) {
307 308 309
            try {
                $i = self::listFindClass($cls, $keyCol, $toFetch);

310 311 312 313 314 315 316 317 318 319
                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;
                }
320
            } catch (NoResultException $e) {
321
                // no results found for our keyVals, so we leave them as empty arrays
Siebrand Mazeland's avatar
Siebrand Mazeland committed
322 323
            }
            foreach ($toFetch as $keyVal) {
324
                self::cacheSet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal),
325
                               $pkeyMap[$keyVal]);
Siebrand Mazeland's avatar
Siebrand Mazeland committed
326
            }
Evan Prodromou's avatar
Evan Prodromou committed
327
        }
Evan Prodromou's avatar
Evan Prodromou committed
328

Siebrand Mazeland's avatar
Siebrand Mazeland committed
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
        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
346
    }
347

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

381 382
    function insert()
    {
383
        $result = parent::insert();
384
        if ($result) {
385
            $this->fixupTimestamps();
386 387
            $this->encache(); // in case of cached negative lookups
        }
388 389
        return $result;
    }
390

391 392
    function update($orig=null)
    {
393 394 395 396 397
        if (is_object($orig) && $orig instanceof Memcached_DataObject) {
            $orig->decache(); # might be different keys
        }
        $result = parent::update($orig);
        if ($result) {
398
            $this->fixupTimestamps();
399 400 401 402
            $this->encache();
        }
        return $result;
    }
403

404 405
    function delete()
    {
406 407 408
        $this->decache(); # while we still have the values!
        return parent::delete();
    }
409

410
    static function memcache() {
411
        return Cache::instance();
412
    }
413

414
    static function cacheKey($cls, $k, $v) {
415
        if (is_object($cls) || is_object($k) || (is_object($v) && !($v instanceof DB_DataObject_Cast))) {
416 417 418 419
            $e = new Exception();
            common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
                str_replace("\n", " ", $e->getTraceAsString()));
        }
420
        $vstr = self::valueString($v);
421
        return Cache::key(strtolower($cls).':'.$k.':'.$vstr);
422
    }
423

424
    static function getcached($cls, $k, $v) {
425
        $c = Memcached_DataObject::memcache();
426 427 428
        if (!$c) {
            return false;
        } else {
429 430 431
            $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
            if (0 == strcasecmp($cls, 'User')) {
                // Special case for User
432
                if (is_object($obj) && is_object($obj->id)) {
433 434 435 436 437 438
                    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;
439 440
        }
    }
441

442 443
    function keyTypes()
    {
444 445 446 447 448 449 450 451 452 453 454
        // 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;
        }

455
        global $_DB_DATAOBJECT;
456
        if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
457
            $this->databaseStructure();
458 459

        }
460 461
        return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
    }
462

463 464
    function encache()
    {
465
        $c = $this->memcache();
466

467 468
        if (!$c) {
            return false;
469 470 471 472 473 474
        } 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;
475
        } else {
476
            $keys = $this->_allCacheKeys();
477

478 479 480
            foreach ($keys as $key) {
                $c->set($key, $this);
            }
481 482
        }
    }
483

484 485
    function decache()
    {
486
        $c = $this->memcache();
487

488 489
        if (!$c) {
            return false;
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
        }

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

        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;
536
    }
537

538
    static function multicache($cls, $kv)
539
    {
540
        ksort($kv);
541
        $c = self::memcache();
542 543 544
        if (!$c) {
            return false;
        } else {
545
            return $c->get(self::multicacheKey($cls, $kv));
546 547
        }
    }
millette's avatar
millette committed
548

549 550 551 552 553 554 555 556
    static function multicacheKey($cls, $kv)
    {
        ksort($kv);
        $pkeys = implode(',', array_keys($kv));
        $pvals = implode(',', array_values($kv));
        return self::cacheKey($cls, $pkeys, $pvals);
    }

557 558
    function getSearchEngine($table)
    {
millette's avatar
millette committed
559
        require_once INSTALLDIR.'/lib/search_engines.php';
560 561 562 563 564 565 566 567

        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);
568
                } else {
569 570
                    // Low level exception. No need for i18n as discussed with Brion.
                    throw new ServerException('Unknown search type: ' . $type);
millette's avatar
millette committed
571
                }
572 573
            } else {
                $search_engine = new PGSearch($this, $table);
574
            }
millette's avatar
millette committed
575
        }
576

millette's avatar
millette committed
577 578
        return $search_engine;
    }
579 580 581

    static function cachedQuery($cls, $qry, $expiry=3600)
    {
582
        $c = Memcached_DataObject::memcache();
583 584 585
        if (!$c) {
            $inst = new $cls();
            $inst->query($qry);
586
            return $inst;
587
        }
588
        $key_part = Cache::keyize($cls).':'.md5($qry);
589
        $ckey = Cache::key($key_part);
590
        $stored = $c->get($ckey);
591 592

        if ($stored !== false) {
593 594 595 596
            return new ArrayWrapper($stored);
        }

        $inst = new $cls();
597
        $inst->query($qry);
598 599 600 601 602
        $cached = array();
        while ($inst->fetch()) {
            $cached[] = clone($inst);
        }
        $inst->free();
603
        $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
604
        return new ArrayWrapper($cached);
605
    }
606

607
    /**
608
     * sends query to database - this is the private one that must work
609 610 611 612 613 614 615 616 617 618
     *   - 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)
    {
619 620 621 622
        if (common_config('db', 'annotate_queries')) {
            $string = $this->annotateQuery($string);
        }

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

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

720 721 722 723 724 725 726 727 728
    // 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;
    }

729 730 731 732 733
    // We overload so that 'SET NAMES "utf8"' is called for
    // each connection

    function _connect()
    {
734
        global $_DB_DATAOBJECT, $_PEAR;
735 736 737 738

        $sum = $this->_getDbDsnMD5();

        if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
739
            !$_PEAR->isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
740 741 742 743 744
            $exists = true;
        } else {
            $exists = false;
       }

745 746 747 748 749 750 751 752 753 754 755 756 757 758
        // @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.
759
        if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
760 761 762 763 764 765 766
            foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
                if (!empty($conn)) {
                    $conn->disconnect();
                }
                unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
            }
        }
767

768
        $result = parent::_connect();
769 770

        if ($result && !$exists) {
771
            $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
772 773 774
            if (common_config('db', 'type') == 'mysql' &&
                common_config('db', 'utf8')) {
                $conn = $DB->connection;
775 776 777 778 779 780
                if (!empty($conn)) {
                    if ($DB instanceof DB_mysqli) {
                        mysqli_set_charset($conn, 'utf8');
                    } else if ($DB instanceof DB_mysql) {
                        mysql_set_charset('utf8', $conn);
                    }
781
                }
782
            }
783 784 785 786
            // Needed to make timestamp values usefully comparable.
            if (common_config('db', 'type') == 'mysql') {
                parent::_query("set time_zone='+0:00'");
            }
787
        }
788

789 790
        return $result;
    }
791

792 793 794 795 796 797 798 799 800 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
    // 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) {
840
            // TRANS: Exception thrown when database name or Data Source Name could not be found.
841
            throw new Exception(_('No database name or DSN found anywhere.'));
842 843 844 845
        }

        return $dsn;
    }
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860

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

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

        $args = func_get_args();

        $format = array_shift($args);

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

861
        $cacheKey = Cache::key($keyPart);
862 863 864

        return $c->delete($cacheKey);
    }
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880

    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));
    }
881 882 883

    function raiseError($message, $type = null, $behaviour = null)
    {
884
        $id = get_class($this);
885
        if (!empty($this->id)) {
886 887
            $id .= ':' . $this->id;
        }
888 889 890
        if ($message instanceof PEAR_Error) {
            $message = $message->getMessage();
        }
891
        // Low level exception. No need for i18n as discussed with Brion.
892
        throw new ServerException("[$id] DB_DataObject error [$type]: $message");
893
    }
894 895 896 897 898 899 900 901 902

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

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

903
        $cacheKey = Cache::key($keyPart);
904 905 906 907

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

908
    static function cacheSet($keyPart, $value, $flag=null, $expiry=null)
909 910 911 912 913 914 915
    {
        $c = self::memcache();

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

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

918
        return $c->set($cacheKey, $value, $flag, $expiry);
919
    }
920 921 922 923 924 925 926 927 928 929 930 931 932 933

    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':
934
                // Low level exception. No need for i18n as discussed with Brion.
935 936 937
                throw new ServerException("Unhandled DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
                break;
            default:
938
                // Low level exception. No need for i18n as discussed with Brion.
939 940 941 942 943 944 945 946
                throw new ServerException("Unknown DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
                break;
            }
        } else {
            $vstr = strval($v);
        }
        return $vstr;
    }
947
}