lib/cachingnoticestream.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * A stream of notices
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Stream
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Class for notice streams
  39  *
  40  * @category  Stream
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 class CachingNoticeStream extends NoticeStream
  49 {
  50     const CACHE_WINDOW = 200;
  51
  52     public $stream   = null;
  53     public $cachekey = null;
  54     public $useLast  = true;
  55
  56     function __construct($stream, $cachekey, $useLast = true)
  57     {
  58         $this->stream   = $stream;
  59         $this->cachekey = $cachekey;
  60         $this->useLast  = $useLast;
  61     }
  62
  63     function getNoticeIds($offset, $limit, $sinceId, $maxId)
  64     {
  65         $cache = Cache::instance();
  66
  67         // We cache self::CACHE_WINDOW elements at the tip of the stream.
  68         // If the cache won't be hit, just generate directly.
  69
  70         if (empty($cache) ||
  71             $sinceId != 0 || $maxId != 0 ||
  72             is_null($limit) ||
  73             ($offset + $limit) > self::CACHE_WINDOW) {
  74             return $this->stream->getNoticeIds($offset, $limit, $sinceId, $maxId);
  75         }
  76
  77         // Check the cache to see if we have the stream.
  78
  79         $idkey = Cache::key($this->cachekey);
  80
  81         $idstr = $cache->get($idkey);
  82
  83         if ($idstr !== false) {
  84             // Cache hit! Woohoo!
  85             $window = explode(',', $idstr);
  86             $ids = array_slice($window, $offset, $limit);
  87             return $ids;
  88         }
  89
  90         if ($this->useLast) {
  91             // Check the cache to see if we have a "last-known-good" version.
  92             // The actual cache gets blown away when new notices are added, but
  93             // the "last" value holds a lot of info. We might need to only generate
  94             // a few at the "tip", which can bound our queries and save lots
  95             // of time.
  96
  97             $laststr = $cache->get($idkey.';last');
  98
  99             if ($laststr !== false) {
 100                 $window = explode(',', $laststr);
 101                 $last_id = $window[0];
 102                 $new_ids = $this->stream->getNoticeIds(0, self::CACHE_WINDOW, $last_id, 0);
 103
 104                 $new_window = array_merge($new_ids, $window);
 105
 106                 $new_windowstr = implode(',', $new_window);
 107
 108                 $result = $cache->set($idkey, $new_windowstr);
 109                 $result = $cache->set($idkey . ';last', $new_windowstr);
 110
 111                 $ids = array_slice($new_window, $offset, $limit);
 112
 113                 return $ids;
 114             }
 115         }
 116
 117         // No cache hits :( Generate directly and stick the results
 118         // into the cache. Note we generate the full cache window.
 119
 120         $window = $this->stream->getNoticeIds(0, self::CACHE_WINDOW, 0, 0);
 121
 122         $windowstr = implode(',', $window);
 123
 124         $result = $cache->set($idkey, $windowstr);
 125
 126         if ($this->useLast) {
 127             $result = $cache->set($idkey . ';last', $windowstr);
 128         }
 129
 130         // Return just the slice that was requested
 131
 132         $ids = array_slice($window, $offset, $limit);
 133
 134         return $ids;
 135     }
 136 }