3 * StatusNet, the distributed open-source microblogging tool
5 * Subscribe to 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 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 follow (subscribe) the user specified in
38 * the ID parameter. Returns the befriended 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 ApiFriendshipsCreateAction extends ApiAuthAction
56 * Take arguments for running
58 * @param array $args $_REQUEST args
60 * @return boolean success flag
64 function prepare($args)
66 parent::prepare($args);
68 if ($this->requiresAuth()) {
69 if ($this->checkBasicAuthUser() == false) {
74 $this->format = $this->arg('format');
75 $this->user = $this->auth_user;
76 $this->other = $this->getTargetUser($id);
84 * Check the format and show the user info
86 * @param array $args $_REQUEST data (unused)
91 function handle($args)
93 parent::handle($args);
95 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
97 _('This method requires a POST.'),
104 if (!in_array($this->format, array('xml', 'json'))) {
106 _('API method not found!'),
113 if (empty($this->other)) {
115 _('Could not follow user: User not found.'),
122 if ($this->user->isSubscribed($this->other)) {
124 _('Could not follow user: %s is already on your list.'),
125 $this->other->nickname
127 $this->clientError($errmsg, 403, $this->format);
131 $result = subs_subscribe_to($this->user, $this->other);
133 if (is_string($result)) {
134 $this->clientError($result, 403, $this->format);
138 $this->init_document($this->format);
139 $this->show_profile($this->other, $this->format);
140 $this->end_document($this->format);