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
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 public static function schemaDef()
54 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user receiving the notice'),
55 'notice_ids' => array('type' => 'blob', 'description' => 'packed list of notice ids'),
57 'primary key' => array('user_id'),
58 'foreign keys' => array(
59 'inbox_user_id_fkey' => array('user', array('user_id' => 'id')),
65 * Create a new inbox from existing Notice_inbox stuff
67 static function initialize($user_id)
69 $inbox = Inbox::fromNoticeInbox($user_id);
73 $result = $inbox->insert();
76 common_log_db_error($inbox, 'INSERT', __FILE__);
83 static function fromNoticeInbox($user_id)
87 $ni = new Notice_inbox();
89 $ni->user_id = $user_id;
91 $ni->selectAdd('notice_id');
92 $ni->orderBy('notice_id DESC');
93 $ni->limit(0, self::MAX_NOTICES);
97 $ids[] = $ni->notice_id;
104 $inbox = new Inbox();
106 $inbox->user_id = $user_id;
114 * Append the given notice to the given user's inbox.
115 * Caching updates are managed for the inbox itself.
117 * If the notice is already in this inbox, the second
118 * add will be silently dropped.
120 * @param int @user_id
121 * @param int $notice_id
122 * @return boolean success
124 static function insertNotice($user_id, $notice_id)
126 // Going straight to the DB rather than trusting our caching
127 // during an update. Note: not using DB_DataObject::staticGet,
128 // which is unsafe to use directly (in-process caching causes
129 // memory leaks, which accumulate in queue processes).
130 $inbox = new Inbox();
131 if (!$inbox->get('user_id', $user_id)) {
132 $inbox = Inbox::initialize($user_id);
139 $ids = $inbox->unpack();
140 if (in_array(intval($notice_id), $ids)) {
141 // Already in there, we probably re-ran some inbox adds
142 // due to an error. Skip the dupe silently.
146 $result = $inbox->query(sprintf('UPDATE inbox '.
147 'set notice_ids = concat(cast(0x%08x as binary(4)), '.
148 'substr(notice_ids, 1, %d)) '.
149 'WHERE user_id = %d',
151 4 * (self::MAX_NOTICES - 1),
155 self::blow('inbox:user_id:%d', $user_id);
161 static function bulkInsert($notice_id, $user_ids)
163 foreach ($user_ids as $user_id)
165 Inbox::insertNotice($user_id, $notice_id);
170 * Saves a list of integer notice_ids into a packed blob in this object.
171 * @param array $ids list of integer notice_ids
173 function pack(array $ids)
175 $this->notice_ids = call_user_func_array('pack', array_merge(array('N*'), $ids));
179 * @return array of integer notice_ids
183 return unpack('N*', $this->notice_ids);