3 * StatusNet, the distributed open-source microblogging tool
5 * Unsubscribe to a user via 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 * Allows the authenticating users to unfollow (unsubscribe) the user specified in
38 * the ID parameter. Returns the unfollowed user in the requested format when
39 * successful. Returns a string describing the failure condition when unsuccessful.
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 ApiFriendshipsDestroyAction 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 $this->user = $this->auth_user;
67 $this->other = $this->getTargetUser($id);
75 * Check the format and show the user info
77 * @param array $args $_REQUEST data (unused)
82 function handle($args)
84 parent::handle($args);
86 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
88 _('This method requires a POST.'),
95 if (!in_array($this->format, array('xml', 'json'))) {
97 _('API method not found!'),
104 if (empty($this->other)) {
106 _('Could not unfollow user: User not found.'),
113 // Don't allow unsubscribing from yourself!
115 if ($this->user->id == $this->other->id) {
117 _("You cannot unfollow yourself!"),
124 $result = subs_unsubscribe_user($this->user, $this->other->nickname);
126 if (is_string($result)) {
127 $this->clientError($result, 403, $this->format);
131 $this->init_document($this->format);
132 $this->show_profile($this->other, $this->format);
133 $this->end_document($this->format);