3 * StatusNet, the distributed open-source microblogging tool
5 * Un-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 * Un-blocks the user specified in the ID parameter for the authenticating user.
37 * Returns the un-blocked user in the requested format when successful.
41 * @author Evan Prodromou <evan@status.net>
42 * @author Zach Copley <zach@status.net>
43 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
44 * @link http://status.net/
46 class ApiBlockDestroyAction extends ApiAuthAction
51 * Take arguments for running
53 * @param array $args $_REQUEST args
55 * @return boolean success flag
57 function prepare($args)
59 parent::prepare($args);
61 $this->user = $this->auth_user;
62 $this->other = $this->getTargetProfile($this->arg('id'));
70 * Save the new message
72 * @param array $args $_REQUEST data (unused)
76 function handle($args)
78 parent::handle($args);
80 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
82 // TRANS: Client error. POST is a HTTP command. It should not be translated.
83 _('This method requires a POST.'),
90 if (empty($this->user) || empty($this->other)) {
91 // TRANS: Client error when user not found for an API action to remove a block for a user.
92 $this->clientError(_('No such user.'), 404, $this->format);
96 if ($this->user->hasBlocked($this->other)) {
97 if (Event::handle('StartUnblockProfile', array($this->user, $this->other))) {
98 $result = $this->user->unblock($this->other);
100 Event::handle('EndUnblockProfile', array($this->user, $this->other));
105 if (!$this->user->hasBlocked($this->other)) {
106 $this->initDocument($this->format);
107 $this->showProfile($this->other, $this->format);
108 $this->endDocument($this->format);
110 // TRANS: Server error displayed when unblocking a user has failed.
111 $this->serverError(_('Unblock user failed.'));