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
  59     static function initialize($user_id)
  60     {
  61         $inbox = Inbox::fromNoticeInbox($user_id);
  62
  63         unset($inbox->fake);
  64
  65         $result = $inbox->insert();
  66
  67         if (!$result) {
  68             common_log_db_error($inbox, 'INSERT', __FILE__);
  69             return null;
  70         }
  71
  72         return $inbox;
  73     }
  74
  75     static function fromNoticeInbox($user_id)
  76     {
  77         $ids = array();
  78
  79         $ni = new Notice_inbox();
  80
  81         $ni->user_id = $user_id;
  82         $ni->selectAdd();
  83         $ni->selectAdd('notice_id');
  84         $ni->orderBy('notice_id DESC');
  85         $ni->limit(0, self::MAX_NOTICES);
  86
  87         if ($ni->find()) {
  88             while($ni->fetch()) {
  89                 $ids[] = $ni->notice_id;
  90             }
  91         }
  92
  93         $ni->free();
  94         unset($ni);
  95
  96         $inbox = new Inbox();
  97
  98         $inbox->user_id = $user_id;
  99         $inbox->notice_ids = call_user_func_array('pack', array_merge(array('N*'), $ids));
 100         $inbox->fake = true;
 101
 102         return $inbox;
 103     }
 104
 105     static function insertNotice($user_id, $notice_id)
 106     {
 107         $inbox = DB_DataObject::staticGet('inbox', 'user_id', $user_id);
 108
 109         if (empty($inbox)) {
 110             $inbox = Inbox::initialize($user_id);
 111         }
 112
 113         if (empty($inbox)) {
 114             return false;
 115         }
 116
 117         $result = $inbox->query(sprintf('UPDATE inbox '.
 118                                         'set notice_ids = concat(cast(0x%08x as binary(4)), '.
 119                                         'substr(notice_ids, 1, %d)) '.
 120                                         'WHERE user_id = %d',
 121                                         $notice_id,
 122                                         4 * (self::MAX_NOTICES - 1),
 123                                         $user_id));
 124
 125         if ($result) {
 126             self::blow('inbox:user_id:%d', $user_id);
 127         }
 128
 129         return $result;
 130     }
 131
 132     static function bulkInsert($notice_id, $user_ids)
 133     {
 134         foreach ($user_ids as $user_id)
 135         {
 136             Inbox::insertNotice($user_id, $notice_id);
 137         }
 138     }
 139
 140     function stream($user_id, $offset, $limit, $since_id, $max_id, $since, $own=false)
 141     {
 142         $inbox = Inbox::staticGet('user_id', $user_id);
 143
 144         if (empty($inbox)) {
 145             $inbox = Inbox::fromNoticeInbox($user_id);
 146             if (empty($inbox)) {
 147                 return array();
 148             } else {
 149                 $inbox->encache();
 150             }
 151         }
 152
 153         $ids = unpack('N*', $inbox->notice_ids);
 154
 155         if (!empty($since_id)) {
 156             $newids = array();
 157             foreach ($ids as $id) {
 158                 if ($id > $since_id) {
 159                     $newids[] = $id;
 160                 }
 161             }
 162             $ids = $newids;
 163         }
 164
 165         if (!empty($max_id)) {
 166             $newids = array();
 167             foreach ($ids as $id) {
 168                 if ($id <= $max_id) {
 169                     $newids[] = $id;
 170                 }
 171             }
 172             $ids = $newids;
 173         }
 174
 175         $ids = array_slice($ids, $offset, $limit);
 176
 177         return $ids;
 178     }
 179
 180     /**
 181      * Wrapper for Inbox::stream() and Notice::getStreamByIds() returning
 182      * additional items up to the limit if we were short due to deleted
 183      * notices still being listed in the inbox.
 184      *
 185      * The fast path (when no items are deleted) should be just as fast; the
 186      * offset parameter is applied *before* lookups for maximum efficiency.
 187      *
 188      * This means offset-based paging may show duplicates, but similar behavior
 189      * already exists when new notices are posted between page views, so we
 190      * think people will be ok with this until id-based paging is introduced
 191      * to the user interface.
 192      *
 193      * @param int $user_id
 194      * @param int $offset skip past the most recent N notices (after since_id checks)
 195      * @param int $limit
 196      * @param mixed $since_id return only notices after but not including this id
 197      * @param mixed $max_id return only notices up to and including this id
 198      * @param mixed $since obsolete/ignored
 199      * @param mixed $own ignored?
 200      * @return array of Notice objects
 201      *
 202      * @todo consider repacking the inbox when this happens?
 203      */
 204     function streamNotices($user_id, $offset, $limit, $since_id, $max_id, $since, $own=false)
 205     {
 206         $ids = self::stream($user_id, $offset, self::MAX_NOTICES, $since_id, $max_id, $since, $own);
 207
 208         // Do a bulk lookup for the first $limit items
 209         // Fast path when nothing's deleted.
 210         $firstChunk = array_slice($ids, 0, $limit);
 211         $notices = Notice::getStreamByIds($firstChunk);
 212
 213         $wanted = count($firstChunk); // raw entry count in the inbox up to our $limit
 214         if ($notices->N >= $wanted) {
 215             return $notices;
 216         }
 217
 218         // There were deleted notices, we'll need to look for more.
 219         assert($notices instanceof ArrayWrapper);
 220         $items = $notices->_items;
 221         $remainder = array_slice($ids, $limit);
 222
 223         while (count($items) < $wanted && count($remainder) > 0) {
 224             $notice = Notice::staticGet(array_shift($remainder));
 225             if ($notice) {
 226                 $items[] = $notice;
 227             } else {
 228             }
 229         }
 230         return new ArrayWrapper($items);
 231     }
 232 }