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

Memcached_DataObject.php 23.9 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 71 72 73 74 75 76 77
    /**
     * Get multiple items from the database by key
     * 
     * @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?
     * 
     * @return array Array of objects, in order
     */
    function multiGet($cls, $keyCol, $keyVals, $skipNulls=true)
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
    {
    	$result = self::pivotGet($cls, $keyCol, $keyVals);
    	
    	$values = array_values($result);
    	
    	if ($skipNulls) {
    		$tmp = array();
    		foreach ($values as $value) {
    			if (!empty($value)) {
    				$tmp[] = $value;
    			}
    		}
    		$values = $tmp;
    	}
    	
    	return new ArrayWrapper($values);
    }
    
    /**
     * Get multiple items from the database by key
     * 
     * @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
     * 
     * @return array Array mapping $keyVals to objects, or null if not found
     */
    static function pivotGet($cls, $keyCol, $keyVals, $otherCols = array())
107 108 109 110 111 112
    {
    	$result = array_fill_keys($keyVals, null);
    	
    	$toFetch = array();
    	
    	foreach ($keyVals as $keyVal) {
113 114 115 116 117
    		
    		$kv = array_merge($otherCols, array($keyCol => $keyVal));
    		
        	$i = self::multicache($cls, $kv);
        	
118 119 120 121 122 123 124 125 126 127 128
        	if ($i !== false) {
        		$result[$keyVal] = $i;
        	} else if (!empty($keyVal)) {
        		$toFetch[] = $keyVal;
        	}
    	}
    	
    	if (count($toFetch) > 0) {
            $i = DB_DataObject::factory($cls);
            if (empty($i)) {
            	throw new Exception(_('Cannot instantiate class ' . $cls));
129 130 131
            }
            foreach ($otherCols as $otherKeyCol => $otherKeyVal) {
                $i->$otherKeyCol = $otherKeyVal;
132 133 134 135 136 137 138 139 140
            }
    		$i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
    		if ($i->find()) {
    			while ($i->fetch()) {
    				$copy = clone($i);
    				$copy->encache();
    				$result[$i->$keyCol] = $copy;
    			}
    		}
141 142 143 144 145
    		
    		// Save state of DB misses
    		
    		foreach ($toFetch as $keyVal) {
    			if (empty($result[$keyVal])) {
146
    				$kv = array_merge($otherCols, array($keyCol => $keyVal));
147 148 149
                	// save the fact that no such row exists
                	$c = self::memcache();
                	if (!empty($c)) {
150
                    	$ck = self::multicacheKey($cls, $kv);
151 152 153 154 155 156
                    	$c->set($ck, null);
                	}	
    			}
    		}
    	}
    	
157
    	return $result;
158
    }
Evan Prodromou's avatar
Evan Prodromou committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
    
    function listGet($cls, $keyCol, $keyVals)
    {
    	$result = array_fill_keys($keyVals, array());
    	
    	$toFetch = array();
    	
    	foreach ($keyVals as $keyVal) {
    	    $l = self::cacheGet(sprintf("%s:list:%s:%s", $cls, $keyCol, $keyVal));
    	    if ($l !== false) {
    	        $result[$keyVal] = $l;
    	    } else {
    	        $toFetch[] = $keyVal;
    	    }
    	}
        	
        $i = DB_DataObject::factory($cls);
        if (empty($i)) {
        	throw new Exception(_('Cannot instantiate class ' . $cls));
        }
		$i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
		if ($i->find()) {
			while ($i->fetch()) {
				$copy = clone($i);
				$copy->encache();
				$result[$i->$keyCol][] = $copy;
			}
		}        
    	
    	foreach ($toFetch as $keyVal)
    	{
    		self::cacheSet(sprintf("%s:list:%s:%s", $cls, $keyCol, $keyVal),
    					   $result[$keyVal]);   
    	}
    	
    	return $result;        
    }
196

197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
	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';
		}
	}
	
213 214 215 216
    /**
     * @fixme Should this return false on lookup fail to match staticGet?
     */
    function pkeyGet($cls, $kv)
217
    {
218
        $i = Memcached_DataObject::multicache($cls, $kv);
219
        if ($i !== false) { // false == cache miss
220 221
            return $i;
        } else {
222
            $i = DB_DataObject::factory($cls);
223
            if (empty($i) || PEAR::isError($i)) {
224 225
                return false;
            }
226
            foreach ($kv as $k => $v) {
227 228 229 230 231 232 233
            	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;
            	}
234 235 236 237
            }
            if ($i->find(true)) {
                $i->encache();
            } else {
Evan Prodromou's avatar
Evan Prodromou committed
238
                $i = null;
239 240 241 242 243
                $c = self::memcache();
                if (!empty($c)) {
                    $ck = self::multicacheKey($cls, $kv);
                    $c->set($ck, null);
                }
244
            }
245
            return $i;
246 247
        }
    }
248

249 250
    function insert()
    {
251
        $result = parent::insert();
252
        if ($result) {
253
            $this->fixupTimestamps();
254 255
            $this->encache(); // in case of cached negative lookups
        }
256 257
        return $result;
    }
258

259 260
    function update($orig=null)
    {
261 262 263 264 265
        if (is_object($orig) && $orig instanceof Memcached_DataObject) {
            $orig->decache(); # might be different keys
        }
        $result = parent::update($orig);
        if ($result) {
266
            $this->fixupTimestamps();
267 268 269 270
            $this->encache();
        }
        return $result;
    }
271

272 273
    function delete()
    {
274 275 276
        $this->decache(); # while we still have the values!
        return parent::delete();
    }
277

278
    static function memcache() {
279
        return Cache::instance();
280
    }
281

282
    static function cacheKey($cls, $k, $v) {
283
        if (is_object($cls) || is_object($k) || (is_object($v) && !($v instanceof DB_DataObject_Cast))) {
284 285 286 287
            $e = new Exception();
            common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
                str_replace("\n", " ", $e->getTraceAsString()));
        }
288
        $vstr = self::valueString($v);
289
        return Cache::key(strtolower($cls).':'.$k.':'.$vstr);
290
    }
291

292
    static function getcached($cls, $k, $v) {
293
        $c = Memcached_DataObject::memcache();
294 295 296
        if (!$c) {
            return false;
        } else {
297 298 299
            $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
            if (0 == strcasecmp($cls, 'User')) {
                // Special case for User
300
                if (is_object($obj) && is_object($obj->id)) {
301 302 303 304 305 306
                    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;
307 308
        }
    }
309

310 311
    function keyTypes()
    {
312 313 314 315 316 317 318 319 320 321 322
        // 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;
        }

323
        global $_DB_DATAOBJECT;
324
        if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
325
            $this->databaseStructure();
326 327

        }
328 329
        return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
    }
330

331 332
    function encache()
    {
333
        $c = $this->memcache();
334

335 336
        if (!$c) {
            return false;
337 338 339 340 341 342
        } 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;
343
        } else {
344
            $keys = $this->_allCacheKeys();
345

346 347 348
            foreach ($keys as $key) {
                $c->set($key, $this);
            }
349 350
        }
    }
351

352 353
    function decache()
    {
354
        $c = $this->memcache();
355

356 357
        if (!$c) {
            return false;
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
        }

        $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;
384
                }
385
                $ckeys[] = $this->cacheKey($this->tableName(), $key, self::valueString($this->$key));
386 387
            } else if ($type == 'K' || $type == 'N') {
                $pkey[] = $key;
388
                $pval[] = self::valueString($this->$key);
389
            } else {
390
                // Low level exception. No need for i18n as discussed with Brion.
391
                throw new Exception("Unknown key type $key => $type for " . $this->tableName());
392 393
            }
        }
394 395 396 397 398 399 400 401 402 403

        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;
404
    }
405

406 407
    function multicache($cls, $kv)
    {
408
        ksort($kv);
409
        $c = self::memcache();
410 411 412
        if (!$c) {
            return false;
        } else {
413
            return $c->get(self::multicacheKey($cls, $kv));
414 415
        }
    }
millette's avatar
millette committed
416

417 418 419 420 421 422 423 424
    static function multicacheKey($cls, $kv)
    {
        ksort($kv);
        $pkeys = implode(',', array_keys($kv));
        $pvals = implode(',', array_values($kv));
        return self::cacheKey($cls, $pkeys, $pvals);
    }

425 426
    function getSearchEngine($table)
    {
millette's avatar
millette committed
427
        require_once INSTALLDIR.'/lib/search_engines.php';
428 429 430 431 432 433 434 435

        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);
436
                } else {
437 438
                    // Low level exception. No need for i18n as discussed with Brion.
                    throw new ServerException('Unknown search type: ' . $type);
millette's avatar
millette committed
439
                }
440 441
            } else {
                $search_engine = new PGSearch($this, $table);
442
            }
millette's avatar
millette committed
443
        }
444

millette's avatar
millette committed
445 446
        return $search_engine;
    }
447 448 449

    static function cachedQuery($cls, $qry, $expiry=3600)
    {
450
        $c = Memcached_DataObject::memcache();
451 452 453
        if (!$c) {
            $inst = new $cls();
            $inst->query($qry);
454
            return $inst;
455
        }
456
        $key_part = Cache::keyize($cls).':'.md5($qry);
457
        $ckey = Cache::key($key_part);
458
        $stored = $c->get($ckey);
459 460

        if ($stored !== false) {
461 462 463 464
            return new ArrayWrapper($stored);
        }

        $inst = new $cls();
465
        $inst->query($qry);
466 467 468 469 470
        $cached = array();
        while ($inst->fetch()) {
            $cached[] = clone($inst);
        }
        $inst->free();
471
        $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
472
        return new ArrayWrapper($cached);
473
    }
474

475
    /**
476
     * sends query to database - this is the private one that must work
477 478 479 480 481 482 483 484 485 486
     *   - 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)
    {
487 488 489 490
        if (common_config('db', 'annotate_queries')) {
            $string = $this->annotateQuery($string);
        }

491
        $start = microtime(true);
492
        $fail = false;
Brion Vibber's avatar
Brion Vibber committed
493 494
        $result = null;
        if (Event::handle('StartDBQuery', array($this, $string, &$result))) {
495
            common_perf_counter('query', $string);
Brion Vibber's avatar
Brion Vibber committed
496 497 498 499 500
            try {
                $result = parent::_query($string);
            } catch (Exception $e) {
                $fail = $e;
            }
Brion Vibber's avatar
Brion Vibber committed
501
            Event::handle('EndDBQuery', array($this, $string, &$result));
502
        }
503 504 505 506 507
        $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);
508 509 510 511 512 513 514 515 516 517
            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;
518 519 520 521
        }
        return $result;
    }

522 523 524 525 526
    /**
     * 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.
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 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
     * 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);
    }

586 587 588 589 590 591 592 593 594
    // 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;
    }

595 596 597 598 599 600
    // We overload so that 'SET NAMES "utf8"' is called for
    // each connection

    function _connect()
    {
        global $_DB_DATAOBJECT;
601 602 603 604 605 606 607 608 609 610

        $sum = $this->_getDbDsnMD5();

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

611 612 613 614 615 616 617 618 619 620 621 622 623 624
        // @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.
625
        if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
626 627 628 629 630 631 632
            foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
                if (!empty($conn)) {
                    $conn->disconnect();
                }
                unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
            }
        }
633

634
        $result = parent::_connect();
635 636

        if ($result && !$exists) {
637
            $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
638 639 640
            if (common_config('db', 'type') == 'mysql' &&
                common_config('db', 'utf8')) {
                $conn = $DB->connection;
641 642 643 644 645 646
                if (!empty($conn)) {
                    if ($DB instanceof DB_mysqli) {
                        mysqli_set_charset($conn, 'utf8');
                    } else if ($DB instanceof DB_mysql) {
                        mysql_set_charset('utf8', $conn);
                    }
647
                }
648
            }
649 650 651 652
            // Needed to make timestamp values usefully comparable.
            if (common_config('db', 'type') == 'mysql') {
                parent::_query("set time_zone='+0:00'");
            }
653
        }
654

655 656
        return $result;
    }
657

658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
    // 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) {
706
            // TRANS: Exception thrown when database name or Data Source Name could not be found.
707
            throw new Exception(_("No database name or DSN found anywhere."));
708 709 710 711
        }

        return $dsn;
    }
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726

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

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

        $args = func_get_args();

        $format = array_shift($args);

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

727
        $cacheKey = Cache::key($keyPart);
728 729 730

        return $c->delete($cacheKey);
    }
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746

    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));
    }
747 748 749

    function raiseError($message, $type = null, $behaviour = null)
    {
750
        $id = get_class($this);
751
        if (!empty($this->id)) {
752 753
            $id .= ':' . $this->id;
        }
754 755 756
        if ($message instanceof PEAR_Error) {
            $message = $message->getMessage();
        }
757
        // Low level exception. No need for i18n as discussed with Brion.
758
        throw new ServerException("[$id] DB_DataObject error [$type]: $message");
759
    }
760 761 762 763 764 765 766 767 768

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

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

769
        $cacheKey = Cache::key($keyPart);
770 771 772 773

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

774
    static function cacheSet($keyPart, $value, $flag=null, $expiry=null)
775 776 777 778 779 780 781
    {
        $c = self::memcache();

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

782
        $cacheKey = Cache::key($keyPart);
783

784
        return $c->set($cacheKey, $value, $flag, $expiry);
785
    }
786 787 788 789 790 791 792 793 794 795 796 797 798 799

    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':
800
                // Low level exception. No need for i18n as discussed with Brion.
801 802 803
                throw new ServerException("Unhandled DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
                break;
            default:
804
                // Low level exception. No need for i18n as discussed with Brion.
805 806 807 808 809 810 811 812
                throw new ServerException("Unknown DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
                break;
            }
        } else {
            $vstr = strval($v);
        }
        return $vstr;
    }
813
}