apilistmembers.php 5.48 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 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * List/add/remove list members.
 *
 * 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
 * @author    Shashi Gowda <connect2shashi@gmail.com>
 * @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/apilistusers.php';

class ApiListMembersAction extends ApiListUsersAction
{
    /**
     * Add a user to a list (tag someone)
     *
     * @return boolean success
     */
    function handlePost()
    {
        if($this->auth_user->id != $this->list->tagger) {
            $this->clientError(
46 47
                // TRANS: Client error displayed when trying to add members to a list without having the right to do so.
                _('You are not allowed to add members to this list.'),
48 49 50 51 52 53 54 55
                401,
                $this->format
            );
            return false;
        }

        if($this->user === false) {
            $this->clientError(
56 57
                // TRANS: Client error displayed when trying to modify list members without specifying them.
                _('You must specify a member.'),
58 59 60 61 62 63 64 65 66 67 68
                400,
                $this->format
            );
            return false;
        }

        $result = Profile_tag::setTag($this->auth_user->id,
                        $this->user->id, $this->list->tag);

        if(empty($result)) {
            $this->clientError(
69
                // TRANS: Client error displayed when an unknown error occurs viewing list members.
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
                _('An error occured.'),
                500,
                $this->format
            );
            return false;
        }

        switch($this->format) {
        case 'xml':
            $this->showSingleXmlList($this->list);
            break;
        case 'json':
            $this->showSingleJsonList($this->list);
            break;
        default:
            $this->clientError(
86
                // TRANS: Client error displayed when coming across a non-supported API method.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
                _('API method not found.'),
                404,
                $this->format
            );
            return false;
            break;
        }
    }

    /**
     * Remove a user from a list (untag someone)
     *
     * @return boolean success
     */
    function handleDelete()
    {
        if($this->auth_user->id != $this->list->tagger) {
            $this->clientError(
105 106
                // TRANS: Client error displayed when trying to remove members from a list without having the right to do so.
                _('You are not allowed to remove members from this list.'),
107 108 109 110 111 112 113 114
                401,
                $this->format
            );
            return false;
        }

        if($this->user === false) {
            $this->clientError(
115 116
                // TRANS: Client error displayed when trying to modify list members without specifying them.
                _('You must specify a member.'),
117 118 119 120 121 122 123 124 125 126 127 128 129
                400,
                $this->format
            );
            return false;
        }

        $args = array('tagger' => $this->auth_user->id,
                      'tagged' => $this->user->id,
                      'tag' => $this->list->tag);
        $ptag = Profile_tag::pkeyGet($args);

        if(empty($ptag)) {
            $this->clientError(
130 131
                // TRANS: Client error displayed when trying to remove a list member that is not part of a list.
                _('The user you are trying to remove from the list is not a member.'),
132 133 134 135 136 137 138 139 140 141
                400,
                $this->format
            );
            return false;
        }

        $result = $ptag->delete();

        if(empty($result)) {
            $this->clientError(
142
                // TRANS: Client error displayed when an unknown error occurs viewing list members.
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
                _('An error occured.'),
                500,
                $this->format
            );
            return false;
        }

        switch($this->format) {
        case 'xml':
            $this->showSingleXmlList($this->list);
            break;
        case 'json':
            $this->showSingleJsonList($this->list);
            break;
        default:
            $this->clientError(
159
                // TRANS: Client error displayed when coming across a non-supported API method.
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
                _('API method not found.'),
                404,
                $this->format
            );
            return false;
            break;
        }
        return true;
    }

    /**
     * List the members of a list (people tagged)
     */
    function getUsers()
    {
        $fn = array($this->list, 'getTagged');
        list($this->users, $this->next_cursor, $this->prev_cursor) =
            Profile_list::getAtCursor($fn, array(), $this->cursor, 20);
    }
}