/* XXX: Please don't freak out about all the ugly comments in this file.
* They are mostly in here for reference while I work on the
- * API. I'll fix things up later to make them look better later. -- Zach
+ * API. I'll fix things up later to make them look better later. -- Zach
*/
class TwitapistatusesAction extends TwitterapiAction {
-
+
+ function is_readonly() {
+
+ static $write_methods = array( 'update',
+ 'destroy');
+
+ $cmdtext = explode('.', $this->arg('method'));
+
+ if (in_array($cmdtext[0], $write_methods)) {
+ return false;
+ }
+
+ return true;
+ }
+
function public_timeline($args, $apidata) {
parent::handle($args);
$sitename = common_config('site', 'name');
- $siteserver = common_config('site', 'server');
+ $siteserver = common_config('site', 'server');
$title = sprintf(_("%s public timeline"), $sitename);
$id = "tag:$siteserver:Statuses";
$link = common_root_url();
- $subtitle = sprintf(_("%s updates from everyone!"), $sitemap);
+ $subtitle = sprintf(_("%s updates from everyone!"), $sitename);
// Number of public statuses to return by default -- Twitter sends 20
$MAX_PUBSTATUSES = 20;
- $notice = DB_DataObject::factory('notice');
+ $notice = new Notice();
// FIXME: To really live up to the spec we need to build a list
// of notices by users who have custom avatars, so fix this SQL -- Zach
- # FIXME: bad performance
- $notice->whereAdd('EXISTS (SELECT user.id from user where user.id = notice.profile_id)');
+ # XXX: sub-optimal performance
+
+ if (common_config('public', 'localonly')) {
+ $notice->is_local = 1;
+ }
+
$notice->orderBy('created DESC, notice.id DESC');
$notice->limit($MAX_PUBSTATUSES);
$cnt = $notice->find();
-
+
if ($cnt > 0) {
-
+
switch($apidata['content-type']) {
- case 'xml':
+ case 'xml':
$this->show_xml_timeline($notice);
break;
case 'rss':
$this->show_rss_timeline($notice, $title, $id, $link, $subtitle);
break;
- case 'atom':
+ case 'atom':
$this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
break;
case 'json':
$this->show_json_timeline($notice);
break;
default:
- common_user_error("API method not found!", $code = 404);
+ common_user_error(_('API method not found!'), $code = 404);
break;
}
-
+
} else {
- common_server_error('Couldn\'t find any statuses.', $code = 503);
+ common_server_error(_('Couldn\'t find any statuses.'), $code = 503);
}
-
+
exit();
- }
-
+ }
+
function show_xml_timeline($notice) {
- header('Content-Type: application/xml; charset=utf-8');
- common_start_xml();
+ $this->init_document('xml');
common_element_start('statuses', array('type' => 'array'));
if (is_array($notice)) {
foreach ($notice as $n) {
- $twitter_status = $this->twitter_status_array($n);
- $this->show_twitter_xml_status($twitter_status);
+ $twitter_status = $this->twitter_status_array($n);
+ $this->show_twitter_xml_status($twitter_status);
}
} else {
while ($notice->fetch()) {
- $twitter_status = $this->twitter_status_array($notice);
+ $twitter_status = $this->twitter_status_array($notice);
$this->show_twitter_xml_status($twitter_status);
}
}
-
+
common_element_end('statuses');
- common_end_xml();
- }
-
+ $this->end_document('xml');
+ }
+
function show_rss_timeline($notice, $title, $id, $link, $subtitle) {
-
- header("Content-Type: application/rss+xml; charset=utf-8");
-
- $this->init_twitter_rss();
-
+
+ $this->init_document('rss');
+
common_element_start('channel');
common_element('title', NULL, $title);
common_element('link', NULL, $link);
common_element('description', NULL, $subtitle);
common_element('language', NULL, 'en-us');
common_element('ttl', NULL, '40');
-
-
+
+
if (is_array($notice)) {
foreach ($notice as $n) {
- $entry = $this->twitter_rss_entry_array($n);
+ $entry = $this->twitter_rss_entry_array($n);
$this->show_twitter_rss_item($entry);
- }
+ }
} else {
while ($notice->fetch()) {
- $entry = $this->twitter_rss_entry_array($notice);
+ $entry = $this->twitter_rss_entry_array($notice);
$this->show_twitter_rss_item($entry);
}
}
- common_element_end('channel');
+ common_element_end('channel');
$this->end_twitter_rss();
}
function show_atom_timeline($notice, $title, $id, $link, $subtitle=NULL) {
-
- header('Content-Type: application/atom+xml; charset=utf-8');
- $this->init_twitter_atom();
+ $this->init_document('atom');
common_element('title', NULL, $title);
common_element('id', NULL, $id);
if (is_array($notice)) {
foreach ($notice as $n) {
- $entry = $this->twitter_rss_entry_array($n);
+ $entry = $this->twitter_rss_entry_array($n);
$this->show_twitter_atom_entry($entry);
- }
+ }
} else {
while ($notice->fetch()) {
- $entry = $this->twitter_rss_entry_array($notice);
+ $entry = $this->twitter_rss_entry_array($notice);
$this->show_twitter_atom_entry($entry);
}
}
-
- $this->end_twitter_atom();
+
+ $this->end_document('atom');
+
}
function show_json_timeline($notice) {
-
- header('Content-Type: application/json; charset=utf-8');
-
+
+ $this->init_document('json');
+
$statuses = array();
-
+
if (is_array($notice)) {
foreach ($notice as $n) {
$twitter_status = $this->twitter_status_array($n);
array_push($statuses, $twitter_status);
- }
+ }
} else {
while ($notice->fetch()) {
$twitter_status = $this->twitter_status_array($notice);
array_push($statuses, $twitter_status);
}
- }
-
- $this->show_twitter_json_statuses($statuses);
+ }
+
+ $this->show_twitter_json_statuses($statuses);
+
+ $this->end_document('json');
}
-
+
/*
- Returns the 20 most recent statuses posted by the authenticating user and that user's friends.
- This is the equivalent of /home on the Web.
-
+ Returns the 20 most recent statuses posted by the authenticating user and that user's friends.
+ This is the equivalent of /home on the Web.
+
URL: http://server/api/statuses/friends_timeline.format
-
+
Parameters:
- * since. Optional. Narrows the returned results to just those statuses created after the specified
- HTTP-formatted date. The same behavior is available by setting an If-Modified-Since header in
- your HTTP request.
+ * since. Optional. Narrows the returned results to just those statuses created after the specified
+ HTTP-formatted date. The same behavior is available by setting an If-Modified-Since header in
+ your HTTP request.
Ex: http://server/api/statuses/friends_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
- * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than)
+ * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than)
the specified ID. Ex: http://server/api/statuses/friends_timeline.xml?since_id=12345
* count. Optional. Specifies the number of statuses to retrieve. May not be greater than 200.
- Ex: http://server/api/statuses/friends_timeline.xml?count=5
+ Ex: http://server/api/statuses/friends_timeline.xml?count=5
* page. Optional. Ex: http://server/api/statuses/friends_timeline.rss?page=3
-
+
Formats: xml, json, rss, atom
*/
function friends_timeline($args, $apidata) {
$since_id = $this->arg('since_id');
$count = $this->arg('count');
$page = $this->arg('page');
-
+
if (!$page) {
$page = 1;
}
$user = $this->get_user($id, $apidata);
$profile = $user->getProfile();
-
+
$sitename = common_config('site', 'name');
- $siteserver = common_config('site', 'server');
-
+ $siteserver = common_config('site', 'server');
+
$title = sprintf(_("%s and friends"), $user->nickname);
$id = "tag:$siteserver:friends:".$user->id;
$link = common_local_url('all', array('nickname' => $user->nickname));
- $subtitle = sprintf(_("Updates from %s and friends on %s!"), $user->nickname, $sitename);
-
- $notice = new Notice();
+ $subtitle = sprintf(_('Updates from %1$s and friends on %2$s!'), $user->nickname, $sitename);
- # XXX: chokety and bad
+ $notice = $user->noticesWithFriends(($page-1)*20, $count);
- $notice->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$profile->id.' and subscribed = notice.profile_id)', 'OR');
- $notice->whereAdd('profile_id = ' . $profile->id, 'OR');
-
- # XXX: since
- # XXX: since_id
-
- $notice->orderBy('created DESC, notice.id DESC');
-
- $notice->limit((($page-1)*20), $count);
-
- $cnt = $notice->find();
-
switch($apidata['content-type']) {
- case 'xml':
+ case 'xml':
$this->show_xml_timeline($notice);
break;
case 'rss':
$this->show_rss_timeline($notice, $title, $id, $link, $subtitle);
break;
- case 'atom':
+ case 'atom':
$this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
break;
case 'json':
$this->show_json_timeline($notice);
break;
default:
- common_user_error("API method not found!", $code = 404);
+ common_user_error(_('API method not found!'), $code = 404);
}
-
+
exit();
}
* id. Optional. Specifies the ID or screen name of the user for whom to return the
friends_timeline. Ex: http://server/api/statuses/user_timeline/12345.xml or
- http://server/api/statuses/user_timeline/bob.json.
+ http://server/api/statuses/user_timeline/bob.json.
* count. Optional. Specifies the number of
statuses to retrieve. May not be greater than 200. Ex:
- http://server/api/statuses/user_timeline.xml?count=5
+ http://server/api/statuses/user_timeline.xml?count=5
* since. Optional. Narrows the returned
results to just those statuses created after the specified HTTP-formatted date. The same
behavior is available by setting an If-Modified-Since header in your HTTP request. Ex:
- http://server/api/statuses/user_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
+ http://server/api/statuses/user_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
* since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than)
the specified ID. Ex: http://server/api/statuses/user_timeline.xml?since_id=12345 * page.
Optional. Ex: http://server/api/statuses/friends_timeline.rss?page=3
*/
function user_timeline($args, $apidata) {
parent::handle($args);
-
+
$user = null;
-
+
// function was called with an argument /statuses/user_timeline/api_arg.format
if (isset($apidata['api_arg'])) {
-
+
if (is_numeric($apidata['api_arg'])) {
$user = User::staticGet($apidata['api_arg']);
} else {
$nickname = common_canonical_nickname($apidata['api_arg']);
$user = User::staticGet('nickname', $nickname);
- }
+ }
} else {
-
+
// if no user was specified, then we'll use the authenticated user
$user = $apidata['user'];
}
common_server_error(_('User has no profile.'));
exit();
}
-
+
$count = $this->arg('count');
$since = $this->arg('since');
$since_id = $this->arg('since_id');
-
+
if (!$page) {
$page = 1;
}
if (!$count) {
$count = 20;
}
-
+
$sitename = common_config('site', 'name');
- $siteserver = common_config('site', 'server');
-
+ $siteserver = common_config('site', 'server');
+
$title = sprintf(_("%s timeline"), $user->nickname);
$id = "tag:$siteserver:user:".$user->id;
$link = common_local_url('showstream', array('nickname' => $user->nickname));
- $subtitle = sprintf(_("Updates from %s on %s!"), $user->nickname, $sitename);
+ $subtitle = sprintf(_('Updates from %1$s on %2$s!'), $user->nickname, $sitename);
$notice = new Notice();
$notice->profile_id = $user->id;
-
+
# XXX: since
# XXX: since_id
-
+
$notice->orderBy('created DESC, notice.id DESC');
$notice->limit((($page-1)*20), $count);
$cnt = $notice->find();
-
+
switch($apidata['content-type']) {
- case 'xml':
+ case 'xml':
$this->show_xml_timeline($notice);
break;
case 'rss':
$this->show_rss_timeline($notice, $title, $id, $link, $subtitle);
break;
- case 'atom':
+ case 'atom':
$this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
break;
case 'json':
$this->show_json_timeline($notice);
break;
default:
- common_user_error("API method not found!", $code = 404);
+ common_user_error(_('API method not found!'), $code = 404);
}
-
+
exit();
}
-
+
function update($args, $apidata) {
+
parent::handle($args);
-
+
+ if ($_SERVER['REQUEST_METHOD'] != 'POST') {
+ $this->client_error(_('This method requires a POST.'), 400, $apidata['content-type']);
+ exit();
+ }
+
$user = $apidata['user'];
-
- $notice = DB_DataObject::factory('notice');
-
- $notice->profile_id = $user->id; # user id *is* profile id
- $notice->created = DB_DataObject_Cast::dateTime();
- $notice->content = $this->trimmed('status');
+ $status = $this->trimmed('status');
+ $source = $this->trimmed('source');
+ $in_reply_to_status_id = intval($this->trimmed('in_reply_to_status_id'));
+
+ if (!$source) {
+ $source = 'api';
+ }
+
+ if (!$status) {
- if (!$notice->content) {
-
// XXX: Note: In this case, Twitter simply returns '200 OK'
- // No error is given, but the status is not posted to the
- // user's timeline. Seems bad. Shouldn't we throw an
+ // No error is given, but the status is not posted to the
+ // user's timeline. Seems bad. Shouldn't we throw an
// errror? -- Zach
exit();
-
- } else if (strlen($notice->content) > 140) {
- // XXX: Twitter truncates anything over 140, flags the status
+ } else if (mb_strlen($status) > 140) {
+
+ // XXX: Twitter truncates anything over 140, flags the status
// as "truncated." Sending this error may screw up some clients
// that assume Twitter will truncate for them. Should we just
// truncate too? -- Zach
- header('HTTP/1.1 406 Not Acceptable');
- print "That's too long. Max notice size is 140 chars.\n";
+ $this->client_error(_('That\'s too long. Max notice size is 140 chars.'), $code = 406, $apidata['content-type']);
exit();
}
- $notice->rendered = common_render_content($notice->content, $notice);
+ $reply_to = NULL;
- $id = $notice->insert();
-
- if (!$id) {
- common_server_error('Could not update status!', 500);
- exit();
+ if ($in_reply_to_status_id) {
+
+ // check whether notice actually exists
+ $reply = Notice::staticGet($in_reply_to_status_id);
+
+ if ($reply) {
+ $reply_to = $in_reply_to_status_id;
+ } else {
+ $this->client_error(_('Not found'), $code = 404, $apidata['content-type']);
+ exit();
+ }
}
+
+ $notice = Notice::saveNew($user->id, $status, $source, 1, $reply_to);
- $orig = clone($notice);
- $notice->uri = common_notice_uri($notice);
-
- if (!$notice->update($orig)) {
- common_server_error('Could not save status!', 500);
+ if (is_string($notice)) {
+ $this->server_error($notice);
exit();
}
- common_save_replies($notice);
common_broadcast_notice($notice);
- // FIXME: Bad Hack
+ // FIXME: Bad Hack
// I should be able to just sent this notice off for display,
// but $notice->created does not contain a string at this
// point and I don't know how to convert it to one here. So
// I'm forced to have DBObject pull the notice back out of the
// DB before printing. --Zach
- $apidata['api_arg'] = $id;
+ $apidata['api_arg'] = $notice->id;
$this->show($args, $apidata);
exit();
}
-
+
/*
Returns the 20 most recent @replies (status updates prefixed with @username) for the authenticating user.
URL: http://server/api/statuses/replies.format
-
+
Formats: xml, json, rss, atom
Parameters:
- * page. Optional. Retrieves the 20 next most recent replies. Ex: http://server/api/statuses/replies.xml?page=3
+ * page. Optional. Retrieves the 20 next most recent replies. Ex: http://server/api/statuses/replies.xml?page=3
* since. Optional. Narrows the returned results to just those replies created after the specified HTTP-formatted date. The
same behavior is available by setting an If-Modified-Since header in your HTTP request. Ex:
http://server/api/statuses/replies.xml?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
ID. Ex: http://server/api/statuses/replies.xml?since_id=12345
*/
function replies($args, $apidata) {
+
parent::handle($args);
$since = $this->arg('since');
$profile = $user->getProfile();
$sitename = common_config('site', 'name');
- $siteserver = common_config('site', 'server');
+ $siteserver = common_config('site', 'server');
- $title = sprintf(_("%s / Updates replying to %s"), $sitename, $user->nickname);
+ $title = sprintf(_('%1$s / Updates replying to %2$s'), $sitename, $user->nickname);
$id = "tag:$siteserver:replies:".$user->id;
$link = common_local_url('replies', array('nickname' => $user->nickname));
$subtitle = "gar";
- $subtitle = sprintf(_("%s updates that reply to updates from %s / %s."), $sitename, $user->nickname, $profile->getBestName());
+ $subtitle = sprintf(_('%1$s updates that reply to updates from %2$s / %3$s.'), $sitename, $user->nickname, $profile->getBestName());
if (!$page) {
$page = 1;
$cnt = $reply->find();
$notices = array();
-
+
if ($cnt) {
while ($reply->fetch()) {
$notice = new Notice();
}
switch($apidata['content-type']) {
- case 'xml':
+ case 'xml':
$this->show_xml_timeline($notices);
break;
case 'rss':
$this->show_rss_timeline($notices, $title, $id, $link, $subtitle);
break;
- case 'atom':
+ case 'atom':
$this->show_atom_timeline($notices, $title, $id, $link, $subtitle);
break;
case 'json':
$this->show_json_timeline($notices);
break;
default:
- common_user_error("API method not found!", $code = 404);
+ common_user_error(_('API method not found!'), $code = 404);
}
}
-
-
+ function show($args, $apidata) {
+ parent::handle($args);
+
+ $notice_id = $apidata['api_arg'];
+ $notice = Notice::staticGet($notice_id);
+
+ if ($notice) {
+ if ($apidata['content-type'] == 'xml') {
+ $this->show_single_xml_status($notice);
+ } elseif ($apidata['content-type'] == 'json') {
+ $this->show_single_json_status($notice);
+ }
+ } else {
+ // XXX: Twitter just sets a 404 header and doens't bother to return an err msg
+ $this->client_error(_('No status with that ID found.'), 404, $apidata['content-type']);
+ }
+
+ exit();
+ }
+
+
/*
Destroys the status specified by the required ID parameter. The authenticating user must be
the author of the specified status.
-
+
URL: http://server/api/statuses/destroy/id.format
-
+
Formats: xml, json
-
+
Parameters:
-
+
* id. Required. The ID of the status to destroy. Ex:
http://server/api/statuses/destroy/12345.json or
http://server/api/statuses/destroy/23456.xml
-
+
*/
function destroy($args, $apidata) {
+
parent::handle($args);
- common_server_error("API method under construction.", $code=501);
+
+ common_debug($_SERVER['REQUEST_METHOD']);
+
+ // Check for RESTfulness
+ if (!in_array($_SERVER['REQUEST_METHOD'], array('POST', 'DELETE'))) {
+ // XXX: Twitter just prints the err msg, no XML / JSON.
+ $this->client_error(_('This method requires a POST or DELETE.'), 400, $apidata['content-type']);
+ exit();
+ }
+
+ $user = $apidata['user'];
+ $notice_id = $apidata['api_arg'];
+ $notice = Notice::staticGet($notice_id);
+
+ if (!$notice) {
+ $this->client_error(_('No status found with that ID.'), 404, $apidata['content-type']);
+ exit();
+ }
+
+ if ($user->id == $notice->profile_id) {
+ $replies = new Reply;
+ $replies->get('notice_id', $notice_id);
+ common_dequeue_notice($notice);
+ $replies->delete();
+ $notice->delete();
+
+ if ($apidata['content-type'] == 'xml') {
+ $this->show_single_xml_status($notice);
+ } elseif ($apidata['content-type'] == 'json') {
+ $this->show_single_json_status($notice);
+ }
+ } else {
+ $this->client_error(_('You may not delete another user\'s status.'), 403, $apidata['content-type']);
+ }
+
+ exit();
}
-
+
# User Methods
-
+
/*
Returns up to 100 of the authenticating user's friends who have most recently updated, each with current status inline.
It's also possible to request another user's recent friends list via the id parameter below.
-
+
URL: http://server/api/statuses/friends.format
-
+
Formats: xml, json
-
+
Parameters:
-
+
* id. Optional. The ID or screen name of the user for whom to request a list of friends. Ex:
- http://server/api/statuses/friends/12345.json
- or
+ http://server/api/statuses/friends/12345.json
+ or
http://server/api/statuses/friends/bob.xml
* page. Optional. Retrieves the next 100 friends. Ex: http://server/api/statuses/friends.xml?page=2
* lite. Optional. Prevents the inline inclusion of current status. Must be set to a value of true. Ex:
parent::handle($args);
return $this->subscriptions($apidata, 'subscribed', 'subscriber');
}
-
+
/*
Returns the authenticating user's followers, each with current status inline. They are ordered by the
order in which they joined Twitter (this is going to be changed).
-
+
URL: http://server/api/statuses/followers.format
Formats: xml, json
- Parameters:
+ Parameters:
* id. Optional. The ID or screen name of the user for whom to request a list of followers. Ex:
- http://server/api/statuses/followers/12345.json
- or
+ http://server/api/statuses/followers/12345.json
+ or
http://server/api/statuses/followers/bob.xml
- * page. Optional. Retrieves the next 100 followers. Ex: http://server/api/statuses/followers.xml?page=2
+ * page. Optional. Retrieves the next 100 followers. Ex: http://server/api/statuses/followers.xml?page=2
* lite. Optional. Prevents the inline inclusion of current status. Must be set to a value of true.
Ex: http://server/api/statuses/followers.xml?lite=true
*/
}
function subscriptions($apidata, $other_attr, $user_attr) {
-
+
$user = $this->get_subs_user($apidata);
-
+
# XXX: id
# XXX: lite
-
+
$page = $this->trimmed('page');
-
+
if (!$page || !is_numeric($page)) {
$page = 1;
}
-
+
$profile = $user->getProfile();
-
+
if (!$profile) {
common_server_error(_('User has no profile.'));
return;
}
-
+
$sub = new Subscription();
$sub->$user_attr = $profile->id;
$sub->orderBy('created DESC');
$sub->limit(($page-1)*100, 100);
-
+
$others = array();
if ($sub->find()) {
} else {
// user has no followers
}
-
+
$type = $apidata['content-type'];
-
+
$this->init_document($type);
$this->show_profiles($others, $type);
$this->end_document($type);
}
function get_subs_user($apidata) {
-
+
// function was called with an argument /statuses/user_timeline/api_arg.format
if (isset($apidata['api_arg'])) {
-
+
if (is_numeric($apidata['api_arg'])) {
$user = User::staticGet($apidata['api_arg']);
} else {
$nickname = common_canonical_nickname($apidata['api_arg']);
$user = User::staticGet('nickname', $nickname);
- }
+ }
} else {
-
+
// if no user was specified, then we'll use the authenticated user
$user = $apidata['user'];
}
// honestly! This is what Twitter does, I swear --Zach
$user = $apidata['user'];
}
-
+
return $user;
}
-
+
function show_profiles($profiles, $type) {
switch ($type) {
case 'xml':
exit();
}
}
-
+
/*
- Returns a list of the users currently featured on the site with their current statuses inline.
- URL: http://server/api/statuses/featured.format
+ Returns a list of the users currently featured on the site with their current statuses inline.
+ URL: http://server/api/statuses/featured.format
Formats: xml, json
*/
function featured($args, $apidata) {
parent::handle($args);
- common_server_error("API method under construction.", $code=501);
+ common_server_error(_('API method under construction.'), $code=501);
}
function get_user($id, $apidata) {
}
}
-