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
  36     ###START_AUTOCODE
  37     /* the code below is auto generated do not remove the above tag */
  38
  39     public $__table = 'inbox';                           // table name
  40     public $user_id;                         // int(4)  primary_key not_null
  41     public $notice_ids;                      // blob
  42
  43     /* Static get */
  44     function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('Inbox',$k,$v); }
  45
  46     /* the code above is auto generated do not remove the tag below */
  47     ###END_AUTOCODE
  48
  49     function sequenceKey()
  50     {
  51         return array(false, false, false);
  52     }
  53
  54     /**
  55      * Create a new inbox from existing Notice_inbox stuff
  56      */
  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, 1024);
  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->notice_ids = call_user_func_array('pack', array_merge(array('N*'), $ids));
  99         $inbox->fake = true;
 100
 101         return $inbox;
 102     }
 103
 104     static function insertNotice($user_id, $notice_id)
 105     {
 106         $inbox = Inbox::staticGet('user_id', $user_id);
 107
 108         if (empty($inbox) || $inbox->fake) {
 109             $inbox = Inbox::initialize($user_id);
 110         }
 111
 112         if (empty($inbox)) {
 113             return false;
 114         }
 115
 116         $result = $inbox->query(sprintf('UPDATE inbox '.
 117                                         'set notice_ids = concat(cast(0x%08x as binary(4)), '.
 118                                         'substr(notice_ids, 1, 4092)) '.
 119                                         'WHERE user_id = %d',
 120                                         $notice_id, $user_id));
 121
 122         if ($result) {
 123             $c = self::memcache();
 124
 125             if (!empty($c)) {
 126                 $c->delete(self::cacheKey('inbox', 'user_id', $user_id));
 127             }
 128         }
 129
 130         return $result;
 131     }
 132
 133     static function bulkInsert($notice_id, $user_ids)
 134     {
 135         foreach ($user_ids as $user_id)
 136         {
 137             Inbox::insertNotice($user_id, $notice_id);
 138         }
 139     }
 140
 141     function stream($user_id, $offset, $limit, $since_id, $max_id, $since, $own=false)
 142     {
 143         $inbox = Inbox::staticGet('user_id', $user_id);
 144
 145         if (empty($inbox)) {
 146             $inbox = Inbox::fromNoticeInbox($user_id);
 147             if (empty($inbox)) {
 148                 return array();
 149             } else {
 150                 $inbox->encache();
 151             }
 152         }
 153
 154         $ids = unpack('N*', $inbox->notice_ids);
 155
 156         // XXX: handle since_id
 157         // XXX: handle max_id
 158
 159         $ids = array_slice($ids, $offset, $limit);
 160
 161         return $ids;
 162     }
 163 }