We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

groupaction.php 9.53 KB
Newer Older
1 2
<?php
/**
3
 * StatusNet, the distributed open-source microblogging tool
4
 *
5
 * Base class for group actions
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @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('GNUSOCIAL')) { exit(1); }
31

32 33
define('MEMBERS_PER_SECTION', 27);

34
/**
35
 * Base class for group actions, similar to ProfileAction
36 37
 *
 * @category Action
38
 * @package  StatusNet
39
 * @author   Zach Copley <zach@status.net>
40
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
41
 * @link     http://status.net/
42
 */
43 44 45 46
class GroupAction extends Action
{
    protected $group;

47
    protected function prepare(array $args=array())
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
    {
        parent::prepare($args);

        $nickname_arg = $this->arg('nickname');
        $nickname = common_canonical_nickname($nickname_arg);

        // Permanent redirect on non-canonical nickname

        if ($nickname_arg != $nickname) {
            $args = array('nickname' => $nickname);
            if ($this->page != 1) {
                $args['page'] = $this->page;
            }
            common_redirect(common_local_url('showgroup', $args), 301);
        }

        if (!$nickname) {
            // TRANS: Client error displayed if no nickname argument was given requesting a group page.
            $this->clientError(_('No nickname.'), 404);
        }

69
        $local = Local_group::getKV('nickname', $nickname);
70 71

        if (!$local) {
72
            $alias = Group_alias::getKV('alias', $nickname);
73 74 75 76 77 78 79 80 81 82 83 84 85
            if ($alias) {
                $args = array('id' => $alias->group_id);
                if ($this->page != 1) {
                    $args['page'] = $this->page;
                }
                common_redirect(common_local_url('groupbyid', $args), 301);
            } else {
                common_log(LOG_NOTICE, "Couldn't find local group for nickname '$nickname'");
                // TRANS: Client error displayed if no remote group with a given name was found requesting group page.
                $this->clientError(_('No such group.'), 404);
            }
        }

86
        $this->group = User_group::getKV('id', $local->group_id);
87

88
        if (!$this->group instanceof User_group) {
89
            // TRANS: Client error displayed if no local group with a given name was found requesting group page.
90 91 92
            $this->clientError(_('No such group.'), 404);
        }
    }
93 94 95 96 97 98

    function showProfileBlock()
    {
        $block = new GroupProfileBlock($this, $this->group);
        $block->show();
    }
99 100 101 102 103 104 105 106 107

    /**
     * Fill in the sidebar.
     *
     * @return void
     */
    function showSections()
    {
        $this->showMembers();
108 109
        $cur = common_current_user();
        if ($cur && $cur->isAdmin($this->group)) {
Evan Prodromou's avatar
Evan Prodromou committed
110
            $this->showPending();
111 112
            $this->showBlocked();
        }
113

114
        $this->showAdmins();
115 116 117 118 119

        if (!common_config('performance', 'high')) {
            $cloud = new GroupTagCloudSection($this, $this->group);
            $cloud->show();
        }
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
    }

    /**
     * Show mini-list of members
     *
     * @return void
     */
    function showMembers()
    {
        $member = $this->group->getMembers(0, MEMBERS_PER_SECTION);

        if (!$member) {
            return;
        }

        $this->elementStart('div', array('id' => 'entity_members',
                                         'class' => 'section'));

        if (Event::handle('StartShowGroupMembersMiniList', array($this))) {
139 140 141 142
            $this->elementStart('h2');

            $this->element('a', array('href' => common_local_url('groupmembers', array('nickname' =>
                                                                                       $this->group->nickname))),
143
                           // TRANS: Header for mini list of group members on a group page (h2).
144 145 146 147 148
                           _('Members'));

            $this->text(' ');

            $this->text($this->group->getMemberCount());
149

150
            $this->elementEnd('h2');
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173

            $gmml = new GroupMembersMiniList($member, $this);
            $cnt = $gmml->show();
            if ($cnt == 0) {
                // TRANS: Description for mini list of group members on a group page when the group has no members.
                $this->element('p', null, _('(None)'));
            }

            // @todo FIXME: Should be shown if a group has more than 27 members, but I do not see it displayed at
            //              for example http://identi.ca/group/statusnet. Broken?
            if ($cnt > MEMBERS_PER_SECTION) {
                $this->element('a', array('href' => common_local_url('groupmembers',
                                                                     array('nickname' => $this->group->nickname))),
                               // TRANS: Link to all group members from mini list of group members if group has more than n members.
                               _('All members'));
            }

            Event::handle('EndShowGroupMembersMiniList', array($this));
        }

        $this->elementEnd('div');
    }

Evan Prodromou's avatar
Evan Prodromou committed
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
    function showPending()
    {
        if ($this->group->join_policy != User_group::JOIN_POLICY_MODERATE) {
            return;
        }

        $pending = $this->group->getQueueCount();

        if (!$pending) {
            return;
        }

        $request = $this->group->getRequests(0, MEMBERS_PER_SECTION);

        if (!$request) {
            return;
        }

        $this->elementStart('div', array('id' => 'entity_pending',
                                         'class' => 'section'));

        if (Event::handle('StartShowGroupPendingMiniList', array($this))) {
196

Evan Prodromou's avatar
Evan Prodromou committed
197 198 199 200
            $this->elementStart('h2');

            $this->element('a', array('href' => common_local_url('groupqueue', array('nickname' =>
                                                                                     $this->group->nickname))),
201
                           // TRANS: Header for mini list of users with a pending membership request on a group page (h2).
Evan Prodromou's avatar
Evan Prodromou committed
202 203 204 205 206
                           _('Pending'));

            $this->text(' ');

            $this->text($pending);
207

Evan Prodromou's avatar
Evan Prodromou committed
208 209 210 211 212 213 214 215 216 217 218
            $this->elementEnd('h2');

            $gmml = new ProfileMiniList($request, $this);
            $gmml->show();

            Event::handle('EndShowGroupPendingMiniList', array($this));
        }

        $this->elementEnd('div');
    }

219 220
    function showBlocked()
    {
Evan Prodromou's avatar
Evan Prodromou committed
221
        $blocked = $this->group->getBlocked(0, MEMBERS_PER_SECTION);
222 223 224 225 226

        $this->elementStart('div', array('id' => 'entity_blocked',
                                         'class' => 'section'));

        if (Event::handle('StartShowGroupBlockedMiniList', array($this))) {
227

228 229 230 231
            $this->elementStart('h2');

            $this->element('a', array('href' => common_local_url('blockedfromgroup', array('nickname' =>
                                                                                           $this->group->nickname))),
232
                           // TRANS: Header for mini list of users that are blocked in a group page (h2).
233 234 235 236 237
                           _('Blocked'));

            $this->text(' ');

            $this->text($this->group->getBlockedCount());
238

239 240
            $this->elementEnd('h2');

Evan Prodromou's avatar
Evan Prodromou committed
241
            $gmml = new GroupBlockedMiniList($blocked, $this);
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
            $cnt = $gmml->show();
            if ($cnt == 0) {
                // TRANS: Description for mini list of group members on a group page when the group has no members.
                $this->element('p', null, _('(None)'));
            }

            // @todo FIXME: Should be shown if a group has more than 27 members, but I do not see it displayed at
            //              for example http://identi.ca/group/statusnet. Broken?
            if ($cnt > MEMBERS_PER_SECTION) {
                $this->element('a', array('href' => common_local_url('blockedfromgroup',
                                                                     array('nickname' => $this->group->nickname))),
                               // TRANS: Link to all group members from mini list of group members if group has more than n members.
                               _('All members'));
            }

            Event::handle('EndShowGroupBlockedMiniList', array($this));
        }

        $this->elementEnd('div');
    }

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
    /**
     * Show list of admins
     *
     * @return void
     */
    function showAdmins()
    {
        $adminSection = new GroupAdminSection($this, $this->group);
        $adminSection->show();
    }

    function noticeFormOptions()
    {
        $options = parent::noticeFormOptions();
        $cur = common_current_user();

        if (!empty($cur) && $cur->isMember($this->group)) {
            $options['to_group'] =  $this->group;
        }

        return $options;
    }
285 286 287 288 289

    function getGroup()
    {
        return $this->group;
    }
290
}