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 class Inbox extends Managed_DataObject {
  31     const BOXCAR = 128;
  32     const MAX_NOTICES = 1024;
  33
  34     ###START_AUTOCODE
  35     /* the code below is auto generated do not remove the above tag */
  36
  37     public $__table = 'inbox';                           // table name
  38     public $user_id;                         // int(4)  primary_key not_null
  39     public $notice_ids;                      // blob
  40
  41     /* the code above is auto generated do not remove the tag below */
  42     ###END_AUTOCODE
  43
  44     public static function schemaDef()
  45     {
  46         return array(
  47             'fields' => array(
  48                 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user receiving the notice'),
  49                 'notice_ids' => array('type' => 'blob', 'description' => 'packed list of notice ids'),
  50             ),
  51             'primary key' => array('user_id'),
  52             'foreign keys' => array(
  53                 'inbox_user_id_fkey' => array('user', array('user_id' => 'id')),
  54             ),
  55         );
  56     }
  57
  58     /**
  59      * Append the given notice to the given user's inbox.
  60      * Caching updates are managed for the inbox itself.
  61      *
  62      * If the notice is already in this inbox, the second
  63      * add will be silently dropped.
  64      *
  65      * @param int @user_id
  66      * @param int $notice_id
  67      * @return boolean success
  68      */
  69     static function insertNotice($user_id, $notice_id)
  70     {
  71         // Going straight to the DB rather than trusting our caching
  72         // during an update. Note: not using DB_DataObject::staticGet,
  73         // which is unsafe to use directly (in-process caching causes
  74         // memory leaks, which accumulate in queue processes).
  75         $inbox = new Inbox();
  76         $inbox->get('user_id', $user_id);
  77
  78         if (empty($inbox)) {
  79             return false;
  80         }
  81
  82         $ids = $inbox->unpack();
  83         if (in_array(intval($notice_id), $ids)) {
  84             // Already in there, we probably re-ran some inbox adds
  85             // due to an error. Skip the dupe silently.
  86             return true;
  87         }
  88
  89         $result = $inbox->query(sprintf('UPDATE inbox '.
  90                                         'SET notice_ids = concat(cast(0x%08x as binary(4)), '.
  91                                         'SUBSTR(notice_ids, 1, %d)) '.
  92                                         'WHERE user_id = %d',
  93                                         $notice_id,
  94                                         4 * (self::MAX_NOTICES - 1),
  95                                         $user_id));
  96
  97         if ($result !== false) {
  98             self::blow('inbox:user_id:%d', $user_id);
  99         }
 100
 101         return $result;
 102     }
 103
 104     static function bulkInsert($notice_id, $user_ids)
 105     {
 106         foreach ($user_ids as $user_id)
 107         {
 108             self::insertNotice($user_id, $notice_id);
 109         }
 110     }
 111
 112     /**
 113      * Saves a list of integer notice_ids into a packed blob in this object.
 114      * @param array $ids list of integer notice_ids
 115      */
 116     function pack(array $ids)
 117     {
 118         $this->notice_ids = call_user_func_array('pack', array_merge(array('N*'), $ids));
 119     }
 120
 121     /**
 122      * @return array of integer notice_ids
 123      */
 124     function unpack()
 125     {
 126         return unpack('N*', $this->notice_ids);
 127     }
 128 }