]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - classes/Memcached_DataObject.php
Merge branch '0.9.x' into 1.0.x
[quix0rs-gnu-social.git] / classes / Memcached_DataObject.php
1 <?php
2 /*
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2008, 2009, StatusNet, Inc.
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU Affero General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Affero General Public License for more details.
15  *
16  * You should have received a copy of the GNU Affero General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
21
22 class Memcached_DataObject extends Safe_DataObject
23 {
24     /**
25      * Wrapper for DB_DataObject's static lookup using memcached
26      * as backing instead of an in-process cache array.
27      *
28      * @param string $cls classname of object type to load
29      * @param mixed $k key field name, or value for primary key
30      * @param mixed $v key field value, or leave out for primary key lookup
31      * @return mixed Memcached_DataObject subtype or false
32      */
33     function &staticGet($cls, $k, $v=null)
34     {
35         if (is_null($v)) {
36             $v = $k;
37             # XXX: HACK!
38             $i = new $cls;
39             $keys = $i->keys();
40             $k = $keys[0];
41             unset($i);
42         }
43         $i = Memcached_DataObject::getcached($cls, $k, $v);
44         if ($i === false) { // false == cache miss
45             $i = DB_DataObject::factory($cls);
46             if (empty($i)) {
47                 $i = false;
48                 return $i;
49             }
50             $result = $i->get($k, $v);
51             if ($result) {
52                 // Hit!
53                 $i->encache();
54             } else {
55                 // save the fact that no such row exists
56                 $c = self::memcache();
57                 if (!empty($c)) {
58                     $ck = self::cachekey($cls, $k, $v);
59                     $c->set($ck, null);
60                 }
61                 $i = false;
62             }
63         }
64         return $i;
65     }
66
67     /**
68      * @fixme Should this return false on lookup fail to match staticGet?
69      */
70     function pkeyGet($cls, $kv)
71     {
72         $i = Memcached_DataObject::multicache($cls, $kv);
73         if ($i !== false) { // false == cache miss
74             return $i;
75         } else {
76             $i = DB_DataObject::factory($cls);
77             if (empty($i)) {
78                 return false;
79             }
80             foreach ($kv as $k => $v) {
81                 $i->$k = $v;
82             }
83             if ($i->find(true)) {
84                 $i->encache();
85             } else {
86                 $i = null;
87                 $c = self::memcache();
88                 if (!empty($c)) {
89                     $ck = self::multicacheKey($cls, $kv);
90                     $c->set($ck, null);
91                 }
92             }
93             return $i;
94         }
95     }
96
97     function insert()
98     {
99         $result = parent::insert();
100         if ($result) {
101             $this->fixupTimestamps();
102             $this->encache(); // in case of cached negative lookups
103         }
104         return $result;
105     }
106
107     function update($orig=null)
108     {
109         if (is_object($orig) && $orig instanceof Memcached_DataObject) {
110             $orig->decache(); # might be different keys
111         }
112         $result = parent::update($orig);
113         if ($result) {
114             $this->fixupTimestamps();
115             $this->encache();
116         }
117         return $result;
118     }
119
120     function delete()
121     {
122         $this->decache(); # while we still have the values!
123         return parent::delete();
124     }
125
126     static function memcache() {
127         return Cache::instance();
128     }
129
130     static function cacheKey($cls, $k, $v) {
131         if (is_object($cls) || is_object($k) || (is_object($v) && !($v instanceof DB_DataObject_Cast))) {
132             $e = new Exception();
133             common_log(LOG_ERR, __METHOD__ . ' object in param: ' .
134                 str_replace("\n", " ", $e->getTraceAsString()));
135         }
136         $vstr = self::valueString($v);
137         return Cache::key(strtolower($cls).':'.$k.':'.$vstr);
138     }
139
140     static function getcached($cls, $k, $v) {
141         $c = Memcached_DataObject::memcache();
142         if (!$c) {
143             return false;
144         } else {
145             $obj = $c->get(Memcached_DataObject::cacheKey($cls, $k, $v));
146             if (0 == strcasecmp($cls, 'User')) {
147                 // Special case for User
148                 if (is_object($obj) && is_object($obj->id)) {
149                     common_log(LOG_ERR, "User " . $obj->nickname . " was cached with User as ID; deleting");
150                     $c->delete(Memcached_DataObject::cacheKey($cls, $k, $v));
151                     return false;
152                 }
153             }
154             return $obj;
155         }
156     }
157
158     function keyTypes()
159     {
160         // ini-based classes return number-indexed arrays. handbuilt
161         // classes return column => keytype. Make this uniform.
162
163         $keys = $this->keys();
164
165         $keyskeys = array_keys($keys);
166
167         if (is_string($keyskeys[0])) {
168             return $keys;
169         }
170
171         global $_DB_DATAOBJECT;
172         if (!isset($_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"])) {
173             $this->databaseStructure();
174
175         }
176         return $_DB_DATAOBJECT['INI'][$this->_database][$this->__table."__keys"];
177     }
178
179     function encache()
180     {
181         $c = $this->memcache();
182
183         if (!$c) {
184             return false;
185         } else if ($this->tableName() == 'user' && is_object($this->id)) {
186             // Special case for User bug
187             $e = new Exception();
188             common_log(LOG_ERR, __METHOD__ . ' caching user with User object as ID ' .
189                        str_replace("\n", " ", $e->getTraceAsString()));
190             return false;
191         } else {
192             $keys = $this->_allCacheKeys();
193
194             foreach ($keys as $key) {
195                 $c->set($key, $this);
196             }
197         }
198     }
199
200     function decache()
201     {
202         $c = $this->memcache();
203
204         if (!$c) {
205             return false;
206         }
207
208         $keys = $this->_allCacheKeys();
209
210         foreach ($keys as $key) {
211             $c->delete($key, $this);
212         }
213     }
214
215     function _allCacheKeys()
216     {
217         $ckeys = array();
218
219         $types = $this->keyTypes();
220         ksort($types);
221
222         $pkey = array();
223         $pval = array();
224
225         foreach ($types as $key => $type) {
226
227             assert(!empty($key));
228
229             if ($type == 'U') {
230                 if (empty($this->$key)) {
231                     continue;
232                 }
233                 $ckeys[] = $this->cacheKey($this->tableName(), $key, self::valueString($this->$key));
234             } else if ($type == 'K' || $type == 'N') {
235                 $pkey[] = $key;
236                 $pval[] = self::valueString($this->$key);
237             } else {
238                 // Low level exception. No need for i18n as discussed with Brion.
239                 throw new Exception("Unknown key type $key => $type for " . $this->tableName());
240             }
241         }
242
243         assert(count($pkey) > 0);
244
245         // XXX: should work for both compound and scalar pkeys
246         $pvals = implode(',', $pval);
247         $pkeys = implode(',', $pkey);
248
249         $ckeys[] = $this->cacheKey($this->tableName(), $pkeys, $pvals);
250
251         return $ckeys;
252     }
253
254     function multicache($cls, $kv)
255     {
256         ksort($kv);
257         $c = self::memcache();
258         if (!$c) {
259             return false;
260         } else {
261             return $c->get(self::multicacheKey($cls, $kv));
262         }
263     }
264
265     static function multicacheKey($cls, $kv)
266     {
267         ksort($kv);
268         $pkeys = implode(',', array_keys($kv));
269         $pvals = implode(',', array_values($kv));
270         return self::cacheKey($cls, $pkeys, $pvals);
271     }
272
273     function getSearchEngine($table)
274     {
275         require_once INSTALLDIR.'/lib/search_engines.php';
276         static $search_engine;
277         if (!isset($search_engine)) {
278             if (Event::handle('GetSearchEngine', array($this, $table, &$search_engine))) {
279                 if ('mysql' === common_config('db', 'type')) {
280                     $type = common_config('search', 'type');
281                     if ($type == 'like') {
282                         $search_engine = new MySQLLikeSearch($this, $table);
283                     } else if ($type == 'fulltext') {
284                         $search_engine = new MySQLSearch($this, $table);
285                     } else {
286                         // Low level exception. No need for i18n as discussed with Brion.
287                         throw new ServerException('Unknown search type: ' . $type);
288                     }
289                 } else {
290                     $search_engine = new PGSearch($this, $table);
291                 }
292             }
293         }
294         return $search_engine;
295     }
296
297     static function cachedQuery($cls, $qry, $expiry=3600)
298     {
299         $c = Memcached_DataObject::memcache();
300         if (!$c) {
301             $inst = new $cls();
302             $inst->query($qry);
303             return $inst;
304         }
305         $key_part = Cache::keyize($cls).':'.md5($qry);
306         $ckey = Cache::key($key_part);
307         $stored = $c->get($ckey);
308
309         if ($stored !== false) {
310             return new ArrayWrapper($stored);
311         }
312
313         $inst = new $cls();
314         $inst->query($qry);
315         $cached = array();
316         while ($inst->fetch()) {
317             $cached[] = clone($inst);
318         }
319         $inst->free();
320         $c->set($ckey, $cached, Cache::COMPRESSED, $expiry);
321         return new ArrayWrapper($cached);
322     }
323
324     /**
325      * sends query to database - this is the private one that must work
326      *   - internal functions use this rather than $this->query()
327      *
328      * Overridden to do logging.
329      *
330      * @param  string  $string
331      * @access private
332      * @return mixed none or PEAR_Error
333      */
334     function _query($string)
335     {
336         if (common_config('db', 'annotate_queries')) {
337             $string = $this->annotateQuery($string);
338         }
339
340         $start = microtime(true);
341         $fail = false;
342         try {
343             $result = parent::_query($string);
344         } catch (Exception $e) {
345             $fail = $e;
346         }
347         $delta = microtime(true) - $start;
348
349         $limit = common_config('db', 'log_slow_queries');
350         if (($limit > 0 && $delta >= $limit) || common_config('db', 'log_queries')) {
351             $clean = $this->sanitizeQuery($string);
352             if ($fail) {
353                 $msg = sprintf("FAILED DB query (%0.3fs): %s - %s", $delta, $fail->getMessage(), $clean);
354             } else {
355                 $msg = sprintf("DB query (%0.3fs): %s", $delta, $clean);
356             }
357             common_log(LOG_DEBUG, $msg);
358         }
359
360         if ($fail) {
361             throw $fail;
362         }
363         return $result;
364     }
365
366     /**
367      * Find the first caller in the stack trace that's not a
368      * low-level database function and add a comment to the
369      * query string. This should then be visible in process lists
370      * and slow query logs, to help identify problem areas.
371      *
372      * Also marks whether this was a web GET/POST or which daemon
373      * was running it.
374      *
375      * @param string $string SQL query string
376      * @return string SQL query string, with a comment in it
377      */
378     function annotateQuery($string)
379     {
380         $ignore = array('annotateQuery',
381                         '_query',
382                         'query',
383                         'get',
384                         'insert',
385                         'delete',
386                         'update',
387                         'find');
388         $ignoreStatic = array('staticGet',
389                               'pkeyGet',
390                               'cachedQuery');
391         $here = get_class($this); // if we get confused
392         $bt = debug_backtrace();
393
394         // Find the first caller that's not us?
395         foreach ($bt as $frame) {
396             $func = $frame['function'];
397             if (isset($frame['type']) && $frame['type'] == '::') {
398                 if (in_array($func, $ignoreStatic)) {
399                     continue;
400                 }
401                 $here = $frame['class'] . '::' . $func;
402                 break;
403             } else if (isset($frame['type']) && $frame['type'] == '->') {
404                 if ($frame['object'] === $this && in_array($func, $ignore)) {
405                     continue;
406                 }
407                 if (in_array($func, $ignoreStatic)) {
408                     continue; // @fixme this shouldn't be needed?
409                 }
410                 $here = get_class($frame['object']) . '->' . $func;
411                 break;
412             }
413             $here = $func;
414             break;
415         }
416
417         if (php_sapi_name() == 'cli') {
418             $context = basename($_SERVER['PHP_SELF']);
419         } else {
420             $context = $_SERVER['REQUEST_METHOD'];
421         }
422
423         // Slip the comment in after the first command,
424         // or DB_DataObject gets confused about handling inserts and such.
425         $parts = explode(' ', $string, 2);
426         $parts[0] .= " /* $context $here */";
427         return implode(' ', $parts);
428     }
429
430     // Sanitize a query for logging
431     // @fixme don't trim spaces in string literals
432     function sanitizeQuery($string)
433     {
434         $string = preg_replace('/\s+/', ' ', $string);
435         $string = trim($string);
436         return $string;
437     }
438
439     // We overload so that 'SET NAMES "utf8"' is called for
440     // each connection
441
442     function _connect()
443     {
444         global $_DB_DATAOBJECT;
445
446         $sum = $this->_getDbDsnMD5();
447
448         if (!empty($_DB_DATAOBJECT['CONNECTIONS'][$sum]) &&
449             !PEAR::isError($_DB_DATAOBJECT['CONNECTIONS'][$sum])) {
450             $exists = true;
451         } else {
452             $exists = false;
453        }
454
455         // @fixme horrible evil hack!
456         //
457         // In multisite configuration we don't want to keep around a separate
458         // connection for every database; we could end up with thousands of
459         // connections open per thread. In an ideal world we might keep
460         // a connection per server and select different databases, but that'd
461         // be reliant on having the same db username/pass as well.
462         //
463         // MySQL connections are cheap enough we're going to try just
464         // closing out the old connection and reopening when we encounter
465         // a new DSN.
466         //
467         // WARNING WARNING if we end up actually using multiple DBs at a time
468         // we'll need some fancier logic here.
469         if (!$exists && !empty($_DB_DATAOBJECT['CONNECTIONS']) && php_sapi_name() == 'cli') {
470             foreach ($_DB_DATAOBJECT['CONNECTIONS'] as $index => $conn) {
471                 if (!empty($conn)) {
472                     $conn->disconnect();
473                 }
474                 unset($_DB_DATAOBJECT['CONNECTIONS'][$index]);
475             }
476         }
477
478         $result = parent::_connect();
479
480         if ($result && !$exists) {
481             $DB = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
482             if (common_config('db', 'type') == 'mysql' &&
483                 common_config('db', 'utf8')) {
484                 $conn = $DB->connection;
485                 if (!empty($conn)) {
486                     if ($DB instanceof DB_mysqli) {
487                         mysqli_set_charset($conn, 'utf8');
488                     } else if ($DB instanceof DB_mysql) {
489                         mysql_set_charset('utf8', $conn);
490                     }
491                 }
492             }
493         }
494
495         return $result;
496     }
497
498     // XXX: largely cadged from DB_DataObject
499
500     function _getDbDsnMD5()
501     {
502         if ($this->_database_dsn_md5) {
503             return $this->_database_dsn_md5;
504         }
505
506         $dsn = $this->_getDbDsn();
507
508         if (is_string($dsn)) {
509             $sum = md5($dsn);
510         } else {
511             /// support array based dsn's
512             $sum = md5(serialize($dsn));
513         }
514
515         return $sum;
516     }
517
518     function _getDbDsn()
519     {
520         global $_DB_DATAOBJECT;
521
522         if (empty($_DB_DATAOBJECT['CONFIG'])) {
523             DB_DataObject::_loadConfig();
524         }
525
526         $options = &$_DB_DATAOBJECT['CONFIG'];
527
528         // if the databse dsn dis defined in the object..
529
530         $dsn = isset($this->_database_dsn) ? $this->_database_dsn : null;
531
532         if (!$dsn) {
533
534             if (!$this->_database) {
535                 $this->_database = isset($options["table_{$this->__table}"]) ? $options["table_{$this->__table}"] : null;
536             }
537
538             if ($this->_database && !empty($options["database_{$this->_database}"]))  {
539                 $dsn = $options["database_{$this->_database}"];
540             } else if (!empty($options['database'])) {
541                 $dsn = $options['database'];
542             }
543         }
544
545         if (!$dsn) {
546             // TRANS: Exception thrown when database name or Data Source Name could not be found.
547             throw new Exception(_("No database name or DSN found anywhere."));
548         }
549
550         return $dsn;
551     }
552
553     static function blow()
554     {
555         $c = self::memcache();
556
557         if (empty($c)) {
558             return false;
559         }
560
561         $args = func_get_args();
562
563         $format = array_shift($args);
564
565         $keyPart = vsprintf($format, $args);
566
567         $cacheKey = Cache::key($keyPart);
568
569         return $c->delete($cacheKey);
570     }
571
572     function fixupTimestamps()
573     {
574         // Fake up timestamp columns
575         $columns = $this->table();
576         foreach ($columns as $name => $type) {
577             if ($type & DB_DATAOBJECT_MYSQLTIMESTAMP) {
578                 $this->$name = common_sql_now();
579             }
580         }
581     }
582
583     function debugDump()
584     {
585         common_debug("debugDump: " . common_log_objstring($this));
586     }
587
588     function raiseError($message, $type = null, $behaviour = null)
589     {
590         $id = get_class($this);
591         if (!empty($this->id)) {
592             $id .= ':' . $this->id;
593         }
594         if ($message instanceof PEAR_Error) {
595             $message = $message->getMessage();
596         }
597         // Low level exception. No need for i18n as discussed with Brion.
598         throw new ServerException("[$id] DB_DataObject error [$type]: $message");
599     }
600
601     static function cacheGet($keyPart)
602     {
603         $c = self::memcache();
604
605         if (empty($c)) {
606             return false;
607         }
608
609         $cacheKey = Cache::key($keyPart);
610
611         return $c->get($cacheKey);
612     }
613
614     static function cacheSet($keyPart, $value, $flag=null, $expiry=null)
615     {
616         $c = self::memcache();
617
618         if (empty($c)) {
619             return false;
620         }
621
622         $cacheKey = Cache::key($keyPart);
623
624         return $c->set($cacheKey, $value, $flag, $expiry);
625     }
626
627     static function valueString($v)
628     {
629         $vstr = null;
630         if (is_object($v) && $v instanceof DB_DataObject_Cast) {
631             switch ($v->type) {
632             case 'date':
633                 $vstr = $v->year . '-' . $v->month . '-' . $v->day;
634                 break;
635             case 'blob':
636             case 'string':
637             case 'sql':
638             case 'datetime':
639             case 'time':
640                 // Low level exception. No need for i18n as discussed with Brion.
641                 throw new ServerException("Unhandled DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
642                 break;
643             default:
644                 // Low level exception. No need for i18n as discussed with Brion.
645                 throw new ServerException("Unknown DB_DataObject_Cast type passed as cacheKey value: '$v->type'");
646                 break;
647             }
648         } else {
649             $vstr = strval($v);
650         }
651         return $vstr;
652     }
653 }