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 Managed_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
44 /* the code above is auto generated do not remove the tag below */
47 public static function schemaDef()
51 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user receiving the notice'),
52 'notice_ids' => array('type' => 'blob', 'description' => 'packed list of notice ids'),
54 'primary key' => array('user_id'),
55 'foreign keys' => array(
56 'inbox_user_id_fkey' => array('user', array('user_id' => 'id')),
62 * Create a new inbox from existing Notice_inbox stuff
64 static function initialize($user_id)
66 $inbox = Inbox::fromNoticeInbox($user_id);
70 $result = $inbox->insert();
73 common_log_db_error($inbox, 'INSERT', __FILE__);
80 static function fromNoticeInbox($user_id)
84 $ni = new Notice_inbox();
86 $ni->user_id = $user_id;
88 $ni->selectAdd('notice_id');
89 $ni->orderBy('notice_id DESC');
90 $ni->limit(0, self::MAX_NOTICES);
94 $ids[] = $ni->notice_id;
101 $inbox = new Inbox();
103 $inbox->user_id = $user_id;
111 * Append the given notice to the given user's inbox.
112 * Caching updates are managed for the inbox itself.
114 * If the notice is already in this inbox, the second
115 * add will be silently dropped.
117 * @param int @user_id
118 * @param int $notice_id
119 * @return boolean success
121 static function insertNotice($user_id, $notice_id)
123 // Going straight to the DB rather than trusting our caching
124 // during an update. Note: not using DB_DataObject::staticGet,
125 // which is unsafe to use directly (in-process caching causes
126 // memory leaks, which accumulate in queue processes).
127 $inbox = new Inbox();
128 if (!$inbox->get('user_id', $user_id)) {
129 $inbox = Inbox::initialize($user_id);
136 $ids = $inbox->unpack();
137 if (in_array(intval($notice_id), $ids)) {
138 // Already in there, we probably re-ran some inbox adds
139 // due to an error. Skip the dupe silently.
143 $result = $inbox->query(sprintf('UPDATE inbox '.
144 'set notice_ids = concat(cast(0x%08x as binary(4)), '.
145 'substr(notice_ids, 1, %d)) '.
146 'WHERE user_id = %d',
148 4 * (self::MAX_NOTICES - 1),
152 self::blow('inbox:user_id:%d', $user_id);
158 static function bulkInsert($notice_id, $user_ids)
160 foreach ($user_ids as $user_id)
162 Inbox::insertNotice($user_id, $notice_id);
167 * Saves a list of integer notice_ids into a packed blob in this object.
168 * @param array $ids list of integer notice_ids
170 function pack(array $ids)
172 $this->notice_ids = call_user_func_array('pack', array_merge(array('N*'), $ids));
176 * @return array of integer notice_ids
180 return unpack('N*', $this->notice_ids);