GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

Twitter-compatible API: implemented /users/show.format method

Browse Source 
(and some API bug fixes)

darcs-hash:20080730213226-ca946-eb89bad91eee630ac286d537ba42f0042b8d2109.gz
This commit is contained in:
zach 2008-07-30 17:32:26 -04:00
parent 16daa87a39
commit 93d25bec33
4 changed files with 144 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
actions/api.php
View File

@ -100,6 +100,7 @@ class ApiAction extends Action {
function requires_auth() {
static $noauth = array( 'statuses/public_timeline',
'statuses/show',
'users/show',
'help/test',
'help/downtime_schedule');
static $bareauth = array('statuses/user_timeline', 'statuses/friends');

127
actions/twitapiusers.php Normal file
View File

@ -0,0 +1,127 @@
<?php
/*
* Laconica - a distributed open-source microblogging tool
* Copyright (C) 2008, Controlez-Vous, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
if (!defined('LACONICA')) { exit(1); }
require_once(INSTALLDIR.'/lib/twitterapi.php');
class TwitapiusersAction extends TwitterapiAction {
function is_readonly() {
return true;
}
/*
Returns extended information of a given user, specified by ID or
screen name as per the required id parameter below. This information
includes design settings, so third party developers can theme their
widgets according to a given user's preferences. You must be properly
authenticated to request the page of a protected user.
URL: http://twitter.com/users/show/id.format
Formats: xml, json
Parameters:
* id. Required. The ID or screen name of a user.
Ex: http://twitter.com/users/show/12345.json or
http://twitter.com/users/show/bob.xml
* email. Optional. The email address of a user. Ex:
http://twitter.com/users/show.xml?email=test@example.com
*/
function show($args, $apidata) {
parent::handle($args);
$user = null;
$email = $this->arg('email');
if (isset($apidata['api_arg'])) {
if (is_numeric($apidata['api_arg'])) {
// by user id
$user = User::staticGet($apidata['api_arg']);
} else {
// by nickname
$nickname = common_canonical_nickname($apidata['api_arg']);
$user = User::staticGet('nickname', $nickname);
}
} elseif ($email) {
// or, find user by email address
// XXX: The Twitter API spec say an id is *required*, but you can actually
// pull up a user with just an email address. -- Zach
$user = User::staticGet('email', $email);
}
if (!$user) {
// XXX: Twitter returns a random(?) user instead of throwing and err! -- Zach
$this->client_error("User not found.", 404, $apidata['content-type']);
exit();
}
$profile = $user->getProfile();
if (!$profile) {
common_server_error(_('User has no profile.'));
exit();
}
$twitter_user = $this->twitter_user_array($profile, true);
// Add in extended user fields offered up by this method
$twitter_user['created_at'] = $this->date_twitter($profile->created);
$subbed = DB_DataObject::factory('subscription');
$subbed->subscribed = $profile->id;
$subbed_count = (int) $subbed->count() - 1;
$notices = DB_DataObject::factory('notice');
$notices->profile_id = $profile->id;
$notice_count = (int) $notices->count();
$twitter_user['friends_count'] = (is_int($subbed_count)) ? $subbed_count : 0;
$twitter_user['statuses_count'] = (is_int($notice_count)) ? $notice_count : 0;
// Other fields Twitter sends...
$twitter_user['profile_background_color'] = '';
$twitter_user['profile_text_color'] = '';
$twitter_user['profile_link_color'] = '';
$twitter_user['profile_sidebar_fill_color'] = '';
$twitter_user['favourites_count'] = 0;
$twitter_user['utc_offset'] = '';
$twitter_user['time_zone'] = '';
$twitter_user['following'] = '';
$twitter_user['notifications'] = '';
if ($apidata['content-type'] == 'xml') {
$this->init_document('xml');
$this->show_twitter_xml_user($twitter_user);
$this->end_document('xml');
} elseif ($apidata['content-type'] == 'json') {
$this->init_document('json');
$this->show_twitter_json_users($twitter_user);
$this->end_document('json');
} else {
common_user_error("API method not found!", $code = 404);
}
exit();
}
}

2
htaccess.sample
View File

@ -79,6 +79,8 @@ RewriteRule ^api/statuses/friends(.*)$ index.php?action=api&apiaction=statuses&m
RewriteRule ^api/statuses/followers/(.*)$ index.php?action=api&apiaction=statuses&method=followers&argument=$1 [L,QSA]
RewriteRule ^api/statuses/followers(.*)$ index.php?action=api&apiaction=statuses&method=followers$1 [L,QSA]
RewriteRule ^api/statuses/featured(.*)$ index.php?action=api&apiaction=statuses&method=featured$1 [L,QSA]
RewriteRule ^api/users/show/(.*)$ index.php?action=api&apiaction=users&method=show&argument=$1 [L,QSA]
RewriteRule ^api/users/show(.*)$ index.php?action=api&apiaction=users&method=show$1 [L,QSA]
RewriteRule ^api/direct_messages/sent(.*)$ index.php?action=api&apiaction=direct_messages&method=sent$1 [L,QSA]
RewriteRule ^api/direct_messages/destroy/(.*)$ index.php?action=api&apiaction=direct_messages&method=destroy&argument=$1 [L,QSA]
RewriteRule ^api/direct_messages/new(.*)$ index.php?action=api&apiaction=direct_messages&method=create$1 [L,QSA]

39
lib/twitterapi.php
View File

@ -39,7 +39,7 @@ class TwitterapiAction extends Action {
$avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
$twitter_user['profile_image_url'] = ($avatar) ? common_avatar_display_url($avatar) : common_default_avatar(AVATAR_STREAM_SIZE);
$twitter_user['protected'] = false; # not supported by Laconica yet
$twitter_user['protected'] = 'false'; # not supported by Laconica yet
$twitter_user['url'] = ($profile->homepage) ? $profile->homepage : NULL;
if ($get_notice) {
@ -58,7 +58,7 @@ class TwitterapiAction extends Action {
$twitter_status = array();
$twitter_status['text'] = $notice->content;
$twitter_status['truncated'] = false; # Not possible on Laconica
$twitter_status['truncated'] = 'false'; # Not possible on Laconica
$twitter_status['created_at'] = $this->date_twitter($notice->created);
$twitter_status['in_reply_to_status_id'] = ($notice->reply_to) ? intval($notice->reply_to) : NULL;
$twitter_status['source'] = NULL; # XXX: twitterific, twitterfox, etc. Not supported yet.
@ -100,35 +100,24 @@ class TwitterapiAction extends Action {
function show_twitter_xml_status($twitter_status) {
common_element_start('status');
common_element('created_at', NULL, $twitter_status['created_at']);
common_element('id', NULL, $twitter_status['id']);
common_element('text', NULL, $twitter_status['text']);
common_element('source', NULL, $twitter_status['source']);
common_element('truncated', NULL, $twitter_status['truncated']);
common_element('in_reply_to_status_id', NULL, $twitter_status['in_reply_to_status_id']);
common_element('in_reply_to_user_id', NULL, $twitter_status['in_reply_to_user_id']);
common_element('favorited', Null, $twitter_status['favorited']);
if ($twitter_status['user']) {
$this->show_twitter_xml_user($twitter_status['user']);
foreach($twitter_status as $element => $value) {
if ($element == 'user') {
$this->show_twitter_xml_user($twitter_status['user']);
} else {
common_element($element, NULL, $value);
}
}
common_element_end('status');
}
function show_twitter_xml_user($twitter_user) {
common_element_start('user');
common_element('id', NULL, $twitter_user['id']);
common_element('name', NULL, $twitter_user['name']);
common_element('screen_name', NULL, $twitter_user['screen_name']);
common_element('location', NULL, $twitter_user['location']);
common_element('description', NULL, $twitter_user['description']);
common_element('profile_image_url', NULL, $twitter_user['profile_image_url']);
common_element('url', NULL, $twitter_user['url']);
common_element('protected', NULL, $twitter_user['protected']);
common_element('followers_count', NULL, $twitter_user['followers_count']);
if ($twitter_user['status']) {
$this->show_twitter_xml_status($twitter_user['status']);
foreach($twitter_user as $element => $value) {
if ($element == 'status') {
$this->show_twitter_xml_status($twitter_user['status']);
} else {
common_element($element, NULL, $value);
}
}
common_element_end('user');
}