3 * StatusNet, the distributed open-source microblogging tool
5 * Show information about the relationship between two users
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/apibareauth.php';
37 * Outputs detailed information about the relationship between two users
41 * @author Zach Copley <zach@status.net>
42 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
43 * @link http://status.net/
46 class ApiFriendshipsShowAction extends ApiBareAuthAction
53 * Take arguments for running
55 * @param array $args $_REQUEST args
57 * @return boolean success flag
61 function prepare($args)
63 parent::prepare($args);
65 $source_id = (int)$this->trimmed('source_id');
66 $source_screen_name = $this->trimmed('source_screen_name');
67 $target_id = (int)$this->trimmed('target_id');
68 $target_screen_name = $this->trimmed('target_screen_name');
70 if (!empty($source_id)) {
71 $this->source = User::staticGet($source_id);
72 } elseif (!empty($source_screen_name)) {
73 $this->source = User::staticGet('nickname', $source_screen_name);
75 $this->source = $this->auth_user;
78 if (!empty($target_id)) {
79 $this->target = User::staticGet($target_id);
80 } elseif (!empty($target_screen_name)) {
81 $this->target = User::staticGet('nickname', $target_screen_name);
89 * Determines whether this API resource requires auth. Overloaded to look
90 * return true in case source_id and source_screen_name are both empty
92 * @return boolean true or false
95 function requiresAuth()
97 if (common_config('site', 'private')) {
101 $source_id = $this->trimmed('source_id');
102 $source_screen_name = $this->trimmed('source_screen_name');
104 if (empty($source_id) && empty($source_screen_name)) {
114 * Check the format and show the user info
116 * @param array $args $_REQUEST data (unused)
121 function handle($args)
123 parent::handle($args);
125 if (!in_array($this->format, array('xml', 'json'))) {
126 $this->clientError(_('API method not found!'), 404);
130 if (empty($this->source)) {
132 _('Could not determine source user.'),
138 if (empty($this->target)) {
140 _('Could not find target user.'),
146 $result = $this->twitterRelationshipArray($this->source, $this->target);
148 switch ($this->format) {
150 $this->initDocument('xml');
151 $this->showTwitterXmlRelationship($result[relationship]);
152 $this->endDocument('xml');
155 $this->initDocument('json');
156 print json_encode($result);
157 $this->endDocument('json');