3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, Controlez-Vous, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 if (!defined('LACONICA')) { exit(1); }
22 require_once(INSTALLDIR.'/lib/twitterapi.php');
24 /* XXX: Please don't freak out about all the ugly comments in this file.
25 * They are mostly in here for reference while I work on the
26 * API. I'll fix things up later to make them look better later. -- Zach
28 class TwitapistatusesAction extends TwitterapiAction {
30 function public_timeline($args, $apidata) {
31 parent::handle($args);
33 $sitename = common_config('site', 'name');
34 $siteserver = common_config('site', 'server');
35 $title = sprintf(_("%s public timeline"), $sitename);
36 $id = "tag:$siteserver:Statuses";
37 $link = common_root_url();
38 $subtitle = sprintf(_("%s updates from everyone!"), $sitemap);
40 // Number of public statuses to return by default -- Twitter sends 20
41 $MAX_PUBSTATUSES = 20;
43 $notice = DB_DataObject::factory('notice');
45 // FIXME: To really live up to the spec we need to build a list
46 // of notices by users who have custom avatars, so fix this SQL -- Zach
48 # FIXME: bad performance
49 $notice->whereAdd('EXISTS (SELECT user.id from user where user.id = notice.profile_id)');
50 $notice->orderBy('created DESC, notice.id DESC');
51 $notice->limit($MAX_PUBSTATUSES);
52 $cnt = $notice->find();
56 switch($apidata['content-type']) {
58 $this->show_xml_timeline($notice);
61 $this->show_rss_timeline($notice, $title, $id, $link, $subtitle);
64 $this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
67 $this->show_json_timeline($notice);
70 common_user_error("API method not found!", $code = 404);
75 common_server_error('Couldn\'t find any statuses.', $code = 503);
81 function show_xml_timeline($notice) {
83 $this->init_document('xml');
84 common_element_start('statuses', array('type' => 'array'));
86 if (is_array($notice)) {
87 foreach ($notice as $n) {
88 $twitter_status = $this->twitter_status_array($n);
89 $this->show_twitter_xml_status($twitter_status);
92 while ($notice->fetch()) {
93 $twitter_status = $this->twitter_status_array($notice);
94 $this->show_twitter_xml_status($twitter_status);
98 common_element_end('statuses');
99 $this->end_document('xml');
102 function show_rss_timeline($notice, $title, $id, $link, $subtitle) {
104 $this->init_document('rss');
106 common_element_start('channel');
107 common_element('title', NULL, $title);
108 common_element('link', NULL, $link);
109 common_element('description', NULL, $subtitle);
110 common_element('language', NULL, 'en-us');
111 common_element('ttl', NULL, '40');
114 if (is_array($notice)) {
115 foreach ($notice as $n) {
116 $entry = $this->twitter_rss_entry_array($n);
117 $this->show_twitter_rss_item($entry);
120 while ($notice->fetch()) {
121 $entry = $this->twitter_rss_entry_array($notice);
122 $this->show_twitter_rss_item($entry);
126 common_element_end('channel');
127 $this->end_twitter_rss();
130 function show_atom_timeline($notice, $title, $id, $link, $subtitle=NULL) {
132 $this->init_document('atom');
134 common_element('title', NULL, $title);
135 common_element('id', NULL, $id);
136 common_element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), NULL);
137 common_element('subtitle', NULL, $subtitle);
139 if (is_array($notice)) {
140 foreach ($notice as $n) {
141 $entry = $this->twitter_rss_entry_array($n);
142 $this->show_twitter_atom_entry($entry);
145 while ($notice->fetch()) {
146 $entry = $this->twitter_rss_entry_array($notice);
147 $this->show_twitter_atom_entry($entry);
151 $this->end_document('atom');
155 function show_json_timeline($notice) {
157 $this->init_document('json');
161 if (is_array($notice)) {
162 foreach ($notice as $n) {
163 $twitter_status = $this->twitter_status_array($n);
164 array_push($statuses, $twitter_status);
167 while ($notice->fetch()) {
168 $twitter_status = $this->twitter_status_array($notice);
169 array_push($statuses, $twitter_status);
173 $this->show_twitter_json_statuses($statuses);
175 $this->end_document('json');
179 Returns the 20 most recent statuses posted by the authenticating user and that user's friends.
180 This is the equivalent of /home on the Web.
182 URL: http://server/api/statuses/friends_timeline.format
186 * since. Optional. Narrows the returned results to just those statuses created after the specified
187 HTTP-formatted date. The same behavior is available by setting an If-Modified-Since header in
189 Ex: http://server/api/statuses/friends_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
190 * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than)
191 the specified ID. Ex: http://server/api/statuses/friends_timeline.xml?since_id=12345
192 * count. Optional. Specifies the number of statuses to retrieve. May not be greater than 200.
193 Ex: http://server/api/statuses/friends_timeline.xml?count=5
194 * page. Optional. Ex: http://server/api/statuses/friends_timeline.rss?page=3
196 Formats: xml, json, rss, atom
198 function friends_timeline($args, $apidata) {
199 parent::handle($args);
201 $since = $this->arg('since');
202 $since_id = $this->arg('since_id');
203 $count = $this->arg('count');
204 $page = $this->arg('page');
214 $user = $this->get_user($id, $apidata);
215 $profile = $user->getProfile();
217 $sitename = common_config('site', 'name');
218 $siteserver = common_config('site', 'server');
220 $title = sprintf(_("%s and friends"), $user->nickname);
221 $id = "tag:$siteserver:friends:".$user->id;
222 $link = common_local_url('all', array('nickname' => $user->nickname));
223 $subtitle = sprintf(_("Updates from %s and friends on %s!"), $user->nickname, $sitename);
225 $notice = new Notice();
227 # XXX: chokety and bad
229 $notice->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$profile->id.' and subscribed = notice.profile_id)', 'OR');
230 $notice->whereAdd('profile_id = ' . $profile->id, 'OR');
235 $notice->orderBy('created DESC, notice.id DESC');
237 $notice->limit((($page-1)*20), $count);
239 $cnt = $notice->find();
241 switch($apidata['content-type']) {
243 $this->show_xml_timeline($notice);
246 $this->show_rss_timeline($notice, $title, $id, $link, $subtitle);
249 $this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
252 $this->show_json_timeline($notice);
255 common_user_error("API method not found!", $code = 404);
262 Returns the 20 most recent statuses posted from the authenticating user. It's also possible to
263 request another user's timeline via the id parameter below. This is the equivalent of the Web
264 /archive page for your own user, or the profile page for a third party.
266 URL: http://server/api/statuses/user_timeline.format
268 Formats: xml, json, rss, atom
272 * id. Optional. Specifies the ID or screen name of the user for whom to return the
273 friends_timeline. Ex: http://server/api/statuses/user_timeline/12345.xml or
274 http://server/api/statuses/user_timeline/bob.json.
275 * count. Optional. Specifies the number of
276 statuses to retrieve. May not be greater than 200. Ex:
277 http://server/api/statuses/user_timeline.xml?count=5
278 * since. Optional. Narrows the returned
279 results to just those statuses created after the specified HTTP-formatted date. The same
280 behavior is available by setting an If-Modified-Since header in your HTTP request. Ex:
281 http://server/api/statuses/user_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
282 * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than)
283 the specified ID. Ex: http://server/api/statuses/user_timeline.xml?since_id=12345 * page.
284 Optional. Ex: http://server/api/statuses/friends_timeline.rss?page=3
286 function user_timeline($args, $apidata) {
287 parent::handle($args);
291 // function was called with an argument /statuses/user_timeline/api_arg.format
292 if (isset($apidata['api_arg'])) {
294 if (is_numeric($apidata['api_arg'])) {
295 $user = User::staticGet($apidata['api_arg']);
297 $nickname = common_canonical_nickname($apidata['api_arg']);
298 $user = User::staticGet('nickname', $nickname);
302 // if no user was specified, then we'll use the authenticated user
303 $user = $apidata['user'];
307 // Set the user to be the auth user if asked-for can't be found
308 // honestly! This is what Twitter does, I swear --Zach
309 $user = $apidata['user'];
312 $profile = $user->getProfile();
315 common_server_error(_('User has no profile.'));
319 $count = $this->arg('count');
320 $since = $this->arg('since');
321 $since_id = $this->arg('since_id');
331 $sitename = common_config('site', 'name');
332 $siteserver = common_config('site', 'server');
334 $title = sprintf(_("%s timeline"), $user->nickname);
335 $id = "tag:$siteserver:user:".$user->id;
336 $link = common_local_url('showstream', array('nickname' => $user->nickname));
337 $subtitle = sprintf(_("Updates from %s on %s!"), $user->nickname, $sitename);
339 $notice = new Notice();
341 $notice->profile_id = $user->id;
346 $notice->orderBy('created DESC, notice.id DESC');
348 $notice->limit((($page-1)*20), $count);
350 $cnt = $notice->find();
352 switch($apidata['content-type']) {
354 $this->show_xml_timeline($notice);
357 $this->show_rss_timeline($notice, $title, $id, $link, $subtitle);
360 $this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
363 $this->show_json_timeline($notice);
366 common_user_error("API method not found!", $code = 404);
372 function update($args, $apidata) {
373 parent::handle($args);
375 $user = $apidata['user'];
377 $notice = DB_DataObject::factory('notice');
379 $notice->profile_id = $user->id; # user id *is* profile id
380 $notice->created = DB_DataObject_Cast::dateTime();
381 $notice->content = $this->trimmed('status');
383 if (!$notice->content) {
385 // XXX: Note: In this case, Twitter simply returns '200 OK'
386 // No error is given, but the status is not posted to the
387 // user's timeline. Seems bad. Shouldn't we throw an
391 } else if (strlen($notice->content) > 140) {
393 // XXX: Twitter truncates anything over 140, flags the status
394 // as "truncated." Sending this error may screw up some clients
395 // that assume Twitter will truncate for them. Should we just
396 // truncate too? -- Zach
397 header('HTTP/1.1 406 Not Acceptable');
398 print "That's too long. Max notice size is 140 chars.\n";
402 $notice->rendered = common_render_content($notice->content, $notice);
404 $id = $notice->insert();
407 common_server_error('Could not update status!', 500);
411 $orig = clone($notice);
412 $notice->uri = common_notice_uri($notice);
414 if (!$notice->update($orig)) {
415 common_server_error('Could not save status!', 500);
419 common_save_replies($notice);
420 common_broadcast_notice($notice);
423 // I should be able to just sent this notice off for display,
424 // but $notice->created does not contain a string at this
425 // point and I don't know how to convert it to one here. So
426 // I'm forced to have DBObject pull the notice back out of the
427 // DB before printing. --Zach
428 $apidata['api_arg'] = $id;
429 $this->show($args, $apidata);
435 Returns the 20 most recent @replies (status updates prefixed with @username) for the authenticating user.
436 URL: http://server/api/statuses/replies.format
438 Formats: xml, json, rss, atom
442 * page. Optional. Retrieves the 20 next most recent replies. Ex: http://server/api/statuses/replies.xml?page=3
443 * since. Optional. Narrows the returned results to just those replies created after the specified HTTP-formatted date. The
444 same behavior is available by setting an If-Modified-Since header in your HTTP request. Ex:
445 http://server/api/statuses/replies.xml?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
446 * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than) the specified
447 ID. Ex: http://server/api/statuses/replies.xml?since_id=12345
449 function replies($args, $apidata) {
451 parent::handle($args);
453 $since = $this->arg('since');
455 $count = $this->arg('count');
456 $page = $this->arg('page');
458 $user = $apidata['user'];
459 $profile = $user->getProfile();
461 $sitename = common_config('site', 'name');
462 $siteserver = common_config('site', 'server');
464 $title = sprintf(_("%s / Updates replying to %s"), $sitename, $user->nickname);
465 $id = "tag:$siteserver:replies:".$user->id;
466 $link = common_local_url('replies', array('nickname' => $user->nickname));
468 $subtitle = sprintf(_("%s updates that reply to updates from %s / %s."), $sitename, $user->nickname, $profile->getBestName());
478 $reply = new Reply();
480 $reply->profile_id = $user->id;
482 $reply->orderBy('modified DESC');
484 $page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
486 $reply->limit((($page-1)*20), $count);
488 $cnt = $reply->find();
493 while ($reply->fetch()) {
494 $notice = new Notice();
495 $notice->id = $reply->notice_id;
496 $result = $notice->find(true);
500 $notices[] = clone($notice);
504 switch($apidata['content-type']) {
506 $this->show_xml_timeline($notices);
509 $this->show_rss_timeline($notices, $title, $id, $link, $subtitle);
512 $this->show_atom_timeline($notices, $title, $id, $link, $subtitle);
515 $this->show_json_timeline($notices);
518 common_user_error("API method not found!", $code = 404);
530 Destroys the status specified by the required ID parameter. The authenticating user must be
531 the author of the specified status.
533 URL: http://server/api/statuses/destroy/id.format
539 * id. Required. The ID of the status to destroy. Ex:
540 http://server/api/statuses/destroy/12345.json or
541 http://server/api/statuses/destroy/23456.xml
544 function destroy($args, $apidata) {
545 parent::handle($args);
546 common_server_error("API method under construction.", $code=501);
552 Returns up to 100 of the authenticating user's friends who have most recently updated, each with current status inline.
553 It's also possible to request another user's recent friends list via the id parameter below.
555 URL: http://server/api/statuses/friends.format
561 * id. Optional. The ID or screen name of the user for whom to request a list of friends. Ex:
562 http://server/api/statuses/friends/12345.json
564 http://server/api/statuses/friends/bob.xml
565 * page. Optional. Retrieves the next 100 friends. Ex: http://server/api/statuses/friends.xml?page=2
566 * lite. Optional. Prevents the inline inclusion of current status. Must be set to a value of true. Ex:
567 http://server/api/statuses/friends.xml?lite=true
568 * since. Optional. Narrows the returned results to just those friendships created after the specified
569 HTTP-formatted date. The same behavior is available by setting an If-Modified-Since header in your HTTP
570 request. Ex: http://server/api/statuses/friends.xml?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
572 function friends($args, $apidata) {
573 parent::handle($args);
574 return $this->subscriptions($apidata, 'subscribed', 'subscriber');
578 Returns the authenticating user's followers, each with current status inline. They are ordered by the
579 order in which they joined Twitter (this is going to be changed).
581 URL: http://server/api/statuses/followers.format
586 * id. Optional. The ID or screen name of the user for whom to request a list of followers. Ex:
587 http://server/api/statuses/followers/12345.json
589 http://server/api/statuses/followers/bob.xml
590 * page. Optional. Retrieves the next 100 followers. Ex: http://server/api/statuses/followers.xml?page=2
591 * lite. Optional. Prevents the inline inclusion of current status. Must be set to a value of true.
592 Ex: http://server/api/statuses/followers.xml?lite=true
594 function followers($args, $apidata) {
595 parent::handle($args);
597 return $this->subscriptions($apidata, 'subscriber', 'subscribed');
600 function subscriptions($apidata, $other_attr, $user_attr) {
602 $user = $this->get_subs_user($apidata);
607 $page = $this->trimmed('page');
609 if (!$page || !is_numeric($page)) {
613 $profile = $user->getProfile();
616 common_server_error(_('User has no profile.'));
620 $sub = new Subscription();
621 $sub->$user_attr = $profile->id;
622 $sub->orderBy('created DESC');
623 $sub->limit(($page-1)*100, 100);
628 while ($sub->fetch()) {
629 $others[] = Profile::staticGet($sub->$other_attr);
632 // user has no followers
635 $type = $apidata['content-type'];
637 $this->init_document($type);
638 $this->show_profiles($others, $type);
639 $this->end_document($type);
643 function get_subs_user($apidata) {
645 // function was called with an argument /statuses/user_timeline/api_arg.format
646 if (isset($apidata['api_arg'])) {
648 if (is_numeric($apidata['api_arg'])) {
649 $user = User::staticGet($apidata['api_arg']);
651 $nickname = common_canonical_nickname($apidata['api_arg']);
652 $user = User::staticGet('nickname', $nickname);
656 // if no user was specified, then we'll use the authenticated user
657 $user = $apidata['user'];
661 // Set the user to be the auth user if asked-for can't be found
662 // honestly! This is what Twitter does, I swear --Zach
663 $user = $apidata['user'];
669 function show_profiles($profiles, $type) {
672 common_element_start('users', array('type' => 'array'));
673 foreach ($profiles as $profile) {
674 $this->show_profile($profile);
676 common_element_end('users');
680 foreach ($profiles as $profile) {
681 $arrays[] = $this->twitter_user_array($profile, true);
683 print json_encode($arrays);
686 $this->client_error(_('unsupported file type'));
692 Returns a list of the users currently featured on the site with their current statuses inline.
693 URL: http://server/api/statuses/featured.format
697 function featured($args, $apidata) {
698 parent::handle($args);
699 common_server_error("API method under construction.", $code=501);
702 function get_user($id, $apidata) {
704 return $apidata['user'];
705 } else if (is_numeric($id)) {
706 return User::staticGet($id);
708 return User::staticGet('nickname', $id);