lib/inboxnoticestream.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Stream of notices for the user's inbox
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Cache
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Stream of notices for the user's inbox
  39  *
  40  * @category  General
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 class InboxNoticeStream extends ScopingNoticeStream
  49 {
  50     /**
  51      * Constructor
  52      *
  53      * @param User $user User to get a stream for
  54      */
  55     function __construct($user)
  56     {
  57         // Note: we don't use CachingNoticeStream since RawInboxNoticeStream
  58         // uses Inbox::staticGet(), which is cached.
  59         parent::__construct(new RawInboxNoticeStream($user));
  60     }
  61 }
  62
  63 /**
  64  * Raw stream of notices for the user's inbox
  65  *
  66  * @category  General
  67  * @package   StatusNet
  68  * @author    Evan Prodromou <evan@status.net>
  69  * @copyright 2011 StatusNet, Inc.
  70  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  71  * @link      http://status.net/
  72  */
  73 class RawInboxNoticeStream extends NoticeStream
  74 {
  75     protected $user  = null;
  76     protected $inbox = null;
  77
  78     /**
  79      * Constructor
  80      *
  81      * @param User $user User to get a stream for
  82      */
  83     function __construct($user)
  84     {
  85         $this->user  = $user;
  86         $this->inbox = Inbox::staticGet('user_id', $user->id);
  87     }
  88
  89     /**
  90      * Get IDs in a range
  91      *
  92      * @param int $offset   Offset from start
  93      * @param int $limit    Limit of number to get
  94      * @param int $since_id Since this notice
  95      * @param int $max_id   Before this notice
  96      *
  97      * @return Array IDs found
  98      */
  99     function getNoticeIds($offset, $limit, $since_id, $max_id)
 100     {
 101         if (empty($this->inbox)) {
 102             $this->inbox = Inbox::fromNoticeInbox($user_id);
 103             if (empty($this->inbox)) {
 104                 return array();
 105             } else {
 106                 $this->inbox->encache();
 107             }
 108         }
 109
 110         $ids = $this->inbox->unpack();
 111
 112         if (!empty($since_id)) {
 113             $newids = array();
 114             foreach ($ids as $id) {
 115                 if ($id > $since_id) {
 116                     $newids[] = $id;
 117                 }
 118             }
 119             $ids = $newids;
 120         }
 121
 122         if (!empty($max_id)) {
 123             $newids = array();
 124             foreach ($ids as $id) {
 125                 if ($id <= $max_id) {
 126                     $newids[] = $id;
 127                 }
 128             }
 129             $ids = $newids;
 130         }
 131
 132         $ids = array_slice($ids, $offset, $limit);
 133
 134         return $ids;
 135     }
 136 }