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 Managed_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     public static function schemaDef()
  51     {
  52         return array(
  53             'fields' => array(
  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'),
  56             ),
  57             'primary key' => array('user_id'),
  58             'foreign keys' => array(
  59                 'inbox_user_id_fkey' => array('user', array('user_id' => 'id')),
  60             ),
  61         );
  62     }
  63
  64     function sequenceKey()
  65     {
  66         return array(false, false, false);
  67     }
  68
  69     /**
  70      * Create a new inbox from existing Notice_inbox stuff
  71      */
  72     static function initialize($user_id)
  73     {
  74         $inbox = Inbox::fromNoticeInbox($user_id);
  75
  76         unset($inbox->fake);
  77
  78         $result = $inbox->insert();
  79
  80         if (!$result) {
  81             common_log_db_error($inbox, 'INSERT', __FILE__);
  82             return null;
  83         }
  84
  85         return $inbox;
  86     }
  87
  88     static function fromNoticeInbox($user_id)
  89     {
  90         $ids = array();
  91
  92         $ni = new Notice_inbox();
  93
  94         $ni->user_id = $user_id;
  95         $ni->selectAdd();
  96         $ni->selectAdd('notice_id');
  97         $ni->orderBy('notice_id DESC');
  98         $ni->limit(0, self::MAX_NOTICES);
  99
 100         if ($ni->find()) {
 101             while($ni->fetch()) {
 102                 $ids[] = $ni->notice_id;
 103             }
 104         }
 105
 106         $ni->free();
 107         unset($ni);
 108
 109         $inbox = new Inbox();
 110
 111         $inbox->user_id = $user_id;
 112         $inbox->pack($ids);
 113         $inbox->fake = true;
 114
 115         return $inbox;
 116     }
 117
 118     /**
 119      * Append the given notice to the given user's inbox.
 120      * Caching updates are managed for the inbox itself.
 121      *
 122      * If the notice is already in this inbox, the second
 123      * add will be silently dropped.
 124      *
 125      * @param int @user_id
 126      * @param int $notice_id
 127      * @return boolean success
 128      */
 129     static function insertNotice($user_id, $notice_id)
 130     {
 131         // Going straight to the DB rather than trusting our caching
 132         // during an update. Note: not using DB_DataObject::staticGet,
 133         // which is unsafe to use directly (in-process caching causes
 134         // memory leaks, which accumulate in queue processes).
 135         $inbox = new Inbox();
 136         if (!$inbox->get('user_id', $user_id)) {
 137             $inbox = Inbox::initialize($user_id);
 138         }
 139
 140         if (empty($inbox)) {
 141             return false;
 142         }
 143
 144         $ids = $inbox->unpack();
 145         if (in_array(intval($notice_id), $ids)) {
 146             // Already in there, we probably re-ran some inbox adds
 147             // due to an error. Skip the dupe silently.
 148             return true;
 149         }
 150
 151         $result = $inbox->query(sprintf('UPDATE inbox '.
 152                                         'set notice_ids = concat(cast(0x%08x as binary(4)), '.
 153                                         'substr(notice_ids, 1, %d)) '.
 154                                         'WHERE user_id = %d',
 155                                         $notice_id,
 156                                         4 * (self::MAX_NOTICES - 1),
 157                                         $user_id));
 158
 159         if ($result) {
 160             self::blow('inbox:user_id:%d', $user_id);
 161         }
 162
 163         return $result;
 164     }
 165
 166     static function bulkInsert($notice_id, $user_ids)
 167     {
 168         foreach ($user_ids as $user_id)
 169         {
 170             Inbox::insertNotice($user_id, $notice_id);
 171         }
 172     }
 173
 174     /**
 175      * Saves a list of integer notice_ids into a packed blob in this object.
 176      * @param array $ids list of integer notice_ids
 177      */
 178     function pack(array $ids)
 179     {
 180         $this->notice_ids = call_user_func_array('pack', array_merge(array('N*'), $ids));
 181     }
 182
 183     /**
 184      * @return array of integer notice_ids
 185      */
 186     function unpack()
 187     {
 188         return unpack('N*', $this->notice_ids);
 189     }
 190 }