notice streams are showing for groups.
[statusnet:freesocial.git] / lib / groupaction.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Base class for group actions
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  Action
23  * @package   StatusNet
24  * @author    Zach Copley <zach@status.net>
25  * @copyright 2009-2011 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 if (!defined('STATUSNET') && !defined('LACONICA')) {
31     exit(1);
32 }
33
34 define('MEMBERS_PER_SECTION', 27);
35
36 /**
37  * Base class for group actions, similar to ProfileAction
38  *
39  * @category Action
40  * @package  StatusNet
41  * @author   Zach Copley <zach@status.net>
42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
43  * @link     http://status.net/
44  */
45 class GroupAction extends ProfileAction
46 {
47     protected $group;
48
49     function showProfileBlock()
50     {
51         $block = new GroupProfileBlock($this, $this->group);
52         $block->show();
53     }
54
55     /**
56      * Fill in the sidebar.
57      *
58      * @return void
59      */
60     function showSections()
61     {
62         $this->showMembers();
63         $cur = common_current_user();
64         if ($cur && $cur->isAdmin($this->group)) {
65             $this->showPending();
66             $this->showBlocked();
67         }
68
69         $this->showAdmins();
70
71         if (!common_config('performance', 'high')) {
72             $cloud = new GroupTagCloudSection($this, $this->group);
73             $cloud->show();
74         }
75     }
76
77     /**
78      * Show mini-list of members
79      *
80      * @return void
81      */
82     function showMembers()
83     {
84         $member = $this->group->getMembers(0, MEMBERS_PER_SECTION);
85
86         if (!$member) {
87             return;
88         }
89
90         $this->elementStart('div', array('id' => 'entity_members',
91                                          'class' => 'section'));
92
93         if (Event::handle('StartShowGroupMembersMiniList', array($this))) {
94             $this->elementStart('h2');
95
96             $this->element('a', array('href' => common_local_url('groupmembers', array('nickname' =>
97                                                                                        $this->group->nickname))),
98                            // TRANS: Header for mini list of group members on a group page (h2).
99                            _('Members'));
100
101             $this->text(' ');
102
103             $this->text($this->group->getMemberCount());
104
105             $this->elementEnd('h2');
106
107             $gmml = new GroupMembersMiniList($member, $this);
108             $cnt = $gmml->show();
109             if ($cnt == 0) {
110                 // TRANS: Description for mini list of group members on a group page when the group has no members.
111                 $this->element('p', null, _('(None)'));
112             }
113
114             // @todo FIXME: Should be shown if a group has more than 27 members, but I do not see it displayed at
115             //              for example http://identi.ca/group/statusnet. Broken?
116             if ($cnt > MEMBERS_PER_SECTION) {
117                 $this->element('a', array('href' => common_local_url('groupmembers',
118                                                                      array('nickname' => $this->group->nickname))),
119                                // TRANS: Link to all group members from mini list of group members if group has more than n members.
120                                _('All members'));
121             }
122
123             Event::handle('EndShowGroupMembersMiniList', array($this));
124         }
125
126         $this->elementEnd('div');
127     }
128
129     function showPending()
130     {
131         if ($this->group->join_policy != User_group::JOIN_POLICY_MODERATE) {
132             return;
133         }
134
135         $pending = $this->group->getQueueCount();
136
137         if (!$pending) {
138             return;
139         }
140
141         $request = $this->group->getRequests(0, MEMBERS_PER_SECTION);
142
143         if (!$request) {
144             return;
145         }
146
147         $this->elementStart('div', array('id' => 'entity_pending',
148                                          'class' => 'section'));
149
150         if (Event::handle('StartShowGroupPendingMiniList', array($this))) {
151
152             $this->elementStart('h2');
153
154             $this->element('a', array('href' => common_local_url('groupqueue', array('nickname' =>
155                                                                                      $this->group->nickname))),
156                            // TRANS: Header for mini list of users with a pending membership request on a group page (h2).
157                            _('Pending'));
158
159             $this->text(' ');
160
161             $this->text($pending);
162
163             $this->elementEnd('h2');
164
165             $gmml = new ProfileMiniList($request, $this);
166             $gmml->show();
167
168             Event::handle('EndShowGroupPendingMiniList', array($this));
169         }
170
171         $this->elementEnd('div');
172     }
173
174     function showBlocked()
175     {
176         $blocked = $this->group->getBlocked(0, MEMBERS_PER_SECTION);
177
178         if (!$blocked) {
179             return;
180         }
181
182         $this->elementStart('div', array('id' => 'entity_blocked',
183                                          'class' => 'section'));
184
185         if (Event::handle('StartShowGroupBlockedMiniList', array($this))) {
186
187             $this->elementStart('h2');
188
189             $this->element('a', array('href' => common_local_url('blockedfromgroup', array('nickname' =>
190                                                                                            $this->group->nickname))),
191                            // TRANS: Header for mini list of users that are blocked in a group page (h2).
192                            _('Blocked'));
193
194             $this->text(' ');
195
196             $this->text($this->group->getBlockedCount());
197
198             $this->elementEnd('h2');
199
200             $gmml = new GroupBlockedMiniList($blocked, $this);
201             $cnt = $gmml->show();
202             if ($cnt == 0) {
203                 // TRANS: Description for mini list of group members on a group page when the group has no members.
204                 $this->element('p', null, _('(None)'));
205             }
206
207             // @todo FIXME: Should be shown if a group has more than 27 members, but I do not see it displayed at
208             //              for example http://identi.ca/group/statusnet. Broken?
209             if ($cnt > MEMBERS_PER_SECTION) {
210                 $this->element('a', array('href' => common_local_url('blockedfromgroup',
211                                                                      array('nickname' => $this->group->nickname))),
212                                // TRANS: Link to all group members from mini list of group members if group has more than n members.
213                                _('All members'));
214             }
215
216             Event::handle('EndShowGroupBlockedMiniList', array($this));
217         }
218
219         $this->elementEnd('div');
220     }
221
222     /**
223      * Show list of admins
224      *
225      * @return void
226      */
227     function showAdmins()
228     {
229         $adminSection = new GroupAdminSection($this, $this->group);
230         $adminSection->show();
231     }
232
233     function noticeFormOptions()
234     {
235         $options = parent::noticeFormOptions();
236         $cur = common_current_user();
237
238         if (!empty($cur) && $cur->isMember($this->group)) {
239             $options['to_group'] =  $this->group;
240         }
241
242         return $options;
243     }
244 }
245
246 class GroupAdminSection extends ProfileSection
247 {
248     var $group;
249
250     function __construct($out, $group)
251     {
252         parent::__construct($out);
253         $this->group = $group;
254     }
255
256     function getProfiles()
257     {
258         return $this->group->getAdmins();
259     }
260
261     function title()
262     {
263         // TRANS: Title for list of group administrators on a group page.
264         return _m('TITLE','Admins');
265     }
266
267     function divId()
268     {
269         return 'group_admins';
270     }
271
272     function moreUrl()
273     {
274         return null;
275     }
276 }
277
278 class GroupMembersMiniList extends ProfileMiniList
279 {
280     function newListItem($profile)
281     {
282         return new GroupMembersMiniListItem($profile, $this->action);
283     }
284 }
285
286 class GroupMembersMiniListItem extends ProfileMiniListItem
287 {
288     function linkAttributes()
289     {
290         $aAttrs = parent::linkAttributes();
291
292         if (common_config('nofollow', 'members')) {
293             $aAttrs['rel'] .= ' nofollow';
294         }
295
296         return $aAttrs;
297     }
298 }
299
300 class GroupBlockedMiniList extends ProfileMiniList
301 {
302     function newListItem($profile)
303     {
304         return new GroupBlockedMiniListItem($profile, $this->action);
305     }
306 }
307
308 class GroupBlockedMiniListItem extends ProfileMiniListItem
309 {
310     function linkAttributes()
311     {
312         $aAttrs = parent::linkAttributes();
313
314         if (common_config('nofollow', 'members')) {
315             $aAttrs['rel'] .= ' nofollow';
316         }
317
318         return $aAttrs;
319     }
320 }
321
322 class ThreadingGroupNoticeStream extends ThreadingNoticeStream
323 {
324     function __construct($group, $profile)
325     {
326         parent::__construct(new GroupNoticeStream($group, $profile));
327     }
328 }