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

apiblockcreate.php 3.48 KB
Newer Older
Zach Copley's avatar
Zach Copley committed
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
 *
 * Block a user 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
 * @author    Evan Prodromou <evan@status.net>
Zach Copley's avatar
Zach Copley committed
25
 * @author    Zach Copley <zach@status.net>
26
 * @copyright 2009-2010 StatusNet, Inc.
Zach Copley's avatar
Zach Copley committed
27 28 29 30 31 32 33 34 35
 * @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);
}

/**
Zach Copley's avatar
Zach Copley committed
36 37
 * Blocks the user specified in the ID parameter as the authenticating user.
 * Destroys a friendship to the blocked user if it exists. Returns the
Zach Copley's avatar
Zach Copley committed
38 39 40 41
 * blocked user in the requested format when successful.
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
42
 * @author   Evan Prodromou <evan@status.net>
Zach Copley's avatar
Zach Copley committed
43 44 45 46 47 48
 * @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 ApiBlockCreateAction extends ApiAuthAction
{
49 50
    protected $needPost = true;

Zach Copley's avatar
Zach Copley committed
51 52 53 54 55 56 57 58 59 60
    var $other   = null;

    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     *
     */
61
    protected function prepare($args)
Zach Copley's avatar
Zach Copley committed
62 63 64
    {
        parent::prepare($args);

65
        $this->other  = $this->getTargetProfile($this->arg('id'));
Zach Copley's avatar
Zach Copley committed
66 67 68 69 70 71 72 73 74 75 76 77 78

        return true;
    }

    /**
     * Handle the request
     *
     * Save the new message
     *
     * @param array $args $_REQUEST data (unused)
     *
     * @return void
     */
79
    protected function handle()
Zach Copley's avatar
Zach Copley committed
80
    {
81
        parent::handle();
Zach Copley's avatar
Zach Copley committed
82

Zach Copley's avatar
Zach Copley committed
83
        if (empty($this->user) || empty($this->other)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
84
            // TRANS: Client error displayed when trying to block a non-existing user or a user from another site.
85
            $this->clientError(_('No such user.'), 404);
Zach Copley's avatar
Zach Copley committed
86
        }
Zach Copley's avatar
Zach Copley committed
87

88 89 90
        // Don't allow blocking yourself!

        if ($this->user->id == $this->other->id) {
91 92
            // TRANS: Client error displayed when users try to block themselves.
            $this->clientError(_("You cannot block yourself!"), 403);
93 94
        }

Evan Prodromou's avatar
Evan Prodromou committed
95 96 97 98 99 100 101 102 103 104
        if (!$this->user->hasBlocked($this->other)) {
            if (Event::handle('StartBlockProfile', array($this->user, $this->other))) {
                $result = $this->user->block($this->other);
                if ($result) {
                    Event::handle('EndBlockProfile', array($this->user, $this->other));
                }
            }
        }

        if ($this->user->hasBlocked($this->other)) {
105 106 107
            $this->initDocument($this->format);
            $this->showProfile($this->other, $this->format);
            $this->endDocument($this->format);
Zach Copley's avatar
Zach Copley committed
108
        } else {
109
            // TRANS: Server error displayed when blocking a user has failed.
110
            $this->serverError(_('Block user failed.'), 500);
Zach Copley's avatar
Zach Copley committed
111 112 113
        }
    }
}