apigroupprofileupdate.php 8.54 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
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Update a group's profile
 *
 * 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    Zach Copley <zach@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @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);
}

/**
 * API analog to the group edit page
 *
 * @category API
 * @package  StatusNet
 * @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 ApiGroupProfileUpdateAction extends ApiAuthAction
{
45
    protected $needPost = true;
46 47 48 49 50 51 52 53
    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     *
     */
54
    protected function prepare(array $args=array())
55 56 57
    {
        parent::prepare($args);

58
        $this->nickname    = Nickname::normalize($this->trimmed('nickname'));
59

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
        $this->fullname    = $this->trimmed('fullname');
        $this->homepage    = $this->trimmed('homepage');
        $this->description = $this->trimmed('description');
        $this->location    = $this->trimmed('location');
        $this->aliasstring = $this->trimmed('aliases');

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

        return true;
    }

    /**
     * Handle the request
     *
     * See which request params have been set, and update the profile
     *
     * @return void
     */
79
    protected function handle()
80
    {
81
        parent::handle();
82 83

        if (!in_array($this->format, array('xml', 'json'))) {
84 85
            // TRANS: Client error displayed when coming across a non-supported API method.
            $this->clientError(_('API method not found.'), 404);
86 87 88
        }

        if (empty($this->user)) {
89
            // TRANS: Client error displayed when not providing a user or an invalid user.
90
            $this->clientError(_('No such user.'), 404);
91 92 93
        }

        if (empty($this->group)) {
94
            // TRANS: Client error displayed when not providing a group or an invalid group.
95
            $this->clientError(_('Group not found.'), 404);
96 97 98
        }

        if (!$this->user->isAdmin($this->group)) {
99
            // TRANS: Client error displayed when trying to edit a group without being an admin.
100 101 102 103 104 105 106 107 108
            $this->clientError(_('You must be an admin to edit the group.'), 403);
        }

        $this->group->query('BEGIN');

        $orig = clone($this->group);

        try {

109
            if (common_config('profile', 'changenick') == true && $this->group->nickname !== $this->nickname) {
110 111 112 113
                try {
                    $this->group->nickname = Nickname::normalize($this->nickname, true);
                } catch (NicknameException $e) {
                    throw new ApiValidationException($e->getMessage());
114
                }
115 116
                $this->group->mainpage = common_local_url('showgroup',
                                            array('nickname' => $this->group->nickname));
117 118 119 120 121 122 123 124 125
            }

            if (!empty($this->fullname)) {
                $this->validateFullname();
                $this->group->fullname = $this->fullname;
            }

            if (!empty($this->homepage)) {
                $this->validateHomepage();
126
                $this->group->homepage = $this->homepage;
127 128 129 130 131 132 133 134 135 136 137 138 139
            }

            if (!empty($this->description)) {
                $this->validateDescription();
                $this->group->description = $this->decription;
            }

            if (!empty($this->location)) {
                $this->validateLocation();
                $this->group->location = $this->location;
            }

        } catch (ApiValidationException $ave) {
140
            $this->clientError($ave->getMessage(), 400);
141 142 143 144 145 146
        }

        $result = $this->group->update($orig);

        if (!$result) {
            common_log_db_error($this->group, 'UPDATE', __FILE__);
147
            // TRANS: Server error displayed when group update fails.
148 149 150
            $this->serverError(_('Could not update group.'));
        }

151
        $aliases = array();
152 153

        try {
154 155
            if (!empty($this->aliasstring)) {
                $aliases = $this->validateAliases();
156 157
            }
        } catch (ApiValidationException $ave) {
158
            $this->clientError($ave->getMessage(), 403);
159 160 161 162 163
        }

        $result = $this->group->setAliases($aliases);

        if (!$result) {
164
            // TRANS: Server error displayed when adding group aliases fails.
165 166 167 168 169 170 171 172 173 174 175 176 177
            $this->serverError(_('Could not create aliases.'));
        }

        $this->group->query('COMMIT');

        switch($this->format) {
        case 'xml':
            $this->showSingleXmlGroup($this->group);
            break;
        case 'json':
            $this->showSingleJsonGroup($this->group);
            break;
        default:
178
            // TRANS: Client error displayed when coming across a non-supported API method.
179
            $this->clientError(_('API method not found.'), 404);
180 181 182 183 184 185
        }
    }

    function validateHomepage()
    {
        if (!is_null($this->homepage)
186 187
                && (strlen($this->homepage) > 0)
                && !common_valid_http_url($this->homepage)) {
188
            throw new ApiValidationException(
189
                // TRANS: API validation exception thrown when homepage URL does not validate.
190 191 192 193 194 195 196 197 198
                _('Homepage is not a valid URL.')
            );
        }
    }

    function validateFullname()
    {
        if (!is_null($this->fullname) && mb_strlen($this->fullname) > 255) {
            throw new ApiValidationException(
199 200
                // TRANS: API validation exception thrown when full name does not validate.
                _('Full name is too long (maximum 255 characters).')
201 202 203 204 205 206 207
            );
        }
    }

    function validateDescription()
    {
        if (User_group::descriptionTooLong($this->description)) {
208 209 210 211 212 213
            // TRANS: API validation exception thrown when description does not validate.
            // TRANS: %d is the maximum description length and used for plural.
            throw new ApiValidationException(sprintf(_m('Description is too long (maximum %d character).',
                                                        'Description is too long (maximum %d characters).',
                                                        User_group::maxDescription()),
                                                     User_group::maxDescription()));
214 215 216 217 218 219 220
        }
    }

    function validateLocation()
    {
        if (!is_null($this->location) && mb_strlen($this->location) > 255) {
            throw new ApiValidationException(
221 222
                // TRANS: API validation exception thrown when location does not validate.
                _('Location is too long (maximum 255 characters).')
223 224 225 226 227 228
            );
        }
    }

    function validateAliases()
    {
229 230 231 232 233 234
        try {
            $aliases = array_map(array('Nickname', 'normalize'),
                            array_unique(preg_split('/[\s,]+/', $this->aliasstring)));
        } catch (NicknameException $e) {
            throw new ApiValidationException(sprintf('Error processing aliases: %s', $e->getMessage()));
        }
235 236

        if (count($aliases) > common_config('group', 'maxaliases')) {
237 238 239 240 241 242
            // TRANS: API validation exception thrown when aliases do not validate.
            // TRANS: %d is the maximum number of aliases and used for plural.
            throw new ApiValidationException(sprintf(_m('Too many aliases! Maximum %d allowed.',
                                                        'Too many aliases! Maximum %d allowed.',
                                                        common_config('group', 'maxaliases')),
                                                     common_config('group', 'maxaliases')));
243 244 245 246
        }

        return $aliases;
    }
247
}