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 is_readonly() {
32 static $write_methods = array( 'update',
35 $cmdtext = explode('.', $this->arg('method'));
37 if (in_array($cmdtext[0], $write_methods)) {
44 function public_timeline($args, $apidata) {
45 parent::handle($args);
47 $sitename = common_config('site', 'name');
48 $siteserver = common_config('site', 'server');
49 $title = sprintf(_("%s public timeline"), $sitename);
50 $id = "tag:$siteserver:Statuses";
51 $link = common_root_url();
52 $subtitle = sprintf(_("%s updates from everyone!"), $sitemap);
54 // Number of public statuses to return by default -- Twitter sends 20
55 $MAX_PUBSTATUSES = 20;
57 $notice = new Notice();
59 // FIXME: To really live up to the spec we need to build a list
60 // of notices by users who have custom avatars, so fix this SQL -- Zach
62 # XXX: sub-optimal performance
64 $notice->is_local = 1;
65 $notice->orderBy('created DESC, notice.id DESC');
66 $notice->limit($MAX_PUBSTATUSES);
67 $cnt = $notice->find();
71 switch($apidata['content-type']) {
73 $this->show_xml_timeline($notice);
76 $this->show_rss_timeline($notice, $title, $id, $link, $subtitle);
79 $this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
82 $this->show_json_timeline($notice);
85 common_user_error("API method not found!", $code = 404);
90 common_server_error('Couldn\'t find any statuses.', $code = 503);
96 function show_xml_timeline($notice) {
98 $this->init_document('xml');
99 common_element_start('statuses', array('type' => 'array'));
101 if (is_array($notice)) {
102 foreach ($notice as $n) {
103 $twitter_status = $this->twitter_status_array($n);
104 $this->show_twitter_xml_status($twitter_status);
107 while ($notice->fetch()) {
108 $twitter_status = $this->twitter_status_array($notice);
109 $this->show_twitter_xml_status($twitter_status);
113 common_element_end('statuses');
114 $this->end_document('xml');
117 function show_rss_timeline($notice, $title, $id, $link, $subtitle) {
119 $this->init_document('rss');
121 common_element_start('channel');
122 common_element('title', NULL, $title);
123 common_element('link', NULL, $link);
124 common_element('description', NULL, $subtitle);
125 common_element('language', NULL, 'en-us');
126 common_element('ttl', NULL, '40');
129 if (is_array($notice)) {
130 foreach ($notice as $n) {
131 $entry = $this->twitter_rss_entry_array($n);
132 $this->show_twitter_rss_item($entry);
135 while ($notice->fetch()) {
136 $entry = $this->twitter_rss_entry_array($notice);
137 $this->show_twitter_rss_item($entry);
141 common_element_end('channel');
142 $this->end_twitter_rss();
145 function show_atom_timeline($notice, $title, $id, $link, $subtitle=NULL) {
147 $this->init_document('atom');
149 common_element('title', NULL, $title);
150 common_element('id', NULL, $id);
151 common_element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), NULL);
152 common_element('subtitle', NULL, $subtitle);
154 if (is_array($notice)) {
155 foreach ($notice as $n) {
156 $entry = $this->twitter_rss_entry_array($n);
157 $this->show_twitter_atom_entry($entry);
160 while ($notice->fetch()) {
161 $entry = $this->twitter_rss_entry_array($notice);
162 $this->show_twitter_atom_entry($entry);
166 $this->end_document('atom');
170 function show_json_timeline($notice) {
172 $this->init_document('json');
176 if (is_array($notice)) {
177 foreach ($notice as $n) {
178 $twitter_status = $this->twitter_status_array($n);
179 array_push($statuses, $twitter_status);
182 while ($notice->fetch()) {
183 $twitter_status = $this->twitter_status_array($notice);
184 array_push($statuses, $twitter_status);
188 $this->show_twitter_json_statuses($statuses);
190 $this->end_document('json');
194 Returns the 20 most recent statuses posted by the authenticating user and that user's friends.
195 This is the equivalent of /home on the Web.
197 URL: http://server/api/statuses/friends_timeline.format
201 * since. Optional. Narrows the returned results to just those statuses created after the specified
202 HTTP-formatted date. The same behavior is available by setting an If-Modified-Since header in
204 Ex: http://server/api/statuses/friends_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
205 * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than)
206 the specified ID. Ex: http://server/api/statuses/friends_timeline.xml?since_id=12345
207 * count. Optional. Specifies the number of statuses to retrieve. May not be greater than 200.
208 Ex: http://server/api/statuses/friends_timeline.xml?count=5
209 * page. Optional. Ex: http://server/api/statuses/friends_timeline.rss?page=3
211 Formats: xml, json, rss, atom
213 function friends_timeline($args, $apidata) {
214 parent::handle($args);
216 $since = $this->arg('since');
217 $since_id = $this->arg('since_id');
218 $count = $this->arg('count');
219 $page = $this->arg('page');
229 $user = $this->get_user($id, $apidata);
230 $profile = $user->getProfile();
232 $sitename = common_config('site', 'name');
233 $siteserver = common_config('site', 'server');
235 $title = sprintf(_("%s and friends"), $user->nickname);
236 $id = "tag:$siteserver:friends:".$user->id;
237 $link = common_local_url('all', array('nickname' => $user->nickname));
238 $subtitle = sprintf(_("Updates from %s and friends on %s!"), $user->nickname, $sitename);
240 $notice = $user->noticesWithFriends(($page-1)*20, $count);
242 switch($apidata['content-type']) {
244 $this->show_xml_timeline($notice);
247 $this->show_rss_timeline($notice, $title, $id, $link, $subtitle);
250 $this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
253 $this->show_json_timeline($notice);
256 common_user_error("API method not found!", $code = 404);
263 Returns the 20 most recent statuses posted from the authenticating user. It's also possible to
264 request another user's timeline via the id parameter below. This is the equivalent of the Web
265 /archive page for your own user, or the profile page for a third party.
267 URL: http://server/api/statuses/user_timeline.format
269 Formats: xml, json, rss, atom
273 * id. Optional. Specifies the ID or screen name of the user for whom to return the
274 friends_timeline. Ex: http://server/api/statuses/user_timeline/12345.xml or
275 http://server/api/statuses/user_timeline/bob.json.
276 * count. Optional. Specifies the number of
277 statuses to retrieve. May not be greater than 200. Ex:
278 http://server/api/statuses/user_timeline.xml?count=5
279 * since. Optional. Narrows the returned
280 results to just those statuses created after the specified HTTP-formatted date. The same
281 behavior is available by setting an If-Modified-Since header in your HTTP request. Ex:
282 http://server/api/statuses/user_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
283 * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than)
284 the specified ID. Ex: http://server/api/statuses/user_timeline.xml?since_id=12345 * page.
285 Optional. Ex: http://server/api/statuses/friends_timeline.rss?page=3
287 function user_timeline($args, $apidata) {
288 parent::handle($args);
292 // function was called with an argument /statuses/user_timeline/api_arg.format
293 if (isset($apidata['api_arg'])) {
295 if (is_numeric($apidata['api_arg'])) {
296 $user = User::staticGet($apidata['api_arg']);
298 $nickname = common_canonical_nickname($apidata['api_arg']);
299 $user = User::staticGet('nickname', $nickname);
303 // if no user was specified, then we'll use the authenticated user
304 $user = $apidata['user'];
308 // Set the user to be the auth user if asked-for can't be found
309 // honestly! This is what Twitter does, I swear --Zach
310 $user = $apidata['user'];
313 $profile = $user->getProfile();
316 common_server_error(_('User has no profile.'));
320 $count = $this->arg('count');
321 $since = $this->arg('since');
322 $since_id = $this->arg('since_id');
332 $sitename = common_config('site', 'name');
333 $siteserver = common_config('site', 'server');
335 $title = sprintf(_("%s timeline"), $user->nickname);
336 $id = "tag:$siteserver:user:".$user->id;
337 $link = common_local_url('showstream', array('nickname' => $user->nickname));
338 $subtitle = sprintf(_("Updates from %s on %s!"), $user->nickname, $sitename);
340 $notice = new Notice();
342 $notice->profile_id = $user->id;
347 $notice->orderBy('created DESC, notice.id DESC');
349 $notice->limit((($page-1)*20), $count);
351 $cnt = $notice->find();
353 switch($apidata['content-type']) {
355 $this->show_xml_timeline($notice);
358 $this->show_rss_timeline($notice, $title, $id, $link, $subtitle);
361 $this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
364 $this->show_json_timeline($notice);
367 common_user_error("API method not found!", $code = 404);
373 function update($args, $apidata) {
374 parent::handle($args);
376 $user = $apidata['user'];
378 $this->is_readonly();
381 $notice = DB_DataObject::factory('notice');
383 $notice->profile_id = $user->id; # user id *is* profile id
384 $notice->created = DB_DataObject_Cast::dateTime();
385 $notice->content = $this->trimmed('status');
387 if (!$notice->content) {
389 // XXX: Note: In this case, Twitter simply returns '200 OK'
390 // No error is given, but the status is not posted to the
391 // user's timeline. Seems bad. Shouldn't we throw an
395 } else if (strlen($notice->content) > 140) {
397 // XXX: Twitter truncates anything over 140, flags the status
398 // as "truncated." Sending this error may screw up some clients
399 // that assume Twitter will truncate for them. Should we just
400 // truncate too? -- Zach
401 header('HTTP/1.1 406 Not Acceptable');
402 print "That's too long. Max notice size is 140 chars.\n";
406 $notice->rendered = common_render_content($notice->content, $notice);
408 $id = $notice->insert();
411 common_server_error('Could not update status!', 500);
415 $orig = clone($notice);
416 $notice->uri = common_notice_uri($notice);
418 if (!$notice->update($orig)) {
419 common_server_error('Could not save status!', 500);
423 common_save_replies($notice);
424 common_broadcast_notice($notice);
427 // I should be able to just sent this notice off for display,
428 // but $notice->created does not contain a string at this
429 // point and I don't know how to convert it to one here. So
430 // I'm forced to have DBObject pull the notice back out of the
431 // DB before printing. --Zach
432 $apidata['api_arg'] = $id;
433 $this->show($args, $apidata);
439 Returns the 20 most recent @replies (status updates prefixed with @username) for the authenticating user.
440 URL: http://server/api/statuses/replies.format
442 Formats: xml, json, rss, atom
446 * page. Optional. Retrieves the 20 next most recent replies. Ex: http://server/api/statuses/replies.xml?page=3
447 * since. Optional. Narrows the returned results to just those replies created after the specified HTTP-formatted date. The
448 same behavior is available by setting an If-Modified-Since header in your HTTP request. Ex:
449 http://server/api/statuses/replies.xml?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
450 * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than) the specified
451 ID. Ex: http://server/api/statuses/replies.xml?since_id=12345
453 function replies($args, $apidata) {
455 parent::handle($args);
457 $since = $this->arg('since');
459 $count = $this->arg('count');
460 $page = $this->arg('page');
462 $user = $apidata['user'];
463 $profile = $user->getProfile();
465 $sitename = common_config('site', 'name');
466 $siteserver = common_config('site', 'server');
468 $title = sprintf(_("%s / Updates replying to %s"), $sitename, $user->nickname);
469 $id = "tag:$siteserver:replies:".$user->id;
470 $link = common_local_url('replies', array('nickname' => $user->nickname));
472 $subtitle = sprintf(_("%s updates that reply to updates from %s / %s."), $sitename, $user->nickname, $profile->getBestName());
482 $reply = new Reply();
484 $reply->profile_id = $user->id;
486 $reply->orderBy('modified DESC');
488 $page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
490 $reply->limit((($page-1)*20), $count);
492 $cnt = $reply->find();
497 while ($reply->fetch()) {
498 $notice = new Notice();
499 $notice->id = $reply->notice_id;
500 $result = $notice->find(true);
504 $notices[] = clone($notice);
508 switch($apidata['content-type']) {
510 $this->show_xml_timeline($notices);
513 $this->show_rss_timeline($notices, $title, $id, $link, $subtitle);
516 $this->show_atom_timeline($notices, $title, $id, $link, $subtitle);
519 $this->show_json_timeline($notices);
522 common_user_error("API method not found!", $code = 404);
534 Destroys the status specified by the required ID parameter. The authenticating user must be
535 the author of the specified status.
537 URL: http://server/api/statuses/destroy/id.format
543 * id. Required. The ID of the status to destroy. Ex:
544 http://server/api/statuses/destroy/12345.json or
545 http://server/api/statuses/destroy/23456.xml
548 function destroy($args, $apidata) {
549 parent::handle($args);
550 common_server_error("API method under construction.", $code=501);
556 Returns up to 100 of the authenticating user's friends who have most recently updated, each with current status inline.
557 It's also possible to request another user's recent friends list via the id parameter below.
559 URL: http://server/api/statuses/friends.format
565 * id. Optional. The ID or screen name of the user for whom to request a list of friends. Ex:
566 http://server/api/statuses/friends/12345.json
568 http://server/api/statuses/friends/bob.xml
569 * page. Optional. Retrieves the next 100 friends. Ex: http://server/api/statuses/friends.xml?page=2
570 * lite. Optional. Prevents the inline inclusion of current status. Must be set to a value of true. Ex:
571 http://server/api/statuses/friends.xml?lite=true
572 * since. Optional. Narrows the returned results to just those friendships created after the specified
573 HTTP-formatted date. The same behavior is available by setting an If-Modified-Since header in your HTTP
574 request. Ex: http://server/api/statuses/friends.xml?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
576 function friends($args, $apidata) {
577 parent::handle($args);
578 return $this->subscriptions($apidata, 'subscribed', 'subscriber');
582 Returns the authenticating user's followers, each with current status inline. They are ordered by the
583 order in which they joined Twitter (this is going to be changed).
585 URL: http://server/api/statuses/followers.format
590 * id. Optional. The ID or screen name of the user for whom to request a list of followers. Ex:
591 http://server/api/statuses/followers/12345.json
593 http://server/api/statuses/followers/bob.xml
594 * page. Optional. Retrieves the next 100 followers. Ex: http://server/api/statuses/followers.xml?page=2
595 * lite. Optional. Prevents the inline inclusion of current status. Must be set to a value of true.
596 Ex: http://server/api/statuses/followers.xml?lite=true
598 function followers($args, $apidata) {
599 parent::handle($args);
601 return $this->subscriptions($apidata, 'subscriber', 'subscribed');
604 function subscriptions($apidata, $other_attr, $user_attr) {
606 $user = $this->get_subs_user($apidata);
611 $page = $this->trimmed('page');
613 if (!$page || !is_numeric($page)) {
617 $profile = $user->getProfile();
620 common_server_error(_('User has no profile.'));
624 $sub = new Subscription();
625 $sub->$user_attr = $profile->id;
626 $sub->orderBy('created DESC');
627 $sub->limit(($page-1)*100, 100);
632 while ($sub->fetch()) {
633 $others[] = Profile::staticGet($sub->$other_attr);
636 // user has no followers
639 $type = $apidata['content-type'];
641 $this->init_document($type);
642 $this->show_profiles($others, $type);
643 $this->end_document($type);
647 function get_subs_user($apidata) {
649 // function was called with an argument /statuses/user_timeline/api_arg.format
650 if (isset($apidata['api_arg'])) {
652 if (is_numeric($apidata['api_arg'])) {
653 $user = User::staticGet($apidata['api_arg']);
655 $nickname = common_canonical_nickname($apidata['api_arg']);
656 $user = User::staticGet('nickname', $nickname);
660 // if no user was specified, then we'll use the authenticated user
661 $user = $apidata['user'];
665 // Set the user to be the auth user if asked-for can't be found
666 // honestly! This is what Twitter does, I swear --Zach
667 $user = $apidata['user'];
673 function show_profiles($profiles, $type) {
676 common_element_start('users', array('type' => 'array'));
677 foreach ($profiles as $profile) {
678 $this->show_profile($profile);
680 common_element_end('users');
684 foreach ($profiles as $profile) {
685 $arrays[] = $this->twitter_user_array($profile, true);
687 print json_encode($arrays);
690 $this->client_error(_('unsupported file type'));
696 Returns a list of the users currently featured on the site with their current statuses inline.
697 URL: http://server/api/statuses/featured.format
701 function featured($args, $apidata) {
702 parent::handle($args);
703 common_server_error("API method under construction.", $code=501);
706 function get_user($id, $apidata) {
708 return $apidata['user'];
709 } else if (is_numeric($id)) {
710 return User::staticGet($id);
712 return User::staticGet('nickname', $id);