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
  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 class InboxNoticeStream extends ThreadingNoticeStream
  48 {
  49     /**
  50      * Constructor
  51      *
  52      * @param User $user User to get a stream for
  53      */
  54     function __construct($user, $profile = -1)
  55     {
  56         if (is_int($profile) && $profile == -1) {
  57             $profile = Profile::current();
  58         }
  59         // Note: we don't use CachingNoticeStream since RawInboxNoticeStream
  60         // uses Inbox::staticGet(), which is cached.
  61         $stream = new ScopingNoticeStream(new RawInboxNoticeStream($user), $profile);
  62         parent::__construct($stream);
  63     }
  64 }
  65
  66 /**
  67  * Raw stream of notices for the user's inbox
  68  *
  69  * @category  General
  70  * @package   StatusNet
  71  * @author    Evan Prodromou <evan@status.net>
  72  * @copyright 2011 StatusNet, Inc.
  73  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  74  * @link      http://status.net/
  75  */
  76 class RawInboxNoticeStream extends NoticeStream
  77 {
  78     protected $user  = null;
  79     protected $inbox = null;
  80
  81     /**
  82      * Constructor
  83      *
  84      * @param User $user User to get a stream for
  85      */
  86     function __construct($user)
  87     {
  88         $this->user  = $user;
  89         $this->inbox = Inbox::staticGet('user_id', $user->id);
  90     }
  91
  92     /**
  93      * Get IDs in a range
  94      *
  95      * @param int $offset   Offset from start
  96      * @param int $limit    Limit of number to get
  97      * @param int $since_id Since this notice
  98      * @param int $max_id   Before this notice
  99      *
 100      * @return Array IDs found
 101      */
 102     function getNoticeIds($offset, $limit, $since_id, $max_id)
 103     {
 104         if (empty($this->inbox)) {
 105             $this->inbox = Inbox::fromNoticeInbox($user_id);
 106             if (empty($this->inbox)) {
 107                 return array();
 108             } else {
 109                 $this->inbox->encache();
 110             }
 111         }
 112
 113         $ids = $this->inbox->unpack();
 114
 115         if (!empty($since_id)) {
 116             $newids = array();
 117             foreach ($ids as $id) {
 118                 if ($id > $since_id) {
 119                     $newids[] = $id;
 120                 }
 121             }
 122             $ids = $newids;
 123         }
 124
 125         if (!empty($max_id)) {
 126             $newids = array();
 127             foreach ($ids as $id) {
 128                 if ($id <= $max_id) {
 129                     $newids[] = $id;
 130                 }
 131             }
 132             $ids = $newids;
 133         }
 134
 135         $ids = array_slice($ids, $offset, $limit);
 136
 137         return $ids;
 138     }
 139 }