Ticket #1568 - API should return full user objects

This commit is contained in:
Zach Copley 2009-05-29 19:23:53 -07:00
parent 425f9d703c
commit 78f8b91a13
2 changed files with 109 additions and 97 deletions

View File

@ -25,110 +25,61 @@ class TwitapiusersAction extends TwitterapiAction
{ {
function show($args, $apidata) function show($args, $apidata)
{ {
parent::handle($args); parent::handle($args);
if (!in_array($apidata['content-type'], array('xml', 'json'))) { if (!in_array($apidata['content-type'], array('xml', 'json'))) {
$this->clientError(_('API method not found!'), $code = 404); $this->clientError(_('API method not found!'), $code = 404);
return; return;
} }
$user = null;
$email = $this->arg('email');
$user_id = $this->arg('user_id');
if ($email) { $user = null;
$user = User::staticGet('email', $email); $email = $this->arg('email');
} elseif ($user_id) { $user_id = $this->arg('user_id');
$user = $this->get_user($user_id);
} elseif (isset($apidata['api_arg'])) {
$user = $this->get_user($apidata['api_arg']);
} elseif (isset($apidata['user'])) {
$user = $apidata['user'];
}
if (!$user) {
// XXX: Twitter returns a random(?) user instead of throwing and err! -- Zach
$this->client_error(_('Not found.'), 404, $apidata['content-type']);
return;
}
$profile = $user->getProfile(); // XXX: email field deprecated in Twitter's API
if (!$profile) { // XXX: Also: need to add screen_name param
common_server_error(_('User has no profile.'));
return;
}
$twitter_user = $this->twitter_user_array($profile, true); if ($email) {
$user = User::staticGet('email', $email);
} elseif ($user_id) {
$user = $this->get_user($user_id);
} elseif (isset($apidata['api_arg'])) {
$user = $this->get_user($apidata['api_arg']);
} elseif (isset($apidata['user'])) {
$user = $apidata['user'];
}
// Add in extended user fields offered up by this method if (!$user) {
$twitter_user['created_at'] = $this->date_twitter($profile->created); $this->client_error(_('Not found.'), 404, $apidata['content-type']);
return;
}
$subbed = DB_DataObject::factory('subscription'); $profile = $user->getProfile();
$subbed->subscriber = $profile->id;
$subbed_count = (int) $subbed->count() - 1;
$notices = DB_DataObject::factory('notice'); if (!$profile) {
$notices->profile_id = $profile->id; common_server_error(_('User has no profile.'));
$notice_count = (int) $notices->count(); return;
}
$twitter_user['friends_count'] = (is_int($subbed_count)) ? $subbed_count : 0; $twitter_user = $this->twitter_user_array($profile, true);
$twitter_user['statuses_count'] = (is_int($notice_count)) ? $notice_count : 0;
// Other fields Twitter sends... if ($apidata['content-type'] == 'xml') {
$twitter_user['profile_background_color'] = ''; $this->init_document('xml');
$twitter_user['profile_background_image_url'] = ''; $this->show_twitter_xml_user($twitter_user);
$twitter_user['profile_text_color'] = ''; $this->end_document('xml');
$twitter_user['profile_link_color'] = ''; } elseif ($apidata['content-type'] == 'json') {
$twitter_user['profile_sidebar_fill_color'] = ''; $this->init_document('json');
$twitter_user['profile_sidebar_border_color'] = ''; $this->show_json_objects($twitter_user);
$twitter_user['profile_background_tile'] = false; $this->end_document('json');
} else {
$faves = DB_DataObject::factory('fave'); // This is in case 'show' was called via /account/verify_credentials
$faves->user_id = $user->id; // without a format (xml or json).
$faves_count = (int) $faves->count();
$twitter_user['favourites_count'] = $faves_count;
$timezone = 'UTC';
if ($user->timezone) {
$timezone = $user->timezone;
}
$t = new DateTime;
$t->setTimezone(new DateTimeZone($timezone));
$twitter_user['utc_offset'] = $t->format('Z');
$twitter_user['time_zone'] = $timezone;
if (isset($apidata['user'])) {
$twitter_user['following'] = $apidata['user']->isSubscribed($profile);
// Notifications on?
$sub = Subscription::pkeyGet(array('subscriber' =>
$apidata['user']->id, 'subscribed' => $profile->id));
if ($sub) {
$twitter_user['notifications'] = ($sub->jabber || $sub->sms);
}
}
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_json_objects($twitter_user);
$this->end_document('json');
} else {
// This is in case 'show' was called via /account/verify_credentials
// without a format (xml or json).
header('Content-Type: text/html; charset=utf-8'); header('Content-Type: text/html; charset=utf-8');
print 'Authorized'; print 'Authorized';
} }
} }
} }

View File

@ -54,7 +54,7 @@ class TwitterapiAction extends Action
/** /**
* Overrides XMLOutputter::element to write booleans as strings (true|false). * Overrides XMLOutputter::element to write booleans as strings (true|false).
* See that method's documentation for more info. * See that method's documentation for more info.
* *
* @param string $tag Element type or tagname * @param string $tag Element type or tagname
* @param array $attrs Array of element attributes, as * @param array $attrs Array of element attributes, as
* key-value pairs * key-value pairs
@ -70,24 +70,85 @@ class TwitterapiAction extends Action
return parent::element($tag, $attrs, $content); return parent::element($tag, $attrs, $content);
} }
function twitter_user_array($profile, $get_notice=false) function twitter_user_array($profile, $get_notice=false)
{ {
$twitter_user = array(); $twitter_user = array();
$twitter_user['name'] = $profile->getBestName();
$twitter_user['followers_count'] = $this->count_subscriptions($profile);
$twitter_user['screen_name'] = $profile->nickname;
$twitter_user['description'] = ($profile->bio) ? $profile->bio : null;
$twitter_user['location'] = ($profile->location) ? $profile->location : null;
$twitter_user['id'] = intval($profile->id); $twitter_user['id'] = intval($profile->id);
$twitter_user['name'] = $profile->getBestName();
$twitter_user['screen_name'] = $profile->nickname;
$twitter_user['location'] = ($profile->location) ? $profile->location : null;
$twitter_user['description'] = ($profile->bio) ? $profile->bio : null;
$avatar = $profile->getAvatar(AVATAR_STREAM_SIZE); $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
$twitter_user['profile_image_url'] = ($avatar) ? $avatar->displayUrl() :
Avatar::defaultImage(AVATAR_STREAM_SIZE);
$twitter_user['profile_image_url'] = ($avatar) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_STREAM_SIZE);
$twitter_user['protected'] = false; # not supported by Laconica yet
$twitter_user['url'] = ($profile->homepage) ? $profile->homepage : null; $twitter_user['url'] = ($profile->homepage) ? $profile->homepage : null;
$twitter_user['protected'] = false; # not supported by Laconica yet
$twitter_user['followers_count'] = $this->count_subscriptions($profile);
// To be supported soon...
$twitter_user['profile_background_color'] = '';
$twitter_user['profile_text_color'] = '';
$twitter_user['profile_link_color'] = '';
$twitter_user['profile_sidebar_fill_color'] = '';
$twitter_user['profile_sidebar_border_color'] = '';
$subbed = DB_DataObject::factory('subscription');
$subbed->subscriber = $profile->id;
$subbed_count = (int) $subbed->count() - 1;
$twitter_user['friends_count'] = (is_int($subbed_count)) ? $subbed_count : 0;
$twitter_user['created_at'] = $this->date_twitter($profile->created);
$faves = DB_DataObject::factory('fave');
$faves->user_id = $user->id;
$faves_count = (int) $faves->count();
$twitter_user['favourites_count'] = $faves_count; // British spelling!
// Need to pull up the user for some of this
$user = User::staticGet($profile->id);
$timezone = 'UTC';
if ($user->timezone) {
$timezone = $user->timezone;
}
$t = new DateTime;
$t->setTimezone(new DateTimeZone($timezone));
$twitter_user['utc_offset'] = $t->format('Z');
$twitter_user['time_zone'] = $timezone;
// To be supported some day, perhaps
$twitter_user['profile_background_image_url'] = '';
$twitter_user['profile_background_tile'] = false;
$notices = DB_DataObject::factory('notice');
$notices->profile_id = $profile->id;
$notice_count = (int) $notices->count();
$twitter_user['statuses_count'] = (is_int($notice_count)) ? $notice_count : 0;
// Is the requesting user following this user?
$twitter_user['following'] = false;
$twitter_user['notifications'] = false;
if (isset($apidata['user'])) {
$twitter_user['following'] = $apidata['user']->isSubscribed($profile);
// Notifications on?
$sub = Subscription::pkeyGet(array('subscriber' =>
$apidata['user']->id, 'subscribed' => $profile->id));
if ($sub) {
$twitter_user['notifications'] = ($sub->jabber || $sub->sms);
}
}
if ($get_notice) { if ($get_notice) {
$notice = $profile->getCurrentNotice(); $notice = $profile->getCurrentNotice();