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
55 * Take arguments for running
57 * @param array $args $_REQUEST args
59 * @return boolean success flag
63 function prepare($args)
65 parent::prepare($args);
67 if ($this->requiresAuth()) {
68 if ($this->checkBasicAuthUser() == false) {
73 $this->format = $this->arg('format');
75 $source_id = (int)$this->trimmed('source_id');
76 $source_screen_name = $this->trimmed('source_screen_name');
77 $target_id = (int)$this->trimmed('target_id');
78 $target_screen_name = $this->trimmed('target_screen_name');
80 if (!empty($source_id)) {
81 $this->source = User::staticGet($source_id);
82 } elseif (!empty($source_screen_name)) {
83 $this->source = User::staticGet('nickname', $source_screen_name);
85 $this->source = $this->auth_user;
88 if (!empty($target_id)) {
89 $this->target = User::staticGet($target_id);
90 } elseif (!empty($target_screen_name)) {
91 $this->target = User::staticGet('nickname', $target_screen_name);
99 * Determines whether this API resource requires auth. Overloaded to look
100 * return true in case source_id and source_screen_name are both empty
102 * @return boolean true or false
105 function requiresAuth()
107 if (common_config('site', 'private')) {
111 $source_id = $this->trimmed('source_id');
112 $source_screen_name = $this->trimmed('source_screen_name');
114 if (empty($source_id) && empty($source_screen_name)) {
124 * Check the format and show the user info
126 * @param array $args $_REQUEST data (unused)
131 function handle($args)
133 parent::handle($args);
135 if (!in_array($this->format, array('xml', 'json'))) {
136 $this->clientError(_('API method not found!'), 404);
140 if (empty($this->source)) {
142 _('Could not determine source user.'),
148 if (empty($this->target)) {
150 _('Could not find target user.'),
156 $result = $this->twitter_relationship_array($this->source, $this->target);
158 switch ($this->format) {
160 $this->init_document('xml');
161 $this->show_twitter_xml_relationship($result[relationship]);
162 $this->end_document('xml');
165 $this->init_document('json');
166 print json_encode($result);
167 $this->end_document('json');