3 * StatusNet, the distributed open-source microblogging tool
5 * Data class for user location preferences
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.
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.
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/>.
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/
30 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
32 class Inbox extends Memcached_DataObject
35 const MAX_NOTICES = 1024;
38 /* the code below is auto generated do not remove the above tag */
40 public $__table = 'inbox'; // table name
41 public $user_id; // int(4) primary_key not_null
42 public $notice_ids; // blob
45 function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('Inbox',$k,$v); }
47 /* the code above is auto generated do not remove the tag below */
50 function sequenceKey()
52 return array(false, false, false);
56 * Create a new inbox from existing Notice_inbox stuff
59 static function initialize($user_id)
61 $inbox = Inbox::fromNoticeInbox($user_id);
65 $result = $inbox->insert();
68 common_log_db_error($inbox, 'INSERT', __FILE__);
75 static function fromNoticeInbox($user_id)
79 $ni = new Notice_inbox();
81 $ni->user_id = $user_id;
83 $ni->selectAdd('notice_id');
84 $ni->orderBy('notice_id DESC');
85 $ni->limit(0, self::MAX_NOTICES);
89 $ids[] = $ni->notice_id;
98 $inbox->user_id = $user_id;
106 * Append the given notice to the given user's inbox.
107 * Caching updates are managed for the inbox itself.
109 * If the notice is already in this inbox, the second
110 * add will be silently dropped.
112 * @param int @user_id
113 * @param int $notice_id
114 * @return boolean success
116 static function insertNotice($user_id, $notice_id)
118 // Going straight to the DB rather than trusting our caching
119 // during an update. Note: not using DB_DataObject::staticGet,
120 // which is unsafe to use directly (in-process caching causes
121 // memory leaks, which accumulate in queue processes).
122 $inbox = new Inbox();
123 if (!$inbox->get('user_id', $user_id)) {
124 $inbox = Inbox::initialize($user_id);
131 $ids = $inbox->unpack();
132 if (in_array(intval($notice_id), $ids)) {
133 // Already in there, we probably re-ran some inbox adds
134 // due to an error. Skip the dupe silently.
138 $result = $inbox->query(sprintf('UPDATE inbox '.
139 'set notice_ids = concat(cast(0x%08x as binary(4)), '.
140 'substr(notice_ids, 1, %d)) '.
141 'WHERE user_id = %d',
143 4 * (self::MAX_NOTICES - 1),
147 self::blow('inbox:user_id:%d', $user_id);
153 static function bulkInsert($notice_id, $user_ids)
155 foreach ($user_ids as $user_id)
157 Inbox::insertNotice($user_id, $notice_id);
161 function stream($user_id, $offset, $limit, $since_id, $max_id, $own=false)
163 $inbox = Inbox::staticGet('user_id', $user_id);
166 $inbox = Inbox::fromNoticeInbox($user_id);
174 $ids = $inbox->unpack();
176 if (!empty($since_id)) {
178 foreach ($ids as $id) {
179 if ($id > $since_id) {
186 if (!empty($max_id)) {
188 foreach ($ids as $id) {
189 if ($id <= $max_id) {
196 $ids = array_slice($ids, $offset, $limit);
202 * Wrapper for Inbox::stream() and Notice::getStreamByIds() returning
203 * additional items up to the limit if we were short due to deleted
204 * notices still being listed in the inbox.
206 * The fast path (when no items are deleted) should be just as fast; the
207 * offset parameter is applied *before* lookups for maximum efficiency.
209 * This means offset-based paging may show duplicates, but similar behavior
210 * already exists when new notices are posted between page views, so we
211 * think people will be ok with this until id-based paging is introduced
212 * to the user interface.
214 * @param int $user_id
215 * @param int $offset skip past the most recent N notices (after since_id checks)
217 * @param mixed $since_id return only notices after but not including this id
218 * @param mixed $max_id return only notices up to and including this id
219 * @param mixed $own ignored?
220 * @return array of Notice objects
222 * @todo consider repacking the inbox when this happens?
223 * @fixme reimplement $own if we need it?
225 function streamNotices($user_id, $offset, $limit, $since_id, $max_id, $own=false)
227 $ids = self::stream($user_id, $offset, self::MAX_NOTICES, $since_id, $max_id, $own);
229 // Do a bulk lookup for the first $limit items
230 // Fast path when nothing's deleted.
231 $firstChunk = array_slice($ids, 0, $limit);
232 $notices = Notice::getStreamByIds($firstChunk);
234 $wanted = count($firstChunk); // raw entry count in the inbox up to our $limit
235 if ($notices->N >= $wanted) {
239 // There were deleted notices, we'll need to look for more.
240 assert($notices instanceof ArrayWrapper);
241 $items = $notices->_items;
242 $remainder = array_slice($ids, $limit);
244 while (count($items) < $wanted && count($remainder) > 0) {
245 $notice = Notice::staticGet(array_shift($remainder));
251 return new ArrayWrapper($items);
255 * Saves a list of integer notice_ids into a packed blob in this object.
256 * @param array $ids list of integer notice_ids
258 protected function pack(array $ids)
260 $this->notice_ids = call_user_func_array('pack', array_merge(array('N*'), $ids));
264 * @return array of integer notice_ids
266 protected function unpack()
268 return unpack('N*', $this->notice_ids);