classes/Inbox.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Data class for user location preferences
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Data
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2009 StatusNet Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
  31
  32 class Inbox extends Memcached_DataObject
  33 {
  34     const BOXCAR = 128;
  35     const MAX_NOTICES = 1024;
  36
  37     ###START_AUTOCODE
  38     /* the code below is auto generated do not remove the above tag */
  39
  40     public $__table = 'inbox';                           // table name
  41     public $user_id;                         // int(4)  primary_key not_null
  42     public $notice_ids;                      // blob
  43
  44     /* Static get */
  45     function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('Inbox',$k,$v); }
  46
  47     /* the code above is auto generated do not remove the tag below */
  48     ###END_AUTOCODE
  49
  50     function sequenceKey()
  51     {
  52         return array(false, false, false);
  53     }
  54
  55     /**
  56      * Create a new inbox from existing Notice_inbox stuff
  57      */
  58     static function initialize($user_id)
  59     {
  60         $inbox = Inbox::fromNoticeInbox($user_id);
  61
  62         unset($inbox->fake);
  63
  64         $result = $inbox->insert();
  65
  66         if (!$result) {
  67             common_log_db_error($inbox, 'INSERT', __FILE__);
  68             return null;
  69         }
  70
  71         return $inbox;
  72     }
  73
  74     static function fromNoticeInbox($user_id)
  75     {
  76         $ids = array();
  77
  78         $ni = new Notice_inbox();
  79
  80         $ni->user_id = $user_id;
  81         $ni->selectAdd();
  82         $ni->selectAdd('notice_id');
  83         $ni->orderBy('notice_id DESC');
  84         $ni->limit(0, self::MAX_NOTICES);
  85
  86         if ($ni->find()) {
  87             while($ni->fetch()) {
  88                 $ids[] = $ni->notice_id;
  89             }
  90         }
  91
  92         $ni->free();
  93         unset($ni);
  94
  95         $inbox = new Inbox();
  96
  97         $inbox->user_id = $user_id;
  98         $inbox->pack($ids);
  99         $inbox->fake = true;
 100
 101         return $inbox;
 102     }
 103
 104     /**
 105      * Append the given notice to the given user's inbox.
 106      * Caching updates are managed for the inbox itself.
 107      *
 108      * If the notice is already in this inbox, the second
 109      * add will be silently dropped.
 110      *
 111      * @param int @user_id
 112      * @param int $notice_id
 113      * @return boolean success
 114      */
 115     static function insertNotice($user_id, $notice_id)
 116     {
 117         // Going straight to the DB rather than trusting our caching
 118         // during an update. Note: not using DB_DataObject::staticGet,
 119         // which is unsafe to use directly (in-process caching causes
 120         // memory leaks, which accumulate in queue processes).
 121         $inbox = new Inbox();
 122         if (!$inbox->get('user_id', $user_id)) {
 123             $inbox = Inbox::initialize($user_id);
 124         }
 125
 126         if (empty($inbox)) {
 127             return false;
 128         }
 129
 130         $ids = $inbox->unpack();
 131         if (in_array(intval($notice_id), $ids)) {
 132             // Already in there, we probably re-ran some inbox adds
 133             // due to an error. Skip the dupe silently.
 134             return true;
 135         }
 136
 137         $result = $inbox->query(sprintf('UPDATE inbox '.
 138                                         'set notice_ids = concat(cast(0x%08x as binary(4)), '.
 139                                         'substr(notice_ids, 1, %d)) '.
 140                                         'WHERE user_id = %d',
 141                                         $notice_id,
 142                                         4 * (self::MAX_NOTICES - 1),
 143                                         $user_id));
 144
 145         if ($result) {
 146             self::blow('inbox:user_id:%d', $user_id);
 147         }
 148
 149         return $result;
 150     }
 151
 152     static function bulkInsert($notice_id, $user_ids)
 153     {
 154         foreach ($user_ids as $user_id)
 155         {
 156             Inbox::insertNotice($user_id, $notice_id);
 157         }
 158     }
 159
 160     function stream($user_id, $offset, $limit, $since_id, $max_id, $own=false)
 161     {
 162         $inbox = Inbox::staticGet('user_id', $user_id);
 163
 164         if (empty($inbox)) {
 165             $inbox = Inbox::fromNoticeInbox($user_id);
 166             if (empty($inbox)) {
 167                 return array();
 168             } else {
 169                 $inbox->encache();
 170             }
 171         }
 172
 173         $ids = $inbox->unpack();
 174
 175         if (!empty($since_id)) {
 176             $newids = array();
 177             foreach ($ids as $id) {
 178                 if ($id > $since_id) {
 179                     $newids[] = $id;
 180                 }
 181             }
 182             $ids = $newids;
 183         }
 184
 185         if (!empty($max_id)) {
 186             $newids = array();
 187             foreach ($ids as $id) {
 188                 if ($id <= $max_id) {
 189                     $newids[] = $id;
 190                 }
 191             }
 192             $ids = $newids;
 193         }
 194
 195         $ids = array_slice($ids, $offset, $limit);
 196
 197         return $ids;
 198     }
 199
 200     /**
 201      * Wrapper for Inbox::stream() and Notice::getStreamByIds() returning
 202      * additional items up to the limit if we were short due to deleted
 203      * notices still being listed in the inbox.
 204      *
 205      * This is meant to assist threaded views, and optimizes paging for
 206      * threadness. Not ideal for very late pages, as we have to bump about
 207      * through all previous items.
 208      *
 209      * Should avoid duplicates in paging, though.
 210      *
 211      * @param int $user_id
 212      * @param int $offset skip past the most recent N notices (after since_id checks)
 213      * @param int $limit
 214      * @param mixed $since_id return only notices after but not including this id
 215      * @param mixed $max_id return only notices up to and including this id
 216      * @param mixed $own ignored?
 217      * @return array of Notice objects
 218      *
 219      * @todo consider repacking the inbox when this happens?
 220      * @fixme reimplement $own if we need it?
 221      */
 222     function streamNoticesThreaded($user_id, $offset, $limit, $since_id, $max_id, $own=false)
 223     {
 224         // So what we want is:
 225         // * slurp in the beginning of the notice list
 226         // * filter out deleted notices
 227         // * replace any reply notices with their conversation roots
 228         // * filter out any duplicate conversations
 229         // * return $limit notices after skipping $offset from the most recent
 230
 231         $ids = self::stream($user_id, 0, self::MAX_NOTICES, $since_id, $max_id, $own);
 232
 233         // Do a bulk lookup for the first $limit items
 234         // Fast path when nothing's deleted.
 235         $firstChunk = array_slice($ids, 0, $offset + $limit);
 236         $notices = Notice::getStreamByIds($firstChunk);
 237
 238         assert($notices instanceof ArrayWrapper);
 239         $items = $notices->_items;
 240
 241         // Extract the latest non-deleted item in each convo
 242         $noticeByConvo = array();
 243         foreach ($items as $notice) {
 244             if (empty($noticeByConvo[$notice->conversation])) {
 245                 $noticeByConvo[$notice->conversation] = $notice;
 246             }
 247         }
 248
 249         $wanted = count($firstChunk); // raw entry count in the inbox up to our $limit
 250         // There were deleted notices, we'll need to look for more.
 251         $remainder = array_slice($ids, $limit);
 252
 253         for ($i = $offset + $limit; count($noticeByConvo) < $wanted && $i < count($ids); $i++) {
 254             $notice = Notice::staticGet($ids[$i]);
 255             if ($notice && empty($noticeByConvo[$notice->conversation])) {
 256                 $noticeByConvo[$notice->conversation] = $notice;
 257             }
 258         }
 259
 260         $slice = array_slice($noticeByConvo, $offset, $limit, false);
 261         return new ArrayWrapper($slice);
 262     }
 263
 264     /**
 265      * Wrapper for Inbox::stream() and Notice::getStreamByIds() returning
 266      * additional items up to the limit if we were short due to deleted
 267      * notices still being listed in the inbox.
 268      *
 269      * The fast path (when no items are deleted) should be just as fast; the
 270      * offset parameter is applied *before* lookups for maximum efficiency.
 271      *
 272      * This means offset-based paging may show duplicates, but similar behavior
 273      * already exists when new notices are posted between page views, so we
 274      * think people will be ok with this until id-based paging is introduced
 275      * to the user interface.
 276      *
 277      * @param int $user_id
 278      * @param int $offset skip past the most recent N notices (after since_id checks)
 279      * @param int $limit
 280      * @param mixed $since_id return only notices after but not including this id
 281      * @param mixed $max_id return only notices up to and including this id
 282      * @param mixed $own ignored?
 283      * @return array of Notice objects
 284      *
 285      * @todo consider repacking the inbox when this happens?
 286      * @fixme reimplement $own if we need it?
 287      */
 288     function streamNotices($user_id, $offset, $limit, $since_id, $max_id, $own=false)
 289     {
 290         $ids = self::stream($user_id, $offset, self::MAX_NOTICES, $since_id, $max_id, $own);
 291
 292         // Do a bulk lookup for the first $limit items
 293         // Fast path when nothing's deleted.
 294         $firstChunk = array_slice($ids, 0, $limit);
 295         $notices = Notice::getStreamByIds($firstChunk);
 296
 297         $wanted = count($firstChunk); // raw entry count in the inbox up to our $limit
 298         if ($notices->N >= $wanted) {
 299             return $notices;
 300         }
 301
 302         // There were deleted notices, we'll need to look for more.
 303         assert($notices instanceof ArrayWrapper);
 304         $items = $notices->_items;
 305         $remainder = array_slice($ids, $limit);
 306
 307         while (count($items) < $wanted && count($remainder) > 0) {
 308             $notice = Notice::staticGet(array_shift($remainder));
 309             if ($notice) {
 310                 $items[] = $notice;
 311             } else {
 312             }
 313         }
 314         return new ArrayWrapper($items);
 315     }
 316
 317     /**
 318      * Saves a list of integer notice_ids into a packed blob in this object.
 319      * @param array $ids list of integer notice_ids
 320      */
 321     protected function pack(array $ids)
 322     {
 323         $this->notice_ids = call_user_func_array('pack', array_merge(array('N*'), $ids));
 324     }
 325
 326     /**
 327      * @return array of integer notice_ids
 328      */
 329     protected function unpack()
 330     {
 331         return unpack('N*', $this->notice_ids);
 332     }
 333 }