lib/noticestream.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 NoticeStream
  49 {
  50     const CACHE_WINDOW = 200;
  51
  52     public $generator = null;
  53     public $args      = null;
  54     public $cachekey  = null;
  55
  56     function __construct($generator, $args, $cachekey)
  57     {
  58         $this->generator = $generator;
  59         $this->args      = $args;
  60         $this->cachekey  = $cachekey;
  61     }
  62
  63     function getNotices($offset=0, $limit=20, $sinceId=0, $maxId=0)
  64     {
  65         $ids = $this->getNoticeIds($offset, $limit, $sinceId, $maxId);
  66
  67         $notices = self::getStreamByIds($ids);
  68
  69         return $notices;
  70     }
  71
  72     function getNoticeIds($offset=0, $limit=20, $sinceId=0, $maxId=0)
  73     {
  74         $cache = Cache::instance();
  75
  76         // We cache self::CACHE_WINDOW elements at the tip of the stream.
  77         // If the cache won't be hit, just generate directly.
  78
  79         if (empty($cache) ||
  80             $sinceId != 0 || $maxId != 0 ||
  81             is_null($limit) ||
  82             ($offset + $limit) > self::CACHE_WINDOW) {
  83             return $this->generate($offset, $limit, $sinceId, $maxId);
  84         }
  85
  86         // Check the cache to see if we have the stream.
  87
  88         $idkey = Cache::key($this->cachekey);
  89
  90         $idstr = $cache->get($idkey);
  91
  92         if ($idstr !== false) {
  93             // Cache hit! Woohoo!
  94             $window = explode(',', $idstr);
  95             $ids = array_slice($window, $offset, $limit);
  96             return $ids;
  97         }
  98
  99         // Check the cache to see if we have a "last-known-good" version.
 100         // The actual cache gets blown away when new notices are added, but
 101         // the "last" value holds a lot of info. We might need to only generate
 102         // a few at the "tip", which can bound our queries and save lots
 103         // of time.
 104
 105         $laststr = $cache->get($idkey.';last');
 106
 107         if ($laststr !== false) {
 108             $window = explode(',', $laststr);
 109             $last_id = $window[0];
 110             $new_ids = $this->generate(0, self::CACHE_WINDOW, $last_id, 0);
 111
 112             $new_window = array_merge($new_ids, $window);
 113
 114             $new_windowstr = implode(',', $new_window);
 115
 116             $result = $cache->set($idkey, $new_windowstr);
 117             $result = $cache->set($idkey . ';last', $new_windowstr);
 118
 119             $ids = array_slice($new_window, $offset, $limit);
 120
 121             return $ids;
 122         }
 123
 124         // No cache hits :( Generate directly and stick the results
 125         // into the cache. Note we generate the full cache window.
 126
 127         $window = $this->generate(0, self::CACHE_WINDOW, 0, 0);
 128
 129         $windowstr = implode(',', $window);
 130
 131         $result = $cache->set($idkey, $windowstr);
 132         $result = $cache->set($idkey . ';last', $windowstr);
 133
 134         // Return just the slice that was requested
 135
 136         $ids = array_slice($window, $offset, $limit);
 137
 138         return $ids;
 139     }
 140
 141     static function getStreamByIds($ids)
 142     {
 143         $cache = Cache::instance();
 144
 145         if (!empty($cache)) {
 146             $notices = array();
 147             foreach ($ids as $id) {
 148                 $n = Notice::staticGet('id', $id);
 149                 if (!empty($n)) {
 150                     $notices[] = $n;
 151                 }
 152             }
 153             return new ArrayWrapper($notices);
 154         } else {
 155             $notice = new Notice();
 156             if (empty($ids)) {
 157                 //if no IDs requested, just return the notice object
 158                 return $notice;
 159             }
 160             $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
 161
 162             $notice->find();
 163
 164             $temp = array();
 165
 166             while ($notice->fetch()) {
 167                 $temp[$notice->id] = clone($notice);
 168             }
 169
 170             $wrapped = array();
 171
 172             foreach ($ids as $id) {
 173                 if (array_key_exists($id, $temp)) {
 174                     $wrapped[] = $temp[$id];
 175                 }
 176             }
 177
 178             return new ArrayWrapper($wrapped);
 179         }
 180     }
 181
 182     function generate($offset, $limit, $sinceId, $maxId)
 183     {
 184         $args = array_merge($this->args, array($offset,
 185                                                $limit,
 186                                                $sinceId,
 187                                                $maxId));
 188
 189         return call_user_func_array($this->generator, $args);
 190     }
 191 }