notice streams are showing for groups.
[statusnet:freesocial.git] / lib / groupnoticestream.php
1 <?php
2 /**
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2011, StatusNet, Inc.
5  *
6  * Stream of notices for a group
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  Stream
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 a group
39  *
40  * @category  Stream
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 GroupNoticeStream extends ScopingNoticeStream
48 {
49     var $group;
50     var $userProfile;
51
52     function __construct($group, $profile = -1)
53     {
54         if (is_int($profile) && $profile == -1) {
55             $profile = Profile::current();
56         }
57         $this->group = $group;
58         $this->userProfile = $profile;
59
60         parent::__construct(new CachingNoticeStream(new RawGroupNoticeStream($group),
61                                                     'user_group:notice_ids:' . $group->id),
62                             $profile);
63     }
64
65     function getNoticeIds($offset, $limit, $since_id, $max_id)
66     {
67         if ($this->impossibleStream()) {
68             return array();
69         } else {
70             return parent::getNoticeIds($offset, $limit, $since_id, $max_id);
71         }
72     }
73
74     function getNotices($offset, $limit, $sinceId = null, $maxId = null)
75     {
76         if ($this->impossibleStream()) {
77             return new ArrayWrapper(array());
78         } else {
79             return parent::getNotices($offset, $limit, $sinceId, $maxId);
80         }
81     }
82
83     function impossibleStream() 
84     {
85         if ($this->group->force_scope &&
86             (empty($this->userProfile) || !$this->userProfile->isMember($this->group))) {
87             return true;
88         }
89
90         return false;
91     }
92 }
93
94 /**
95  * Stream of notices for a group
96  *
97  * @category  Stream
98  * @package   StatusNet
99  * @author    Evan Prodromou <evan@status.net>
100  * @copyright 2011 StatusNet, Inc.
101  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
102  * @link      http://status.net/
103  */
104 class RawGroupNoticeStream extends NoticeStream
105 {
106     protected $group;
107
108     function __construct($group)
109     {
110         $this->group = $group;
111     }
112
113     function getNoticeIds($offset, $limit, $since_id, $max_id)
114     {
115         $inbox = new Group_inbox();
116
117         $inbox->group_id = $this->group->id;
118
119         $inbox->selectAdd();
120         $inbox->selectAdd('notice_id');
121
122         Notice::addWhereSinceId($inbox, $since_id, 'notice_id');
123         Notice::addWhereMaxId($inbox, $max_id, 'notice_id');
124
125         $inbox->orderBy('created DESC, notice_id DESC');
126
127         if (!is_null($offset)) {
128             $inbox->limit($offset, $limit);
129         }
130
131         $ids = array();
132
133         if ($inbox->find()) {
134             while ($inbox->fetch()) {
135                 $ids[] = $inbox->notice_id;
136             }
137         }
138
139         return $ids;
140     }
141 }
142
143 class ThreadingGroupNoticeStream extends ThreadingNoticeStream
144 {
145     function __construct($group, $profile)
146     {
147         parent::__construct(new GroupNoticeStream($group, $profile));
148     }
149 }