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     /* the code above is auto generated do not remove the tag below */
  45     ###END_AUTOCODE
  46
  47     public static function schemaDef()
  48     {
  49         return array(
  50             'fields' => array(
  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'),
  53             ),
  54             'primary key' => array('user_id'),
  55             'foreign keys' => array(
  56                 'inbox_user_id_fkey' => array('user', array('user_id' => 'id')),
  57             ),
  58         );
  59     }
  60
  61     /**
  62      * Create a new inbox from existing Notice_inbox stuff
  63      */
  64     static function initialize($user_id)
  65     {
  66         $inbox = Inbox::fromNoticeInbox($user_id);
  67
  68         unset($inbox->fake);
  69
  70         $result = $inbox->insert();
  71
  72         if (!$result) {
  73             common_log_db_error($inbox, 'INSERT', __FILE__);
  74             return null;
  75         }
  76
  77         return $inbox;
  78     }
  79
  80     static function fromNoticeInbox($user_id)
  81     {
  82         $ids = array();
  83
  84         $ni = new Notice_inbox();
  85
  86         $ni->user_id = $user_id;
  87         $ni->selectAdd();
  88         $ni->selectAdd('notice_id');
  89         $ni->orderBy('notice_id DESC');
  90         $ni->limit(0, self::MAX_NOTICES);
  91
  92         if ($ni->find()) {
  93             while($ni->fetch()) {
  94                 $ids[] = $ni->notice_id;
  95             }
  96         }
  97
  98         $ni->free();
  99         unset($ni);
 100
 101         $inbox = new Inbox();
 102
 103         $inbox->user_id = $user_id;
 104         $inbox->pack($ids);
 105         $inbox->fake = true;
 106
 107         return $inbox;
 108     }
 109
 110     /**
 111      * Append the given notice to the given user's inbox.
 112      * Caching updates are managed for the inbox itself.
 113      *
 114      * If the notice is already in this inbox, the second
 115      * add will be silently dropped.
 116      *
 117      * @param int @user_id
 118      * @param int $notice_id
 119      * @return boolean success
 120      */
 121     static function insertNotice($user_id, $notice_id)
 122     {
 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);
 130         }
 131
 132         if (empty($inbox)) {
 133             return false;
 134         }
 135
 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.
 140             return true;
 141         }
 142
 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',
 147                                         $notice_id,
 148                                         4 * (self::MAX_NOTICES - 1),
 149                                         $user_id));
 150
 151         if ($result) {
 152             self::blow('inbox:user_id:%d', $user_id);
 153         }
 154
 155         return $result;
 156     }
 157
 158     static function bulkInsert($notice_id, $user_ids)
 159     {
 160         foreach ($user_ids as $user_id)
 161         {
 162             Inbox::insertNotice($user_id, $notice_id);
 163         }
 164     }
 165
 166     /**
 167      * Saves a list of integer notice_ids into a packed blob in this object.
 168      * @param array $ids list of integer notice_ids
 169      */
 170     function pack(array $ids)
 171     {
 172         $this->notice_ids = call_user_func_array('pack', array_merge(array('N*'), $ids));
 173     }
 174
 175     /**
 176      * @return array of integer notice_ids
 177      */
 178     function unpack()
 179     {
 180         return unpack('N*', $this->notice_ids);
 181     }
 182 }