apigroupprofileupdate.php 12.3 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 46 47 48 49 50 51 52 53 54 55 56 57 58 59
<?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);
}

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

/**
 * 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
{
    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     *
     */
    function prepare($args)
    {
        parent::prepare($args);

        $this->nickname    = common_canonical_nickname($this->trimmed('nickname'));
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
        $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
     *
     * @param array $args $_REQUEST data (unused)
     *
     * @return void
     */
    function handle($args)
    {
        parent::handle($args);

        if ($_SERVER['REQUEST_METHOD'] != 'POST') {
            $this->clientError(
88
                // TRANS: Client error message. 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 (!in_array($this->format, array('xml', 'json'))) {
            $this->clientError(
97
                // TRANS: Client error displayed when coming across a non-supported API method.
98 99 100 101 102 103 104 105
                _('API method not found.'),
                404,
                $this->format
            );
            return;
        }

        if (empty($this->user)) {
106
            // TRANS: Client error displayed when not providing a user or an invalid user.
107 108 109 110 111
            $this->clientError(_('No such user.'), 404, $this->format);
            return;
        }

        if (empty($this->group)) {
112
            // TRANS: Client error displayed when not providing a group or an invalid group.
113 114 115 116 117
            $this->clientError(_('Group not found.'), 404, $this->format);
            return false;
        }

        if (!$this->user->isAdmin($this->group)) {
118
            // TRANS: Client error displayed when trying to edit a group without being an admin.
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
            $this->clientError(_('You must be an admin to edit the group.'), 403);
            return false;
        }

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

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

        try {

            if (!empty($this->nickname)) {
                if ($this->validateNickname()) {
                    $this->group->nickname = $this->nickname;
                    $this->group->mainpage = common_local_url(
                        'showgroup',
                        array('nickname' => $this->nickname)
                    );
                }
            }

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

            if (!empty($this->homepage)) {
                $this->validateHomepage();
                $this->group->homepage = $this->hompage;
            }

            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) {
            $this->clientError(
                $ave->getMessage(),
                403,
                $this->format
            );
            return;
        }

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

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

176
        $aliases = array();
177 178

        try {
179 180
            if (!empty($this->aliasstring)) {
                $aliases = $this->validateAliases();
181 182 183 184 185 186 187 188 189 190 191 192 193 194
            }

        } catch (ApiValidationException $ave) {
            $this->clientError(
                $ave->getMessage(),
                403,
                $this->format
            );
            return;
        }

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

        if (!$result) {
195
            // TRANS: Server error displayed when adding group aliases fails.
196 197 198
            $this->serverError(_('Could not create aliases.'));
        }

199
        if (!empty($this->nickname) && ($this->nickname != $orig->nickname)) {
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
            common_log(LOG_INFO, "Saving local group info.");
            $local = Local_group::staticGet('group_id', $this->group->id);
            $local->setNickname($this->nickname);
        }

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

        switch($this->format) {
        case 'xml':
            $this->showSingleXmlGroup($this->group);
            break;
        case 'json':
            $this->showSingleJsonGroup($this->group);
            break;
        default:
215
            // TRANS: Client error displayed when coming across a non-supported API method.
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
            $this->clientError(_('API method not found.'), 404, $this->format);
            break;
        }
    }

    function nicknameExists($nickname)
    {
        $group = Local_group::staticGet('nickname', $nickname);

        if (!empty($group) &&
            $group->group_id != $this->group->id) {
            return true;
        }

        $alias = Group_alias::staticGet('alias', $nickname);

        if (!empty($alias) &&
            $alias->group_id != $this->group->id) {
            return true;
        }

        return false;
    }

    function validateNickname()
    {
        if (!Validate::string(
            $this->nickname, array(
                'min_length' => 1,
                'max_length' => 64,
                'format' => NICKNAME_FMT
                )
            )
        ) {
            throw new ApiValidationException(
251 252
                // TRANS: API validation exception thrown when nickname does not validate.
                _('Nickname must have only lowercase letters and numbers and no spaces.')
253 254 255
            );
        } else if ($this->nicknameExists($this->nickname)) {
            throw new ApiValidationException(
256
                // TRANS: API validation exception thrown when nickname is already used.
257 258 259 260
                _('Nickname already in use. Try another one.')
            );
        } else if (!User_group::allowedNickname($this->nickname)) {
            throw new ApiValidationException(
261
                // TRANS: API validation exception thrown when nickname does not validate.
262 263 264
                _('Not a valid nickname.')
            );
        }
265 266

		return true;
267 268 269 270 271 272 273 274 275 276 277 278 279
    }

    function validateHomepage()
    {
        if (!is_null($this->homepage)
        && (strlen($this->homepage) > 0)
        && !Validate::uri(
                $this->homepage,
                array('allowed_schemes' => array('http', 'https')
                )
            )
        ) {
            throw new ApiValidationException(
280
                // TRANS: API validation exception thrown when homepage URL does not validate.
281 282 283 284 285 286 287 288 289
                _('Homepage is not a valid URL.')
            );
        }
    }

    function validateFullname()
    {
        if (!is_null($this->fullname) && mb_strlen($this->fullname) > 255) {
            throw new ApiValidationException(
290 291
                // TRANS: API validation exception thrown when full name does not validate.
                _('Full name is too long (maximum 255 characters).')
292 293 294 295 296 297 298
            );
        }
    }

    function validateDescription()
    {
        if (User_group::descriptionTooLong($this->description)) {
299 300 301 302 303 304
            // 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()));
305 306 307 308 309 310 311
        }
    }

    function validateLocation()
    {
        if (!is_null($this->location) && mb_strlen($this->location) > 255) {
            throw new ApiValidationException(
312 313
                // TRANS: API validation exception thrown when location does not validate.
                _('Location is too long (maximum 255 characters).')
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
            );
        }
    }

    function validateAliases()
    {
        $aliases = array_map(
            'common_canonical_nickname',
            array_unique(
                preg_split('/[\s,]+/',
                $this->aliasstring
                )
            )
        );

        if (count($aliases) > common_config('group', 'maxaliases')) {
330 331 332 333 334 335
            // 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')));
336 337 338 339 340 341 342 343 344 345 346 347
        }

        foreach ($aliases as $alias) {
            if (!Validate::string(
                $alias, array(
                    'min_length' => 1,
                    'max_length' => 64,
                    'format' => NICKNAME_FMT)
                )
            ) {
                throw new ApiValidationException(
                    sprintf(
348 349 350
                        // TRANS: API validation exception thrown when aliases does not validate.
                        // TRANS: %s is the invalid alias.
                        _('Invalid alias: "%s".'),
351 352 353 354 355 356 357 358
                        $alias
                    )
                );
            }

            if ($this->nicknameExists($alias)) {
                throw new ApiValidationException(
                    sprintf(
359 360
                        // TRANS: API validation exception thrown when aliases is already used.
                        // TRANS: %s is the already used alias.
361 362 363 364 365 366
                        _('Alias "%s" already in use. Try another one.'),
                        $alias)
                );
            }

            // XXX assumes alphanum nicknames
367
            if (strcmp($alias, $this->nickname) == 0) {
368
                throw new ApiValidationException(
369 370
                    // TRANS: API validation exception thrown when alias is the same as nickname.
                    _('Alias cannot be the same as nickname.')
371 372 373 374 375 376
                );
            }
        }

        return $aliases;
    }
377
}