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 Action
  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 showActions()
 171     {
 172         $this->startActions();
 173         $this->showSubscribeButton();
 174         $this->showGroupBlockForm();
 175         $this->endActions();
 176     }
 177
 178     function showGroupBlockForm()
 179     {
 180         $user = common_current_user();
 181
 182         if (!empty($user) && $user->id != $this->profile->id && $user->isAdmin($this->group)) {
 183             $bf = new GroupBlockForm($this->out, $this->profile,
 184                                 array('action' => 'groupmembers',
 185                                       'nickname' => $this->group->nickname));
 186             $bf->show();
 187         }
 188
 189     }
 190 }
 191
 192 /**
 193  * Form for blocking a user from a group
 194  *
 195  * @category Form
 196  * @package  Laconica
 197  * @author   Evan Prodromou <evan@controlyourself.ca>
 198  * @author   Sarven Capadisli <csarven@controlyourself.ca>
 199  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 200  * @link     http://laconi.ca/
 201  *
 202  * @see      BlockForm
 203  */
 204
 205 class GroupBlockForm extends Form
 206 {
 207     /**
 208      * Profile of user to block
 209      */
 210
 211     var $profile = null;
 212
 213     /**
 214      * Group to block the user from
 215      */
 216
 217     var $group = null;
 218
 219     /**
 220      * Return-to args
 221      */
 222
 223     var $args = null;
 224
 225     /**
 226      * Constructor
 227      *
 228      * @param HTMLOutputter $out     output channel
 229      * @param Profile       $profile profile of user to block
 230      * @param User_group    $group   group to block user from
 231      * @param array         $args    return-to args
 232      */
 233
 234     function __construct($out=null, $profile=null, $group=null, $args=null)
 235     {
 236         parent::__construct($out);
 237
 238         $this->profile = $profile;
 239         $this->group   = $group;
 240         $this->args    = $args;
 241     }
 242
 243     /**
 244      * ID of the form
 245      *
 246      * @return int ID of the form
 247      */
 248
 249     function id()
 250     {
 251         // This should be unique for the page.
 252         return 'block-' . $this->profile->id;
 253     }
 254
 255     /**
 256      * class of the form
 257      *
 258      * @return string class of the form
 259      */
 260
 261     function formClass()
 262     {
 263         return 'form_group_block';
 264     }
 265
 266     /**
 267      * Action of the form
 268      *
 269      * @return string URL of the action
 270      */
 271
 272     function action()
 273     {
 274         return common_local_url('groupblock');
 275     }
 276
 277     /**
 278      * Legend of the Form
 279      *
 280      * @return void
 281      */
 282     function formLegend()
 283     {
 284         $this->out->element('legend', null, _('Block user from group'));
 285     }
 286
 287     /**
 288      * Data elements of the form
 289      *
 290      * @return void
 291      */
 292
 293     function formData()
 294     {
 295         $this->out->hidden('blockto-' . $this->profile->id,
 296                            $this->profile->id,
 297                            'blockto');
 298         $this->out->hidden('blockgroup-' . $this->group->id,
 299                            $this->group->id,
 300                            'blockgroup');
 301         if ($this->args) {
 302             foreach ($this->args as $k => $v) {
 303                 $this->out->hidden('returnto-' . $k, $v);
 304             }
 305         }
 306     }
 307
 308     /**
 309      * Action elements
 310      *
 311      * @return void
 312      */
 313
 314     function formActions()
 315     {
 316         $this->out->submit('submit', _('Block'), 'submit', null, _('Block this user'));
 317     }
 318 }