actions/groupmembers.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @copyright 2008-2009 Control Yourself, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://laconi.ca/
  28  */
  29
  30 if (!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  Laconica
  42  * @author   Evan Prodromou <evan@controlyourself.ca>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link     http://laconi.ca/
  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         $this->showSubscribeButton();
 183         $this->showMakeAdminForm();
 184         $this->showGroupBlockForm();
 185         $this->endActions();
 186     }
 187
 188     function showMakeAdminForm()
 189     {
 190         $user = common_current_user();
 191
 192         if (!empty($user) && $user->id != $this->profile->id && $user->isAdmin($this->group) &&
 193             !$this->profile->isAdmin($this->group)) {
 194             $this->out->elementStart('li', 'entity_make_admin');
 195             $maf = new MakeAdminForm($this->out, $this->profile, $this->group,
 196                                      array('action' => 'groupmembers',
 197                                            'nickname' => $this->group->nickname));
 198             $maf->show();
 199             $this->out->elementEnd('li');
 200         }
 201
 202     }
 203     function showGroupBlockForm()
 204     {
 205         $user = common_current_user();
 206
 207         if (!empty($user) && $user->id != $this->profile->id && $user->isAdmin($this->group)) {
 208             $this->out->elementStart('li', 'entity_block');
 209             $bf = new GroupBlockForm($this->out, $this->profile, $this->group,
 210                                 array('action' => 'groupmembers',
 211                                       'nickname' => $this->group->nickname));
 212             $bf->show();
 213             $this->out->elementEnd('li');
 214         }
 215
 216     }
 217 }
 218
 219 /**
 220  * Form for blocking a user from a group
 221  *
 222  * @category Form
 223  * @package  Laconica
 224  * @author   Evan Prodromou <evan@controlyourself.ca>
 225  * @author   Sarven Capadisli <csarven@controlyourself.ca>
 226  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 227  * @link     http://laconi.ca/
 228  *
 229  * @see      BlockForm
 230  */
 231
 232 class GroupBlockForm extends Form
 233 {
 234     /**
 235      * Profile of user to block
 236      */
 237
 238     var $profile = null;
 239
 240     /**
 241      * Group to block the user from
 242      */
 243
 244     var $group = null;
 245
 246     /**
 247      * Return-to args
 248      */
 249
 250     var $args = null;
 251
 252     /**
 253      * Constructor
 254      *
 255      * @param HTMLOutputter $out     output channel
 256      * @param Profile       $profile profile of user to block
 257      * @param User_group    $group   group to block user from
 258      * @param array         $args    return-to args
 259      */
 260
 261     function __construct($out=null, $profile=null, $group=null, $args=null)
 262     {
 263         parent::__construct($out);
 264
 265         $this->profile = $profile;
 266         $this->group   = $group;
 267         $this->args    = $args;
 268     }
 269
 270     /**
 271      * ID of the form
 272      *
 273      * @return int ID of the form
 274      */
 275
 276     function id()
 277     {
 278         // This should be unique for the page.
 279         return 'block-' . $this->profile->id;
 280     }
 281
 282     /**
 283      * class of the form
 284      *
 285      * @return string class of the form
 286      */
 287
 288     function formClass()
 289     {
 290         return 'form_group_block';
 291     }
 292
 293     /**
 294      * Action of the form
 295      *
 296      * @return string URL of the action
 297      */
 298
 299     function action()
 300     {
 301         return common_local_url('groupblock');
 302     }
 303
 304     /**
 305      * Legend of the Form
 306      *
 307      * @return void
 308      */
 309     function formLegend()
 310     {
 311         $this->out->element('legend', null, _('Block user from group'));
 312     }
 313
 314     /**
 315      * Data elements of the form
 316      *
 317      * @return void
 318      */
 319
 320     function formData()
 321     {
 322         $this->out->hidden('blockto-' . $this->profile->id,
 323                            $this->profile->id,
 324                            'blockto');
 325         $this->out->hidden('blockgroup-' . $this->group->id,
 326                            $this->group->id,
 327                            'blockgroup');
 328         if ($this->args) {
 329             foreach ($this->args as $k => $v) {
 330                 $this->out->hidden('returnto-' . $k, $v);
 331             }
 332         }
 333     }
 334
 335     /**
 336      * Action elements
 337      *
 338      * @return void
 339      */
 340
 341     function formActions()
 342     {
 343         $this->out->submit('submit', _('Block'), 'submit', null, _('Block this user'));
 344     }
 345 }
 346
 347 /**
 348  * Form for making a user an admin for a group
 349  *
 350  * @category Form
 351  * @package  Laconica
 352  * @author   Evan Prodromou <evan@controlyourself.ca>
 353  * @author   Sarven Capadisli <csarven@controlyourself.ca>
 354  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 355  * @link     http://laconi.ca/
 356  */
 357
 358 class MakeAdminForm extends Form
 359 {
 360     /**
 361      * Profile of user to block
 362      */
 363
 364     var $profile = null;
 365
 366     /**
 367      * Group to block the user from
 368      */
 369
 370     var $group = null;
 371
 372     /**
 373      * Return-to args
 374      */
 375
 376     var $args = null;
 377
 378     /**
 379      * Constructor
 380      *
 381      * @param HTMLOutputter $out     output channel
 382      * @param Profile       $profile profile of user to block
 383      * @param User_group    $group   group to block user from
 384      * @param array         $args    return-to args
 385      */
 386
 387     function __construct($out=null, $profile=null, $group=null, $args=null)
 388     {
 389         parent::__construct($out);
 390
 391         $this->profile = $profile;
 392         $this->group   = $group;
 393         $this->args    = $args;
 394     }
 395
 396     /**
 397      * ID of the form
 398      *
 399      * @return int ID of the form
 400      */
 401
 402     function id()
 403     {
 404         // This should be unique for the page.
 405         return 'makeadmin-' . $this->profile->id;
 406     }
 407
 408     /**
 409      * class of the form
 410      *
 411      * @return string class of the form
 412      */
 413
 414     function formClass()
 415     {
 416         return 'form_make_admin';
 417     }
 418
 419     /**
 420      * Action of the form
 421      *
 422      * @return string URL of the action
 423      */
 424
 425     function action()
 426     {
 427         return common_local_url('makeadmin', array('nickname' => $this->group->nickname));
 428     }
 429
 430     /**
 431      * Legend of the Form
 432      *
 433      * @return void
 434      */
 435
 436     function formLegend()
 437     {
 438         $this->out->element('legend', null, _('Make user an admin of the group'));
 439     }
 440
 441     /**
 442      * Data elements of the form
 443      *
 444      * @return void
 445      */
 446
 447     function formData()
 448     {
 449         $this->out->hidden('profileid-' . $this->profile->id,
 450                            $this->profile->id,
 451                            'profileid');
 452         $this->out->hidden('groupid-' . $this->group->id,
 453                            $this->group->id,
 454                            'groupid');
 455         if ($this->args) {
 456             foreach ($this->args as $k => $v) {
 457                 $this->out->hidden('returnto-' . $k, $v);
 458             }
 459         }
 460     }
 461
 462     /**
 463      * Action elements
 464      *
 465      * @return void
 466      */
 467
 468     function formActions()
 469     {
 470         $this->out->submit('submit', _('Make Admin'), 'submit', null, _('Make this user an admin'));
 471     }
 472 }