3 * StatusNet, the distributed open-source microblogging tool
5 * Block a user via the API
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Zach Copley <zach@status.net>
25 * @copyright 2009 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
34 require_once INSTALLDIR . '/lib/apiauth.php';
37 * Blocks the user specified in the ID parameter as the authenticating user.
38 * Destroys a friendship to the blocked user if it exists. Returns the
39 * blocked user in the requested format when successful.
43 * @author Zach Copley <zach@status.net>
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45 * @link http://status.net/
48 class ApiBlockCreateAction extends ApiAuthAction
54 * Take arguments for running
56 * @param array $args $_REQUEST args
58 * @return boolean success flag
62 function prepare($args)
64 parent::prepare($args);
66 if ($this->requiresAuth()) {
67 if ($this->checkBasicAuthUser() == false) {
72 $this->user = $this->auth_user;
73 $this->other = $this->getTargetUser($this->arg('id'));
81 * Save the new message
83 * @param array $args $_REQUEST data (unused)
88 function handle($args)
90 parent::handle($args);
92 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
94 _('This method requires a POST.'),
101 if (empty($this->user) || empty($this->other)) {
102 $this->clientError(_('No such user!'), 404, $this->format);
106 if ($this->user->hasBlocked($this->other)
107 || $this->user->block($this->other)
109 $this->init_document($this->format);
110 $this->show_profile($this->other, $this->format);
111 $this->end_document($this->format);
113 $this->serverError(_('Block user failed.'), 500, $this->format);