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')) {
35 require_once INSTALLDIR . '/lib/apiauth.php';
38 * Blocks the user specified in the ID parameter as the authenticating user.
39 * Destroys a friendship to the blocked user if it exists. Returns the
40 * blocked user in the requested format when successful.
44 * @author Evan Prodromou <evan@status.net>
45 * @author Zach Copley <zach@status.net>
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47 * @link http://status.net/
49 class ApiBlockCreateAction extends ApiAuthAction
54 * Take arguments for running
56 * @param array $args $_REQUEST args
58 * @return boolean success flag
61 function prepare($args)
63 parent::prepare($args);
65 $this->user = $this->auth_user;
66 $this->other = $this->getTargetProfile($this->arg('id'));
74 * Save the new message
76 * @param array $args $_REQUEST data (unused)
80 function handle($args)
82 parent::handle($args);
84 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
86 // TRANS: Client error. POST is a HTTP command. It should not be translated.
87 _('This method requires a POST.'),
94 if (empty($this->user) || empty($this->other)) {
95 $this->clientError(_('No such user.'), 404, $this->format);
99 // Don't allow blocking yourself!
101 if ($this->user->id == $this->other->id) {
103 // TRANS: Client error displayed when users try to block themselves.
104 _("You cannot block yourself!"),
111 if (!$this->user->hasBlocked($this->other)) {
112 if (Event::handle('StartBlockProfile', array($this->user, $this->other))) {
113 $result = $this->user->block($this->other);
115 Event::handle('EndBlockProfile', array($this->user, $this->other));
120 if ($this->user->hasBlocked($this->other)) {
121 $this->initDocument($this->format);
122 $this->showProfile($this->other, $this->format);
123 $this->endDocument($this->format);
125 // TRANS: Server error displayed when blocking a user has failed.
126 $this->serverError(_('Block user failed.'), 500, $this->format);