apigroupleave.php 4 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
 *
 * Leave 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
 * @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);
}

/**
 * Removes the authenticated user from the group specified by ID
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
43 44 45
 * @author   Craig Andrews <candrews@integralblue.com>
 * @author   Evan Prodromou <evan@status.net>
 * @author   Jeffery To <jeffery.to@gmail.com>
46 47 48 49 50 51
 * @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 ApiGroupLeaveAction extends ApiAuthAction
{
52 53
    protected $needPost = true;

54 55 56 57 58 59 60 61 62
    var $group   = null;

    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     */
63
    protected function prepare(array $args=array())
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
    {
        parent::prepare($args);

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

        return true;
    }

    /**
     * Handle the request
     *
     * Save the new message
     *
     * @return void
     */
79
    protected function handle()
80
    {
81
        parent::handle();
82

83
        if (!$this->scoped instanceof Profile) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
84
            // TRANS: Client error displayed when trying to have a non-existing user leave a group.
85
            $this->clientError(_('No such user.'), 404);
86 87
        }

88
        if (!$this->group instanceof User_group) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
89
            // TRANS: Client error displayed when trying to leave a group that does not exist.
90
            $this->clientError(_('Group not found.'), 404);
91 92 93 94 95
        }

        $member = new Group_member();

        $member->group_id   = $this->group->id;
96
        $member->profile_id = $this->scoped->id;
97 98

        if (!$member->find(true)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
99
            // TRANS: Server error displayed when trying to leave a group the user is not a member of.
100 101 102
            $this->serverError(_('You are not a member of this group.'));
        }

103
        try {
104
            $this->user->leaveGroup($this->group);
105 106 107 108
        } catch (Exception $e) {
            // TRANS: Server error displayed when leaving a group failed in the database.
            // TRANS: %1$s is the leaving user's nickname, $2$s is the group nickname for which the leave failed.
            $this->serverError(sprintf(_('Could not remove user %1$s from group %2$s.'),
109
                                       $this->scoped->getNickname(), $this->group->nickname));
110 111 112
        }
        switch($this->format) {
        case 'xml':
113
            $this->showSingleXmlGroup($this->group);
114 115
            break;
        case 'json':
116
            $this->showSingleJsonGroup($this->group);
117 118
            break;
        default:
119 120
            // TRANS: Client error displayed when coming across a non-supported API method.
            $this->clientError(_('API method not found.'), 404);
121 122 123
        }
    }
}