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 Evan Prodromou <evan@status.net>
25 * @author Zach Copley <zach@status.net>
26 * @copyright 2009-2010 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
36 * Blocks the user specified in the ID parameter as the authenticating user.
37 * Destroys a friendship to the blocked user if it exists. Returns the
38 * blocked user in the requested format when successful.
42 * @author Evan Prodromou <evan@status.net>
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/
47 class ApiBlockCreateAction extends ApiAuthAction
52 * Take arguments for running
54 * @param array $args $_REQUEST args
56 * @return boolean success flag
59 function prepare($args)
61 parent::prepare($args);
63 $this->user = $this->auth_user;
64 $this->other = $this->getTargetProfile($this->arg('id'));
72 * Save the new message
74 * @param array $args $_REQUEST data (unused)
78 function handle($args)
80 parent::handle($args);
82 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
84 // TRANS: Client error. POST is a HTTP command. It should not be translated.
85 _('This method requires a POST.'),
92 if (empty($this->user) || empty($this->other)) {
93 // TRANS: Client error displayed when trying to block a non-existing user or a user from another site.
94 $this->clientError(_('No such user.'), 404, $this->format);
98 // Don't allow blocking yourself!
100 if ($this->user->id == $this->other->id) {
102 // TRANS: Client error displayed when users try to block themselves.
103 _("You cannot block yourself!"),
110 if (!$this->user->hasBlocked($this->other)) {
111 if (Event::handle('StartBlockProfile', array($this->user, $this->other))) {
112 $result = $this->user->block($this->other);
114 Event::handle('EndBlockProfile', array($this->user, $this->other));
119 if ($this->user->hasBlocked($this->other)) {
120 $this->initDocument($this->format);
121 $this->showProfile($this->other, $this->format);
122 $this->endDocument($this->format);
124 // TRANS: Server error displayed when blocking a user has failed.
125 $this->serverError(_('Block user failed.'), 500, $this->format);