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 Dan Moore <dan@moore.cx>
25 * @author Evan Prodromou <evan@status.net>
26 * @author Zach Copley <zach@status.net>
27 * @copyright 2009-2010 StatusNet, Inc.
28 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
29 * @link http://status.net/
32 if (!defined('GNUSOCIAL')) { exit(1); }
35 * Allows the authenticating users to unfollow (unsubscribe) the user specified in
36 * the ID parameter. Returns the unfollowed user in the requested format when
37 * successful. Returns a string describing the failure condition when unsuccessful.
41 * @author Dan Moore <dan@moore.cx>
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 ApiFriendshipsDestroyAction extends ApiAuthAction
49 protected $needPost = true;
51 protected $other = null;
54 * Take arguments for running
56 * @param array $args $_REQUEST args
58 * @return boolean success flag
61 protected function prepare(array $args=array())
63 parent::prepare($args);
65 $this->other = $this->getTargetProfile($this->arg('id'));
73 * Check the format and show the user info
77 protected function handle()
81 if (!in_array($this->format, array('xml', 'json'))) {
83 // TRANS: Client error displayed when coming across a non-supported API method.
84 _('API method not found.'),
89 if (!$this->other instanceof Profile) {
91 // TRANS: Client error displayed when trying to unfollow a user that cannot be found.
92 _('Could not unfollow user: User not found.'),
97 // Don't allow unsubscribing from yourself!
99 if ($this->scoped->id == $this->other->id) {
101 // TRANS: Client error displayed when trying to unfollow self.
102 _("You cannot unfollow yourself."),
107 // throws an exception on error
108 Subscription::cancel($this->scoped, $this->other);
110 $this->initDocument($this->format);
111 $this->showProfile($this->other, $this->format);
112 $this->endDocument($this->format);