We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

apigroupcreate.php 10 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
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Create 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
 * @author    Craig Andrews <candrews@integralblue.com>
Zach Copley's avatar
Zach Copley committed
25 26
 * @author    Evan Prodromou <evan@status.net>
 * @author    Jeffery To <jeffery.to@gmail.com>
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
 * @author    Zach Copley <zach@status.net>
 * @copyright 2009 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';

/**
 * Make a new group. Sets the authenticated user as the administrator of the group.
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
44 45 46
 * @author   Craig Andrews <candrews@integralblue.com>
 * @author   Evan Prodromou <evan@status.net>
 * @author   Jeffery To <jeffery.to@gmail.com>
47 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 88 89 90 91 92 93 94 95 96 97 98 99 100 101
 * @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 ApiGroupCreateAction extends ApiAuthAction
{
    var $group       = null;
    var $nickname    = null;
    var $fullname    = null;
    var $homepage    = null;
    var $description = null;
    var $location    = null;
    var $aliasstring = null;
    var $aliases     = 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->nickname    = $this->arg('nickname');
        $this->fullname    = $this->arg('full_name');
        $this->homepage    = $this->arg('homepage');
        $this->description = $this->arg('description');
        $this->location    = $this->arg('location');
        $this->aliasstring = $this->arg('aliases');

        return true;
    }

    /**
     * Handle the request
     *
     * Save the new group
     *
     * @param array $args $_REQUEST data (unused)
     *
     * @return void
     */

    function handle($args)
    {
        parent::handle($args);

102 103 104 105 106 107 108
        if ($_SERVER['REQUEST_METHOD'] != 'POST') {
             $this->clientError(
                 _('This method requires a POST.'),
                 400,
                 $this->format
             );
             return;
109 110 111
        }

        if (empty($this->user)) {
112
            $this->clientError(_('No such user.'), 404, $this->format);
113 114 115 116 117 118 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 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
            return;
        }

        if ($this->validateParams() == false) {
            return;
        }

        $group = new User_group();

        $group->query('BEGIN');

        $group->nickname    = $this->nickname;
        $group->fullname    = $this->fullname;
        $group->homepage    = $this->homepage;
        $group->description = $this->description;
        $group->location    = $this->location;
        $group->created     = common_sql_now();

        $result = $group->insert();

        if (!$result) {
            common_log_db_error($group, 'INSERT', __FILE__);
            $this->serverError(
                _('Could not create group.'),
                500,
                $this->format
            );
            return;
        }

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

        if (!$result) {
            $this->serverError(
                _('Could not create aliases.'),
                500,
                $this->format
            );
            return;
        }

        $member = new Group_member();

        $member->group_id   = $group->id;
        $member->profile_id = $this->user->id;
        $member->is_admin   = 1;
        $member->created    = $group->created;

        $result = $member->insert();

        if (!$result) {
            common_log_db_error($member, 'INSERT', __FILE__);
            $this->serverError(
                _('Could not set group membership.'),
                500,
                $this->format
            );
            return;
        }

        $group->query('COMMIT');

        switch($this->format) {
        case 'xml':
            $this->showSingleXmlGroup($group);
            break;
        case 'json':
            $this->showSingleJsonGroup($group);
            break;
        default:
            $this->clientError(
                _('API method not found!'),
                404,
                $this->format
            );
            break;
        }

    }

    /**
     * Validate params for the new group
     *
     * @return void
     */

    function validateParams()
    {
201
        $valid = Validate::string(
202 203 204
            $this->nickname, array(
                'min_length' => 1,
                'max_length' => 64,
205
                'format' => NICKNAME_FMT
206
            )
207 208 209
        );

        if (!$valid) {
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
            $this->clientError(
                _(
                    'Nickname must have only lowercase letters ' .
                    'and numbers and no spaces.'
                ),
                403,
                $this->format
            );
            return false;
        } elseif ($this->groupNicknameExists($this->nickname)) {
            $this->clientError(
                _('Nickname already in use. Try another one.'),
                403,
                $this->format
            );
            return false;
        } else if (!User_group::allowedNickname($this->nickname)) {
            $this->clientError(
                _('Not a valid nickname.'),
                403,
                $this->format
            );
            return false;

234 235
        } elseif (
            !is_null($this->homepage)
236 237 238 239 240 241
            && strlen($this->homepage) > 0
            && !Validate::uri(
                $this->homepage, array(
                    'allowed_schemes' =>
                    array('http', 'https')
                )
242
            )) {
243 244 245 246 247 248
            $this->clientError(
                _('Homepage is not a valid URL.'),
                403,
                $this->format
            );
            return false;
249 250 251
        } elseif (
            !is_null($this->fullname)
            && mb_strlen($this->fullname) > 255) {
252 253 254 255 256 257 258
                $this->clientError(
                    _('Full name is too long (max 255 chars).'),
                    403,
                    $this->format
                );
            return false;
        } elseif (User_group::descriptionTooLong($this->description)) {
259 260 261 262 263 264 265 266
            $this->clientError(
                sprintf(
                    _('Description is too long (max %d chars).'),
                    User_group::maxDescription()
                ),
                403,
                $this->format
            );
267
            return false;
268 269 270
        } elseif (
            !is_null($this->location)
            && mb_strlen($this->location) > 255) {
271 272 273 274 275 276 277 278 279 280 281
                $this->clientError(
                    _('Location is too long (max 255 chars).'),
                    403,
                    $this->format
                );
            return false;
        }

        if (!empty($this->aliasstring)) {
            $this->aliases = array_map(
                'common_canonical_nickname',
282
                array_unique(preg_split('/[\s,]+/', $this->aliasstring))
283 284 285 286 287 288 289
            );
        } else {
            $this->aliases = array();
        }

        if (count($this->aliases) > common_config('group', 'maxaliases')) {
            $this->clientError(
290 291 292 293 294 295 296
                sprintf(
                    _('Too many aliases! Maximum %d.'),
                    common_config('group', 'maxaliases')
                ),
                403,
                $this->format
            );
297 298 299 300
            return false;
        }

        foreach ($this->aliases as $alias) {
301 302 303 304 305 306

            $valid = Validate::string(
                $alias, array(
                    'min_length' => 1,
                    'max_length' => 64,
                    'format' => NICKNAME_FMT
307
                )
308 309 310
            );

            if (!$valid) {
311 312 313 314 315 316 317 318 319
                $this->clientError(
                    sprintf(_('Invalid alias: "%s"'), $alias),
                    403,
                    $this->format
                );
                return false;
            }
            if ($this->groupNicknameExists($alias)) {
                $this->clientError(
320 321 322 323
                    sprintf(
                        _('Alias "%s" already in use. Try another one.'),
                        $alias
                    ),
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
                    403,
                    $this->format
                );
                return false;
            }

            // XXX assumes alphanum nicknames

            if (strcmp($alias, $this->nickname) == 0) {
                $this->clientError(
                    _('Alias can\'t be the same as nickname.'),
                    403,
                    $this->format
                );
                return false;
            }
        }

        // Evarything looks OK

        return true;
    }

347 348 349 350 351 352 353 354
    /**
     * Check to see whether a nickname is already in use by a group
     *
     * @param String $nickname The nickname in question
     *
     * @return boolean true or false
     */

355 356
    function groupNicknameExists($nickname)
    {
357
        $group = User_group::staticGet('nickname', $nickname);
358

359 360 361
        if (!empty($group)) {
            return true;
        }
362

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

365 366 367
        if (!empty($alias)) {
            return true;
        }
368

369
        return false;
370 371 372
    }

}