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 Dan Moore <dan@moore.cx>
25 * @author Evan Prodromou <evan@status.net>
26 * @author Zach Copley <zach@status.net>
27 * @copyright 2009 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('STATUSNET')) {
36 require_once INSTALLDIR . '/lib/apibareauth.php';
39 * Outputs detailed information about the relationship between two users
43 * @author Dan Moore <dan@moore.cx>
44 * @author Evan Prodromou <evan@status.net>
45 * @author Zach Copley <zach@status.net>
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47 * @link http://status.net/
50 class ApiFriendshipsShowAction extends ApiBareAuthAction
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 $source_id = (int)$this->trimmed('source_id');
69 $source_screen_name = $this->trimmed('source_screen_name');
70 $target_id = (int)$this->trimmed('target_id');
71 $target_screen_name = $this->trimmed('target_screen_name');
73 if (!empty($source_id)) {
74 $this->source = User::staticGet($source_id);
75 } elseif (!empty($source_screen_name)) {
76 $this->source = User::staticGet('nickname', $source_screen_name);
78 $this->source = $this->auth_user;
81 if (!empty($target_id)) {
82 $this->target = User::staticGet($target_id);
83 } elseif (!empty($target_screen_name)) {
84 $this->target = User::staticGet('nickname', $target_screen_name);
91 * Determines whether this API resource requires auth. Overloaded to look
92 * return true in case source_id and source_screen_name are both empty
94 * @return boolean true or false
97 function requiresAuth()
99 if (common_config('site', 'private')) {
103 $source_id = $this->trimmed('source_id');
104 $source_screen_name = $this->trimmed('source_screen_name');
106 if (empty($source_id) && empty($source_screen_name)) {
116 * Check the format and show the user info
118 * @param array $args $_REQUEST data (unused)
123 function handle($args)
125 parent::handle($args);
127 if (!in_array($this->format, array('xml', 'json'))) {
128 $this->clientError(_('API method not found.'), 404);
132 if (empty($this->source)) {
134 _('Could not determine source user.'),
140 if (empty($this->target)) {
142 _('Could not find target user.'),
148 $result = $this->twitterRelationshipArray($this->source, $this->target);
150 switch ($this->format) {
152 $this->initDocument('xml');
153 $this->showTwitterXmlRelationship($result[relationship]);
154 $this->endDocument('xml');
157 $this->initDocument('json');
158 print json_encode($result);
159 $this->endDocument('json');
168 * Return true if read only.
172 * @param array $args other arguments
174 * @return boolean is read only action?
177 function isReadOnly($args)