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 Action
  46 {
  47     protected $group;
  48
  49     function prepare($args)
  50     {
  51         parent::prepare($args);
  52
  53         $nickname_arg = $this->arg('nickname');
  54         $nickname = common_canonical_nickname($nickname_arg);
  55
  56         // Permanent redirect on non-canonical nickname
  57
  58         if ($nickname_arg != $nickname) {
  59             $args = array('nickname' => $nickname);
  60             if ($this->page != 1) {
  61                 $args['page'] = $this->page;
  62             }
  63             common_redirect(common_local_url('showgroup', $args), 301);
  64             return false;
  65         }
  66
  67         if (!$nickname) {
  68             // TRANS: Client error displayed if no nickname argument was given requesting a group page.
  69             $this->clientError(_('No nickname.'), 404);
  70             return false;
  71         }
  72
  73         $local = Local_group::staticGet('nickname', $nickname);
  74
  75         if (!$local) {
  76             $alias = Group_alias::staticGet('alias', $nickname);
  77             if ($alias) {
  78                 $args = array('id' => $alias->group_id);
  79                 if ($this->page != 1) {
  80                     $args['page'] = $this->page;
  81                 }
  82                 common_redirect(common_local_url('groupbyid', $args), 301);
  83                 return false;
  84             } else {
  85                 common_log(LOG_NOTICE, "Couldn't find local group for nickname '$nickname'");
  86                 // TRANS: Client error displayed if no remote group with a given name was found requesting group page.
  87                 $this->clientError(_('No such group.'), 404);
  88                 return false;
  89             }
  90         }
  91
  92         $this->group = User_group::staticGet('id', $local->group_id);
  93
  94         if (!$this->group) {
  95                 // TRANS: Client error displayed if no local group with a given name was found requesting group page.
  96             $this->clientError(_('No such group.'), 404);
  97             return false;
  98         }
  99     }
 100
 101     function showProfileBlock()
 102     {
 103         $block = new GroupProfileBlock($this, $this->group);
 104         $block->show();
 105     }
 106
 107     /**
 108      * Fill in the sidebar.
 109      *
 110      * @return void
 111      */
 112     function showSections()
 113     {
 114         $this->showMembers();
 115         $cur = common_current_user();
 116         if ($cur && $cur->isAdmin($this->group)) {
 117             $this->showPending();
 118             $this->showBlocked();
 119         }
 120         $this->showAdmins();
 121         $cloud = new GroupTagCloudSection($this, $this->group);
 122         $cloud->show();
 123     }
 124
 125     /**
 126      * Show mini-list of members
 127      *
 128      * @return void
 129      */
 130     function showMembers()
 131     {
 132         $member = $this->group->getMembers(0, MEMBERS_PER_SECTION);
 133
 134         if (!$member) {
 135             return;
 136         }
 137
 138         $this->elementStart('div', array('id' => 'entity_members',
 139                                          'class' => 'section'));
 140
 141         if (Event::handle('StartShowGroupMembersMiniList', array($this))) {
 142
 143             // TRANS: Header for mini list of group members on a group page (h2).
 144             $this->elementStart('h2');
 145
 146             $this->element('a', array('href' => common_local_url('groupmembers', array('nickname' =>
 147                                                                                        $this->group->nickname))),
 148                            _('Members'));
 149
 150             $this->text(' ');
 151
 152             $this->text($this->group->getMemberCount());
 153
 154             $this->elementEnd('h2');
 155
 156             $gmml = new GroupMembersMiniList($member, $this);
 157             $cnt = $gmml->show();
 158             if ($cnt == 0) {
 159                 // TRANS: Description for mini list of group members on a group page when the group has no members.
 160                 $this->element('p', null, _('(None)'));
 161             }
 162
 163             // @todo FIXME: Should be shown if a group has more than 27 members, but I do not see it displayed at
 164             //              for example http://identi.ca/group/statusnet. Broken?
 165             if ($cnt > MEMBERS_PER_SECTION) {
 166                 $this->element('a', array('href' => common_local_url('groupmembers',
 167                                                                      array('nickname' => $this->group->nickname))),
 168                                // TRANS: Link to all group members from mini list of group members if group has more than n members.
 169                                _('All members'));
 170             }
 171
 172             Event::handle('EndShowGroupMembersMiniList', array($this));
 173         }
 174
 175         $this->elementEnd('div');
 176     }
 177
 178     function showPending()
 179     {
 180         if ($this->group->join_policy != User_group::JOIN_POLICY_MODERATE) {
 181             return;
 182         }
 183
 184         $pending = $this->group->getQueueCount();
 185
 186         if (!$pending) {
 187             return;
 188         }
 189
 190         $request = $this->group->getRequests(0, MEMBERS_PER_SECTION);
 191
 192         if (!$request) {
 193             return;
 194         }
 195
 196         $this->elementStart('div', array('id' => 'entity_pending',
 197                                          'class' => 'section'));
 198
 199         if (Event::handle('StartShowGroupPendingMiniList', array($this))) {
 200
 201             $this->elementStart('h2');
 202
 203             $this->element('a', array('href' => common_local_url('groupqueue', array('nickname' =>
 204                                                                                      $this->group->nickname))),
 205                            _('Pending'));
 206
 207             $this->text(' ');
 208
 209             $this->text($pending);
 210
 211             $this->elementEnd('h2');
 212
 213             $gmml = new ProfileMiniList($request, $this);
 214             $gmml->show();
 215
 216             Event::handle('EndShowGroupPendingMiniList', array($this));
 217         }
 218
 219         $this->elementEnd('div');
 220     }
 221
 222     function showBlocked()
 223     {
 224         $blocked = $this->group->getBlocked(0, MEMBERS_PER_SECTION);
 225
 226         if (!$blocked) {
 227             return;
 228         }
 229
 230         $this->elementStart('div', array('id' => 'entity_blocked',
 231                                          'class' => 'section'));
 232
 233         if (Event::handle('StartShowGroupBlockedMiniList', array($this))) {
 234
 235             $this->elementStart('h2');
 236
 237             $this->element('a', array('href' => common_local_url('blockedfromgroup', array('nickname' =>
 238                                                                                            $this->group->nickname))),
 239                            _('Blocked'));
 240
 241             $this->text(' ');
 242
 243             $this->text($this->group->getBlockedCount());
 244
 245             $this->elementEnd('h2');
 246
 247             $gmml = new GroupBlockedMiniList($blocked, $this);
 248             $cnt = $gmml->show();
 249             if ($cnt == 0) {
 250                 // TRANS: Description for mini list of group members on a group page when the group has no members.
 251                 $this->element('p', null, _('(None)'));
 252             }
 253
 254             // @todo FIXME: Should be shown if a group has more than 27 members, but I do not see it displayed at
 255             //              for example http://identi.ca/group/statusnet. Broken?
 256             if ($cnt > MEMBERS_PER_SECTION) {
 257                 $this->element('a', array('href' => common_local_url('blockedfromgroup',
 258                                                                      array('nickname' => $this->group->nickname))),
 259                                // TRANS: Link to all group members from mini list of group members if group has more than n members.
 260                                _('All members'));
 261             }
 262
 263             Event::handle('EndShowGroupBlockedMiniList', array($this));
 264         }
 265
 266         $this->elementEnd('div');
 267     }
 268
 269     /**
 270      * Show list of admins
 271      *
 272      * @return void
 273      */
 274     function showAdmins()
 275     {
 276         $adminSection = new GroupAdminSection($this, $this->group);
 277         $adminSection->show();
 278     }
 279
 280     function noticeFormOptions()
 281     {
 282         $options = parent::noticeFormOptions();
 283         $cur = common_current_user();
 284
 285         if (!empty($cur) && $cur->isMember($this->group)) {
 286             $options['to_group'] =  $this->group;
 287         }
 288
 289         return $options;
 290     }
 291 }
 292
 293 class GroupAdminSection extends ProfileSection
 294 {
 295     var $group;
 296
 297     function __construct($out, $group)
 298     {
 299         parent::__construct($out);
 300         $this->group = $group;
 301     }
 302
 303     function getProfiles()
 304     {
 305         return $this->group->getAdmins();
 306     }
 307
 308     function title()
 309     {
 310         // TRANS: Title for list of group administrators on a group page.
 311         return _m('TITLE','Admins');
 312     }
 313
 314     function divId()
 315     {
 316         return 'group_admins';
 317     }
 318
 319     function moreUrl()
 320     {
 321         return null;
 322     }
 323 }
 324
 325 class GroupMembersMiniList extends ProfileMiniList
 326 {
 327     function newListItem($profile)
 328     {
 329         return new GroupMembersMiniListItem($profile, $this->action);
 330     }
 331 }
 332
 333 class GroupMembersMiniListItem extends ProfileMiniListItem
 334 {
 335     function linkAttributes()
 336     {
 337         $aAttrs = parent::linkAttributes();
 338
 339         if (common_config('nofollow', 'members')) {
 340             $aAttrs['rel'] .= ' nofollow';
 341         }
 342
 343         return $aAttrs;
 344     }
 345 }
 346
 347 class GroupBlockedMiniList extends ProfileMiniList
 348 {
 349     function newListItem($profile)
 350     {
 351         return new GroupBlockedMiniListItem($profile, $this->action);
 352     }
 353 }
 354
 355 class GroupBlockedMiniListItem extends ProfileMiniListItem
 356 {
 357     function linkAttributes()
 358     {
 359         $aAttrs = parent::linkAttributes();
 360
 361         if (common_config('nofollow', 'members')) {
 362             $aAttrs['rel'] .= ' nofollow';
 363         }
 364
 365         return $aAttrs;
 366     }
 367 }
 368
 369 class ThreadingGroupNoticeStream extends ThreadingNoticeStream
 370 {
 371     function __construct($group, $profile)
 372     {
 373         parent::__construct(new GroupNoticeStream($group, $profile));
 374     }
 375 }