apigroupjoin.php 4.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Join a group via the API
 *
 * 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  API
 * @package   StatusNet
Zach Copley's avatar
Zach Copley committed
24 25 26
 * @author    Craig Andrews <candrews@integralblue.com>
 * @author    Evan Prodromou <evan@status.net>
 * @author    Jeffery To <jeffery.to@gmail.com>
27 28
 * @author    Zach Copley <zach@status.net>
 * @copyright 2009 StatusNet, Inc.
29
 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

require_once INSTALLDIR . '/lib/apiauth.php';

/**
 * Joins the authenticated user to the group speicified by ID
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
45 46 47
 * @author   Craig Andrews <candrews@integralblue.com>
 * @author   Evan Prodromou <evan@status.net>
 * @author   Jeffery To <jeffery.to@gmail.com>
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
 * @author   Zach Copley <zach@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */
class ApiGroupJoinAction extends ApiAuthAction
{
    var $group   = null;

    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     */
    function prepare($args)
    {
        parent::prepare($args);

        $this->user  = $this->auth_user;
        $this->group = $this->getTargetGroup($this->arg('id'));

        return true;
    }

    /**
     * Handle the request
     *
     * Save the new message
     *
     * @param array $args $_REQUEST data (unused)
     *
     * @return void
     */
    function handle($args)
    {
        parent::handle($args);

        if ($_SERVER['REQUEST_METHOD'] != 'POST') {
            $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
88
                // TRANS: Client error. POST is a HTTP command. It should not be translated.
89 90 91 92 93 94 95 96
                _('This method requires a POST.'),
                400,
                $this->format
            );
            return;
        }

        if (empty($this->user)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
97
            // TRANS: Client error displayed when trying to have a non-existing user join a group.
98
            $this->clientError(_('No such user.'), 404, $this->format);
99 100 101 102
            return;
        }

        if (empty($this->group)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
103
            // TRANS: Client error displayed when trying to join a group that does not exist.
104
            $this->clientError(_('Group not found.'), 404, $this->format);
105 106 107 108 109
            return false;
        }

        if ($this->user->isMember($this->group)) {
            $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
110
                // TRANS: Server error displayed when trying to join a group the user is already a member of.
111 112 113 114 115 116 117 118 119
                _('You are already a member of that group.'),
                403,
                $this->format
            );
            return;
        }

        if (Group_block::isBlocked($this->group, $this->user->getProfile())) {
            $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
120
                // TRANS: Server error displayed when trying to join a group the user is blocked from joining.
121 122 123 124 125 126 127
                _('You have been blocked from that group by the admin.'),
                403,
                $this->format
            );
            return;
        }

128
        try {
129
            $this->user->joinGroup($this->group);
130 131 132 133 134 135
        } catch (Exception $e) {
            // TRANS: Server error displayed when joining a group failed in the database.
            // TRANS: %1$s is the joining user's nickname, $2$s is the group nickname for which the join failed.
            $this->serverError(sprintf(_('Could not join user %1$s to group %2$s.'),
                                       $cur->nickname, $this->group->nickname));
			return;
136 137 138 139
        }

        switch($this->format) {
        case 'xml':
140
            $this->showSingleXmlGroup($this->group);
141 142
            break;
        case 'json':
143
            $this->showSingleJsonGroup($this->group);
144 145 146
            break;
        default:
            $this->clientError(
147
                // TRANS: Client error displayed when coming across a non-supported API method.
148
                _('API method not found.'),
149 150 151 152 153 154 155
                404,
                $this->format
            );
            break;
        }
    }
}