3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, Control Yourself, 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')) {
24 class TwitterapiAction extends Action
32 * @param array $args Web and URL arguments
34 * @return boolean false if user doesn't exist
37 function prepare($args)
39 parent::prepare($args);
46 * @param array $args Arguments from $_REQUEST
51 function handle($args)
53 parent::handle($args);
57 * Overrides XMLOutputter::element to write booleans as strings (true|false).
58 * See that method's documentation for more info.
60 * @param string $tag Element type or tagname
61 * @param array $attrs Array of element attributes, as
63 * @param string $content string content of the element
67 function element($tag, $attrs=null, $content=null)
69 if (is_bool($content)) {
70 $content = ($content ? 'true' : 'false');
73 return parent::element($tag, $attrs, $content);
76 function twitter_user_array($profile, $get_notice=false)
78 $twitter_user = array();
80 $twitter_user['id'] = intval($profile->id);
81 $twitter_user['name'] = $profile->getBestName();
82 $twitter_user['screen_name'] = $profile->nickname;
83 $twitter_user['location'] = ($profile->location) ? $profile->location : null;
84 $twitter_user['description'] = ($profile->bio) ? $profile->bio : null;
86 $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
87 $twitter_user['profile_image_url'] = ($avatar) ? $avatar->displayUrl() :
88 Avatar::defaultImage(AVATAR_STREAM_SIZE);
90 $twitter_user['url'] = ($profile->homepage) ? $profile->homepage : null;
91 $twitter_user['protected'] = false; # not supported by Laconica yet
92 $twitter_user['followers_count'] = $profile->subscriberCount();
94 // To be supported soon...
95 $twitter_user['profile_background_color'] = '';
96 $twitter_user['profile_text_color'] = '';
97 $twitter_user['profile_link_color'] = '';
98 $twitter_user['profile_sidebar_fill_color'] = '';
99 $twitter_user['profile_sidebar_border_color'] = '';
101 $twitter_user['friends_count'] = $profile->subscriptionCount();
103 $twitter_user['created_at'] = $this->date_twitter($profile->created);
105 $twitter_user['favourites_count'] = $profile->faveCount(); // British spelling!
107 // Need to pull up the user for some of this
108 $user = User::staticGet($profile->id);
112 if ($user->timezone) {
113 $timezone = $user->timezone;
117 $t->setTimezone(new DateTimeZone($timezone));
119 $twitter_user['utc_offset'] = $t->format('Z');
120 $twitter_user['time_zone'] = $timezone;
122 // To be supported some day, perhaps
123 $twitter_user['profile_background_image_url'] = '';
124 $twitter_user['profile_background_tile'] = false;
126 $twitter_user['statuses_count'] = $profile->noticeCount();
128 // Is the requesting user following this user?
129 $twitter_user['following'] = false;
130 $twitter_user['notifications'] = false;
132 if (isset($apidata['user'])) {
134 $twitter_user['following'] = $apidata['user']->isSubscribed($profile);
137 $sub = Subscription::pkeyGet(array('subscriber' =>
138 $apidata['user']->id, 'subscribed' => $profile->id));
141 $twitter_user['notifications'] = ($sub->jabber || $sub->sms);
146 $notice = $profile->getCurrentNotice();
149 $twitter_user['status'] = $this->twitter_status_array($notice, false);
153 return $twitter_user;
156 function twitter_status_array($notice, $include_user=true)
158 $profile = $notice->getProfile();
160 $twitter_status = array();
161 $twitter_status['text'] = $notice->content;
162 $twitter_status['truncated'] = false; # Not possible on Laconica
163 $twitter_status['created_at'] = $this->date_twitter($notice->created);
164 $twitter_status['in_reply_to_status_id'] = ($notice->reply_to) ?
165 intval($notice->reply_to) : null;
166 $twitter_status['source'] = $this->source_link($notice->source);
167 $twitter_status['id'] = intval($notice->id);
169 $replier_profile = null;
171 if ($notice->reply_to) {
172 $reply = Notice::staticGet(intval($notice->reply_to));
174 $replier_profile = $reply->getProfile();
178 $twitter_status['in_reply_to_user_id'] =
179 ($replier_profile) ? intval($replier_profile->id) : null;
180 $twitter_status['in_reply_to_screen_name'] =
181 ($replier_profile) ? $replier_profile->nickname : null;
183 if (isset($this->auth_user)) {
184 $twitter_status['favorited'] = $this->auth_user->hasFave($notice);
186 $twitter_status['favorited'] = false;
190 # Don't get notice (recursive!)
191 $twitter_user = $this->twitter_user_array($profile, false);
192 $twitter_status['user'] = $twitter_user;
195 return $twitter_status;
198 function twitter_rss_entry_array($notice)
200 $profile = $notice->getProfile();
203 # We trim() to avoid extraneous whitespace in the output
205 $entry['content'] = common_xml_safe_str(trim($notice->rendered));
206 $entry['title'] = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
207 $entry['link'] = common_local_url('shownotice', array('notice' => $notice->id));
208 $entry['published'] = common_date_iso8601($notice->created);
210 $taguribase = common_config('integration', 'taguri');
211 $entry['id'] = "tag:$taguribase:$entry[link]";
213 $entry['updated'] = $entry['published'];
214 $entry['author'] = $profile->getBestName();
217 $attachments = $notice->attachments();
219 $entry['enclosures']=array();
220 foreach($attachments as $attachment){
221 if (isset($attachment->filename)) {
223 $enclosure['url']=$attachment->url;
224 $enclosure['mimetype']=$attachment->mimetype;
225 $enclosure['size']=$attachment->size;
226 $entry['enclosures'][]=$enclosure;
232 $entry['description'] = $entry['content'];
233 $entry['pubDate'] = common_date_rfc2822($notice->created);
234 $entry['guid'] = $entry['link'];
239 function twitter_rss_dmsg_array($message)
244 $entry['title'] = sprintf('Message from %s to %s',
245 $message->getFrom()->nickname, $message->getTo()->nickname);
247 $entry['content'] = common_xml_safe_str(trim($message->content));
248 $entry['link'] = common_local_url('showmessage', array('message' => $message->id));
249 $entry['published'] = common_date_iso8601($message->created);
251 $taguribase = common_config('integration', 'taguri');
253 $entry['id'] = "tag:$taguribase,:$entry[link]";
254 $entry['updated'] = $entry['published'];
255 $entry['author'] = $message->getFrom()->getBestName();
258 $entry['description'] = $entry['content'];
259 $entry['pubDate'] = common_date_rfc2822($message->created);
260 $entry['guid'] = $entry['link'];
265 function twitter_dmsg_array($message)
267 $twitter_dm = array();
269 $from_profile = $message->getFrom();
270 $to_profile = $message->getTo();
272 $twitter_dm['id'] = $message->id;
273 $twitter_dm['sender_id'] = $message->from_profile;
274 $twitter_dm['text'] = trim($message->content);
275 $twitter_dm['recipient_id'] = $message->to_profile;
276 $twitter_dm['created_at'] = $this->date_twitter($message->created);
277 $twitter_dm['sender_screen_name'] = $from_profile->nickname;
278 $twitter_dm['recipient_screen_name'] = $to_profile->nickname;
279 $twitter_dm['sender'] = $this->twitter_user_array($from_profile, false);
280 $twitter_dm['recipient'] = $this->twitter_user_array($to_profile, false);
285 function twitter_relationship_array($source, $target)
287 $relationship = array();
289 $relationship['source'] =
290 $this->relationship_details_array($source, $target);
291 $relationship['target'] =
292 $this->relationship_details_array($target, $source);
294 return array('relationship' => $relationship);
297 function relationship_details_array($source, $target)
301 $details['screen_name'] = $source->nickname;
302 $details['followed_by'] = $target->isSubscribed($source);
303 $details['following'] = $source->isSubscribed($target);
305 $notifications = false;
307 if ($source->isSubscribed($target)) {
309 $sub = Subscription::pkeyGet(array('subscriber' =>
310 $source->id, 'subscribed' => $target->id));
313 $notifications = ($sub->jabber || $sub->sms);
317 $details['notifications_enabled'] = $notifications;
318 $details['blocking'] = $source->hasBlocked($target);
319 $details['id'] = $source->id;
324 function show_twitter_xml_relationship($relationship)
326 $this->elementStart('relationship');
328 foreach($relationship as $element => $value) {
329 if ($element == 'source' || $element == 'target') {
330 $this->elementStart($element);
331 $this->show_xml_relationship_details($value);
332 $this->elementEnd($element);
336 $this->elementEnd('relationship');
339 function show_xml_relationship_details($details)
341 foreach($details as $element => $value) {
342 $this->element($element, null, $value);
346 function show_twitter_xml_status($twitter_status)
348 $this->elementStart('status');
349 foreach($twitter_status as $element => $value) {
352 $this->show_twitter_xml_user($twitter_status['user']);
355 $this->element($element, null, common_xml_safe_str($value));
358 $this->element($element, null, $value);
361 $this->elementEnd('status');
364 function show_twitter_xml_user($twitter_user, $role='user')
366 $this->elementStart($role);
367 foreach($twitter_user as $element => $value) {
368 if ($element == 'status') {
369 $this->show_twitter_xml_status($twitter_user['status']);
371 $this->element($element, null, $value);
374 $this->elementEnd($role);
377 function show_twitter_rss_item($entry)
379 $this->elementStart('item');
380 $this->element('title', null, $entry['title']);
381 $this->element('description', null, $entry['description']);
382 $this->element('pubDate', null, $entry['pubDate']);
383 $this->element('guid', null, $entry['guid']);
384 $this->element('link', null, $entry['link']);
386 # RSS only supports 1 enclosure per item
387 if($entry['enclosures']){
388 $enclosure = $entry['enclosures'][0];
389 $this->element('enclosure', array('url'=>$enclosure['url'],'type'=>$enclosure['mimetype'],'length'=>$enclosure['size']), null);
392 $this->elementEnd('item');
395 function show_json_objects($objects)
397 print(json_encode($objects));
400 function show_single_xml_status($notice)
402 $this->init_document('xml');
403 $twitter_status = $this->twitter_status_array($notice);
404 $this->show_twitter_xml_status($twitter_status);
405 $this->end_document('xml');
408 function show_single_json_status($notice)
410 $this->init_document('json');
411 $status = $this->twitter_status_array($notice);
412 $this->show_json_objects($status);
413 $this->end_document('json');
416 function show_single_xml_dmsg($message)
418 $this->init_document('xml');
419 $dmsg = $this->twitter_dmsg_array($message);
420 $this->show_twitter_xml_dmsg($dmsg);
421 $this->end_document('xml');
424 function show_single_json_dmsg($message)
426 $this->init_document('json');
427 $dmsg = $this->twitter_dmsg_array($message);
428 $this->show_json_objects($dmsg);
429 $this->end_document('json');
432 function show_twitter_xml_dmsg($twitter_dm)
434 $this->elementStart('direct_message');
435 foreach($twitter_dm as $element => $value) {
439 $this->show_twitter_xml_user($value, $element);
442 $this->element($element, null, common_xml_safe_str($value));
445 $this->element($element, null, $value);
448 $this->elementEnd('direct_message');
451 function show_xml_timeline($notice)
454 $this->init_document('xml');
455 $this->elementStart('statuses', array('type' => 'array'));
457 if (is_array($notice)) {
458 foreach ($notice as $n) {
459 $twitter_status = $this->twitter_status_array($n);
460 $this->show_twitter_xml_status($twitter_status);
463 while ($notice->fetch()) {
464 $twitter_status = $this->twitter_status_array($notice);
465 $this->show_twitter_xml_status($twitter_status);
469 $this->elementEnd('statuses');
470 $this->end_document('xml');
473 function show_rss_timeline($notice, $title, $link, $subtitle, $suplink=null)
476 $this->init_document('rss');
478 $this->elementStart('channel');
479 $this->element('title', null, $title);
480 $this->element('link', null, $link);
481 if (!is_null($suplink)) {
482 # For FriendFeed's SUP protocol
483 $this->element('link', array('xmlns' => 'http://www.w3.org/2005/Atom',
484 'rel' => 'http://api.friendfeed.com/2008/03#sup',
486 'type' => 'application/json'));
488 $this->element('description', null, $subtitle);
489 $this->element('language', null, 'en-us');
490 $this->element('ttl', null, '40');
492 if (is_array($notice)) {
493 foreach ($notice as $n) {
494 $entry = $this->twitter_rss_entry_array($n);
495 $this->show_twitter_rss_item($entry);
498 while ($notice->fetch()) {
499 $entry = $this->twitter_rss_entry_array($notice);
500 $this->show_twitter_rss_item($entry);
504 $this->elementEnd('channel');
505 $this->end_twitter_rss();
508 function show_atom_timeline($notice, $title, $id, $link, $subtitle=null, $suplink=null, $selfuri=null)
511 $this->init_document('atom');
513 $this->element('title', null, $title);
514 $this->element('id', null, $id);
515 $this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null);
517 if (!is_null($suplink)) {
518 # For FriendFeed's SUP protocol
519 $this->element('link', array('rel' => 'http://api.friendfeed.com/2008/03#sup',
521 'type' => 'application/json'));
524 if (!is_null($selfuri)) {
525 $this->element('link', array('href' => $selfuri,
526 'rel' => 'self', 'type' => 'application/atom+xml'), null);
529 $this->element('updated', null, common_date_iso8601('now'));
530 $this->element('subtitle', null, $subtitle);
532 if (is_array($notice)) {
533 foreach ($notice as $n) {
534 $this->raw($n->asAtomEntry());
537 while ($notice->fetch()) {
538 $this->raw($notice->asAtomEntry());
542 $this->end_document('atom');
546 function show_json_timeline($notice)
549 $this->init_document('json');
553 if (is_array($notice)) {
554 foreach ($notice as $n) {
555 $twitter_status = $this->twitter_status_array($n);
556 array_push($statuses, $twitter_status);
559 while ($notice->fetch()) {
560 $twitter_status = $this->twitter_status_array($notice);
561 array_push($statuses, $twitter_status);
565 $this->show_json_objects($statuses);
567 $this->end_document('json');
570 // Anyone know what date format this is?
571 // Twitter's dates look like this: "Mon Jul 14 23:52:38 +0000 2008" -- Zach
572 function date_twitter($dt)
575 return date("D M d H:i:s O Y", $t);
578 // XXX: Candidate for a general utility method somewhere?
579 function count_subscriptions($profile)
583 $sub = new Subscription();
584 $sub->subscribed = $profile->id;
586 $count = $sub->find();
595 function init_document($type='xml')
599 header('Content-Type: application/xml; charset=utf-8');
603 header('Content-Type: application/json; charset=utf-8');
605 // Check for JSONP callback
606 $callback = $this->arg('callback');
608 print $callback . '(';
612 header("Content-Type: application/rss+xml; charset=utf-8");
613 $this->init_twitter_rss();
616 header('Content-Type: application/atom+xml; charset=utf-8');
617 $this->init_twitter_atom();
620 $this->clientError(_('Not a supported data format.'));
627 function end_document($type='xml')
635 // Check for JSONP callback
636 $callback = $this->arg('callback');
642 $this->end_twitter_rss();
645 $this->end_twitter_rss();
648 $this->clientError(_('Not a supported data format.'));
654 function clientError($msg, $code = 400, $content_type = 'json')
657 static $status = array(400 => 'Bad Request',
658 401 => 'Unauthorized',
659 402 => 'Payment Required',
662 405 => 'Method Not Allowed',
663 406 => 'Not Acceptable',
664 407 => 'Proxy Authentication Required',
665 408 => 'Request Timeout',
668 411 => 'Length Required',
669 412 => 'Precondition Failed',
670 413 => 'Request Entity Too Large',
671 414 => 'Request-URI Too Long',
672 415 => 'Unsupported Media Type',
673 416 => 'Requested Range Not Satisfiable',
674 417 => 'Expectation Failed');
676 $action = $this->trimmed('action');
678 common_debug("User error '$code' on '$action': $msg", __FILE__);
680 if (!array_key_exists($code, $status)) {
684 $status_string = $status[$code];
685 header('HTTP/1.1 '.$code.' '.$status_string);
687 if ($content_type == 'xml') {
688 $this->init_document('xml');
689 $this->elementStart('hash');
690 $this->element('error', null, $msg);
691 $this->element('request', null, $_SERVER['REQUEST_URI']);
692 $this->elementEnd('hash');
693 $this->end_document('xml');
695 $this->init_document('json');
696 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
697 print(json_encode($error_array));
698 $this->end_document('json');
703 function init_twitter_rss()
706 $this->elementStart('rss', array('version' => '2.0'));
709 function end_twitter_rss()
711 $this->elementEnd('rss');
715 function init_twitter_atom()
718 // FIXME: don't hardcode the language here!
719 $this->elementStart('feed', array('xmlns' => 'http://www.w3.org/2005/Atom',
720 'xml:lang' => 'en-US',
721 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0'));
724 function end_twitter_atom()
726 $this->elementEnd('feed');
730 function show_profile($profile, $content_type='xml', $notice=null)
732 $profile_array = $this->twitter_user_array($profile, true);
733 switch ($content_type) {
735 $this->show_twitter_xml_user($profile_array);
738 $this->show_json_objects($profile_array);
741 $this->clientError(_('Not a supported data format.'));
747 function get_user($id, $apidata=null)
751 // Twitter supports these other ways of passing the user ID
752 if (is_numeric($this->arg('id'))) {
753 return User::staticGet($this->arg('id'));
754 } else if ($this->arg('id')) {
755 $nickname = common_canonical_nickname($this->arg('id'));
756 return User::staticGet('nickname', $nickname);
757 } else if ($this->arg('user_id')) {
758 // This is to ensure that a non-numeric user_id still
759 // overrides screen_name even if it doesn't get used
760 if (is_numeric($this->arg('user_id'))) {
761 return User::staticGet('id', $this->arg('user_id'));
763 } else if ($this->arg('screen_name')) {
764 $nickname = common_canonical_nickname($this->arg('screen_name'));
765 return User::staticGet('nickname', $nickname);
767 // Fall back to trying the currently authenticated user
768 return $apidata['user'];
771 } else if (is_numeric($id)) {
772 return User::staticGet($id);
774 $nickname = common_canonical_nickname($id);
775 return User::staticGet('nickname', $nickname);
779 function get_group($id, $apidata=null)
783 if (is_numeric($this->arg('id'))) {
784 return User_group::staticGet($this->arg('id'));
785 } else if ($this->arg('id')) {
786 $nickname = common_canonical_nickname($this->arg('id'));
787 return User_group::staticGet('nickname', $nickname);
788 } else if ($this->arg('group_id')) {
789 // This is to ensure that a non-numeric user_id still
790 // overrides screen_name even if it doesn't get used
791 if (is_numeric($this->arg('group_id'))) {
792 return User_group::staticGet('id', $this->arg('group_id'));
794 } else if ($this->arg('group_name')) {
795 $nickname = common_canonical_nickname($this->arg('group_name'));
796 return User_group::staticGet('nickname', $nickname);
799 } else if (is_numeric($id)) {
800 return User_group::staticGet($id);
802 $nickname = common_canonical_nickname($id);
803 return User_group::staticGet('nickname', $nickname);
807 function get_profile($id)
809 if (is_numeric($id)) {
810 return Profile::staticGet($id);
812 $user = User::staticGet('nickname', $id);
814 return $user->getProfile();
821 function source_link($source)
823 $source_name = _($source);
832 $ns = Notice_source::staticGet($source);
834 $source_name = '<a href="' . $ns->url . '">' . $ns->name . '</a>';
842 * Returns query argument or default value if not found. Certain
843 * parameters used throughout the API are lightly scrubbed and
844 * bounds checked. This overrides Action::arg().
846 * @param string $key requested argument
847 * @param string $def default value to return if $key is not provided
851 function arg($key, $def=null)
854 // XXX: Do even more input validation/scrubbing?
856 if (array_key_exists($key, $this->args)) {
859 $page = (int)$this->args['page'];
860 return ($page < 1) ? 1 : $page;
862 $count = (int)$this->args['count'];
865 } elseif ($count > 200) {
871 $since_id = (int)$this->args['since_id'];
872 return ($since_id < 1) ? 0 : $since_id;
874 $max_id = (int)$this->args['max_id'];
875 return ($max_id < 1) ? 0 : $max_id;
877 return strtotime($this->args['since']);
879 return parent::arg($key, $def);