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         $ids = array();
  61
  62         $ni = new Notice_inbox();
  63
  64         $ni->user_id = $user_id;
  65         $ni->selectAdd();
  66         $ni->selectAdd('notice_id');
  67         $ni->orderBy('notice_id DESC');
  68         $ni->limit(0, 1024);
  69
  70         if ($ni->find()) {
  71             while($ni->fetch()) {
  72                 $ids[] = $ni->notice_id;
  73             }
  74         }
  75
  76         $ni->free();
  77         unset($ni);
  78
  79         $inbox = new Inbox();
  80
  81         $inbox->user_id = $user_id;
  82         $inbox->notice_ids = call_user_func_array('pack', array_merge(array('N*'), $ids));
  83
  84         $result = $inbox->insert();
  85
  86         if (!$result) {
  87             common_log_db_error($inbox, 'INSERT', __FILE__);
  88             return null;
  89         }
  90
  91         return $inbox;
  92     }
  93
  94     static function insertNotice($user_id, $notice_id)
  95     {
  96         $inbox = Inbox::staticGet('user_id', $user_id);
  97
  98         if (empty($inbox)) {
  99             $inbox = Inbox::initialize($user_id);
 100         }
 101
 102         if (empty($inbox)) {
 103             return false;
 104         }
 105
 106         $result = $inbox->query(sprintf('UPDATE inbox '.
 107                                         'set notice_ids = concat(cast(0x%08x as binary(4)), '.
 108                                         'substr(notice_ids, 1, 4092)) '.
 109                                         'WHERE user_id = %d',
 110                                         $notice_id, $user_id));
 111
 112         if ($result) {
 113             $c = self::memcache();
 114
 115             if (!empty($c)) {
 116                 $c->delete(self::cacheKey('inbox', 'user_id', $user_id));
 117             }
 118         }
 119
 120         return $result;
 121     }
 122
 123     static function bulkInsert($notice_id, $user_ids)
 124     {
 125         foreach ($user_ids as $user_id)
 126         {
 127             Inbox::insertNotice($user_id, $notice_id);
 128         }
 129     }
 130
 131     function stream($user_id, $offset, $limit, $since_id, $max_id, $since, $own=false)
 132     {
 133         $inbox = Inbox::staticGet('user_id', $user_id);
 134
 135         if (empty($inbox)) {
 136             $inbox = Inbox::initialize($user_id);
 137             if (empty($inbox)) {
 138                 return array();
 139             }
 140         }
 141
 142         $ids = unpack('N*', $inbox->notice_ids);
 143
 144         // XXX: handle since_id
 145         // XXX: handle max_id
 146
 147         $ids = array_slice($ids, $offset, $limit);
 148
 149         return $ids;
 150     }
 151 }