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