actions/groupmembers.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * List of group members
   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  Group
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2008-2009 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 require_once(INSTALLDIR.'/lib/profilelist.php');
  35 require_once INSTALLDIR.'/lib/publicgroupnav.php';
  36
  37 /**
  38  * List of group members
  39  *
  40  * @category Group
  41  * @package  StatusNet
  42  * @author   Evan Prodromou <evan@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link     http://status.net/
  45  */
  46
  47 class GroupmembersAction extends GroupDesignAction
  48 {
  49     var $page = null;
  50
  51     function isReadOnly($args)
  52     {
  53         return true;
  54     }
  55
  56     function prepare($args)
  57     {
  58         parent::prepare($args);
  59         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
  60
  61         $nickname_arg = $this->arg('nickname');
  62         $nickname = common_canonical_nickname($nickname_arg);
  63
  64         // Permanent redirect on non-canonical nickname
  65
  66         if ($nickname_arg != $nickname) {
  67             $args = array('nickname' => $nickname);
  68             if ($this->page != 1) {
  69                 $args['page'] = $this->page;
  70             }
  71             common_redirect(common_local_url('groupmembers', $args), 301);
  72             return false;
  73         }
  74
  75         if (!$nickname) {
  76             $this->clientError(_('No nickname'), 404);
  77             return false;
  78         }
  79
  80         $this->group = User_group::staticGet('nickname', $nickname);
  81
  82         if (!$this->group) {
  83             $this->clientError(_('No such group'), 404);
  84             return false;
  85         }
  86
  87         return true;
  88     }
  89
  90     function title()
  91     {
  92         if ($this->page == 1) {
  93             return sprintf(_('%s group members'),
  94                            $this->group->nickname);
  95         } else {
  96             return sprintf(_('%s group members, page %d'),
  97                            $this->group->nickname,
  98                            $this->page);
  99         }
 100     }
 101
 102     function handle($args)
 103     {
 104         parent::handle($args);
 105         $this->showPage();
 106     }
 107
 108     function showPageNotice()
 109     {
 110         $this->element('p', 'instructions',
 111                        _('A list of the users in this group.'));
 112     }
 113
 114     function showLocalNav()
 115     {
 116         $nav = new GroupNav($this, $this->group);
 117         $nav->show();
 118     }
 119
 120     function showContent()
 121     {
 122         $offset = ($this->page-1) * PROFILES_PER_PAGE;
 123         $limit =  PROFILES_PER_PAGE + 1;
 124
 125         $cnt = 0;
 126
 127         $members = $this->group->getMembers($offset, $limit);
 128
 129         if ($members) {
 130             $member_list = new GroupMemberList($members, $this->group, $this);
 131             $cnt = $member_list->show();
 132         }
 133
 134         $members->free();
 135
 136         $this->pagination($this->page > 1, $cnt > PROFILES_PER_PAGE,
 137                           $this->page, 'groupmembers',
 138                           array('nickname' => $this->group->nickname));
 139     }
 140 }
 141
 142 class GroupMemberList extends ProfileList
 143 {
 144     var $group = null;
 145
 146     function __construct($profile, $group, $action)
 147     {
 148         parent::__construct($profile, $action);
 149
 150         $this->group = $group;
 151     }
 152
 153     function newListItem($profile)
 154     {
 155         return new GroupMemberListItem($profile, $this->group, $this->action);
 156     }
 157 }
 158
 159 class GroupMemberListItem extends ProfileListItem
 160 {
 161     var $group = null;
 162
 163     function __construct($profile, $group, $action)
 164     {
 165         parent::__construct($profile, $action);
 166
 167         $this->group = $group;
 168     }
 169
 170     function showFullName()
 171     {
 172         parent::showFullName();
 173         if ($this->profile->isAdmin($this->group)) {
 174             $this->out->text(' ');
 175             $this->out->element('span', 'role', _('Admin'));
 176         }
 177     }
 178
 179     function showActions()
 180     {
 181         $this->startActions();
 182         if (Event::handle('StartProfileListItemActionElements', array($this))) {
 183             $this->showSubscribeButton();
 184             $this->showMakeAdminForm();
 185             $this->showGroupBlockForm();
 186             Event::handle('EndProfileListItemActionElements', array($this));
 187         }
 188         $this->endActions();
 189     }
 190
 191     function showMakeAdminForm()
 192     {
 193         $user = common_current_user();
 194
 195         if (!empty($user) && $user->id != $this->profile->id && $user->isAdmin($this->group) &&
 196             !$this->profile->isAdmin($this->group)) {
 197             $this->out->elementStart('li', 'entity_make_admin');
 198             $maf = new MakeAdminForm($this->out, $this->profile, $this->group,
 199                                      array('action' => 'groupmembers',
 200                                            'nickname' => $this->group->nickname));
 201             $maf->show();
 202             $this->out->elementEnd('li');
 203         }
 204
 205     }
 206     function showGroupBlockForm()
 207     {
 208         $user = common_current_user();
 209
 210         if (!empty($user) && $user->id != $this->profile->id && $user->isAdmin($this->group)) {
 211             $this->out->elementStart('li', 'entity_block');
 212             $bf = new GroupBlockForm($this->out, $this->profile, $this->group,
 213                                 array('action' => 'groupmembers',
 214                                       'nickname' => $this->group->nickname));
 215             $bf->show();
 216             $this->out->elementEnd('li');
 217         }
 218
 219     }
 220 }
 221
 222 /**
 223  * Form for blocking a user from a group
 224  *
 225  * @category Form
 226  * @package  StatusNet
 227  * @author   Evan Prodromou <evan@status.net>
 228  * @author   Sarven Capadisli <csarven@status.net>
 229  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 230  * @link     http://status.net/
 231  *
 232  * @see      BlockForm
 233  */
 234
 235 class GroupBlockForm extends Form
 236 {
 237     /**
 238      * Profile of user to block
 239      */
 240
 241     var $profile = null;
 242
 243     /**
 244      * Group to block the user from
 245      */
 246
 247     var $group = null;
 248
 249     /**
 250      * Return-to args
 251      */
 252
 253     var $args = null;
 254
 255     /**
 256      * Constructor
 257      *
 258      * @param HTMLOutputter $out     output channel
 259      * @param Profile       $profile profile of user to block
 260      * @param User_group    $group   group to block user from
 261      * @param array         $args    return-to args
 262      */
 263
 264     function __construct($out=null, $profile=null, $group=null, $args=null)
 265     {
 266         parent::__construct($out);
 267
 268         $this->profile = $profile;
 269         $this->group   = $group;
 270         $this->args    = $args;
 271     }
 272
 273     /**
 274      * ID of the form
 275      *
 276      * @return int ID of the form
 277      */
 278
 279     function id()
 280     {
 281         // This should be unique for the page.
 282         return 'block-' . $this->profile->id;
 283     }
 284
 285     /**
 286      * class of the form
 287      *
 288      * @return string class of the form
 289      */
 290
 291     function formClass()
 292     {
 293         return 'form_group_block';
 294     }
 295
 296     /**
 297      * Action of the form
 298      *
 299      * @return string URL of the action
 300      */
 301
 302     function action()
 303     {
 304         return common_local_url('groupblock');
 305     }
 306
 307     /**
 308      * Legend of the Form
 309      *
 310      * @return void
 311      */
 312     function formLegend()
 313     {
 314         $this->out->element('legend', null, _('Block user from group'));
 315     }
 316
 317     /**
 318      * Data elements of the form
 319      *
 320      * @return void
 321      */
 322
 323     function formData()
 324     {
 325         $this->out->hidden('blockto-' . $this->profile->id,
 326                            $this->profile->id,
 327                            'blockto');
 328         $this->out->hidden('blockgroup-' . $this->group->id,
 329                            $this->group->id,
 330                            'blockgroup');
 331         if ($this->args) {
 332             foreach ($this->args as $k => $v) {
 333                 $this->out->hidden('returnto-' . $k, $v);
 334             }
 335         }
 336     }
 337
 338     /**
 339      * Action elements
 340      *
 341      * @return void
 342      */
 343
 344     function formActions()
 345     {
 346         $this->out->submit('submit', _('Block'), 'submit', null, _('Block this user'));
 347     }
 348 }
 349
 350 /**
 351  * Form for making a user an admin for a group
 352  *
 353  * @category Form
 354  * @package  StatusNet
 355  * @author   Evan Prodromou <evan@status.net>
 356  * @author   Sarven Capadisli <csarven@status.net>
 357  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 358  * @link     http://status.net/
 359  */
 360
 361 class MakeAdminForm extends Form
 362 {
 363     /**
 364      * Profile of user to block
 365      */
 366
 367     var $profile = null;
 368
 369     /**
 370      * Group to block the user from
 371      */
 372
 373     var $group = null;
 374
 375     /**
 376      * Return-to args
 377      */
 378
 379     var $args = null;
 380
 381     /**
 382      * Constructor
 383      *
 384      * @param HTMLOutputter $out     output channel
 385      * @param Profile       $profile profile of user to block
 386      * @param User_group    $group   group to block user from
 387      * @param array         $args    return-to args
 388      */
 389
 390     function __construct($out=null, $profile=null, $group=null, $args=null)
 391     {
 392         parent::__construct($out);
 393
 394         $this->profile = $profile;
 395         $this->group   = $group;
 396         $this->args    = $args;
 397     }
 398
 399     /**
 400      * ID of the form
 401      *
 402      * @return int ID of the form
 403      */
 404
 405     function id()
 406     {
 407         // This should be unique for the page.
 408         return 'makeadmin-' . $this->profile->id;
 409     }
 410
 411     /**
 412      * class of the form
 413      *
 414      * @return string class of the form
 415      */
 416
 417     function formClass()
 418     {
 419         return 'form_make_admin';
 420     }
 421
 422     /**
 423      * Action of the form
 424      *
 425      * @return string URL of the action
 426      */
 427
 428     function action()
 429     {
 430         return common_local_url('makeadmin', array('nickname' => $this->group->nickname));
 431     }
 432
 433     /**
 434      * Legend of the Form
 435      *
 436      * @return void
 437      */
 438
 439     function formLegend()
 440     {
 441         $this->out->element('legend', null, _('Make user an admin of the group'));
 442     }
 443
 444     /**
 445      * Data elements of the form
 446      *
 447      * @return void
 448      */
 449
 450     function formData()
 451     {
 452         $this->out->hidden('profileid-' . $this->profile->id,
 453                            $this->profile->id,
 454                            'profileid');
 455         $this->out->hidden('groupid-' . $this->group->id,
 456                            $this->group->id,
 457                            'groupid');
 458         if ($this->args) {
 459             foreach ($this->args as $k => $v) {
 460                 $this->out->hidden('returnto-' . $k, $v);
 461             }
 462         }
 463     }
 464
 465     /**
 466      * Action elements
 467      *
 468      * @return void
 469      */
 470
 471     function formActions()
 472     {
 473         $this->out->submit('submit', _('Make Admin'), 'submit', null, _('Make this user an admin'));
 474     }
 475 }