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 $attachments = $notice->attachments();
191 $enclosures = array();
193 foreach ($attachments as $attachment) {
194 if ($attachment->isEnclosure()) {
195 $enclosure = array();
196 $enclosure['url'] = $attachment->url;
197 $enclosure['mimetype'] = $attachment->mimetype;
198 $enclosure['size'] = $attachment->size;
199 $enclosures[] = $enclosure;
203 if (!empty($enclosures)) {
204 $twitter_status['attachments'] = $enclosures;
208 # Don't get notice (recursive!)
209 $twitter_user = $this->twitter_user_array($profile, false);
210 $twitter_status['user'] = $twitter_user;
213 return $twitter_status;
216 function twitter_group_array($group)
218 $twitter_group=array();
219 $twitter_group['id']=$group->id;
220 $twitter_group['url']=$group->permalink();
221 $twitter_group['nickname']=$group->nickname;
222 $twitter_group['fullname']=$group->fullname;
223 $twitter_group['homepage_url']=$group->homepage_url;
224 $twitter_group['original_logo']=$group->original_logo;
225 $twitter_group['homepage_logo']=$group->homepage_logo;
226 $twitter_group['stream_logo']=$group->stream_logo;
227 $twitter_group['mini_logo']=$group->mini_logo;
228 $twitter_group['homepage']=$group->homepage;
229 $twitter_group['description']=$group->description;
230 $twitter_group['location']=$group->location;
231 $twitter_group['created']=$this->date_twitter($group->created);
232 $twitter_group['modified']=$this->date_twitter($group->modified);
233 return $twitter_group;
236 function twitter_rss_entry_array($notice)
238 $profile = $notice->getProfile();
241 // We trim() to avoid extraneous whitespace in the output
243 $entry['content'] = common_xml_safe_str(trim($notice->rendered));
244 $entry['title'] = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
245 $entry['link'] = common_local_url('shownotice', array('notice' => $notice->id));
246 $entry['published'] = common_date_iso8601($notice->created);
248 $taguribase = common_config('integration', 'taguri');
249 $entry['id'] = "tag:$taguribase:$entry[link]";
251 $entry['updated'] = $entry['published'];
252 $entry['author'] = $profile->getBestName();
255 $attachments = $notice->attachments();
256 $enclosures = array();
258 foreach ($attachments as $attachment) {
259 if ($attachment->isEnclosure()) {
260 $enclosure = array();
261 $enclosure['url'] = $attachment->url;
262 $enclosure['mimetype'] = $attachment->mimetype;
263 $enclosure['size'] = $attachment->size;
264 $enclosures[] = $enclosure;
268 if (!empty($enclosures)) {
269 $entry['enclosures'] = $enclosures;
274 $attachments = $notice->attachments();
276 $entry['enclosures']=array();
277 foreach($attachments as $attachment){
278 if ($attachment->isEnclosure()) {
280 $enclosure['url']=$attachment->url;
281 $enclosure['mimetype']=$attachment->mimetype;
282 $enclosure['size']=$attachment->size;
283 $entry['enclosures'][]=$enclosure;
290 $tag = new Notice_tag();
291 $tag->notice_id = $notice->id;
293 $entry['tags']=array();
294 while ($tag->fetch()) {
295 $entry['tags'][]=$tag->tag;
301 $entry['description'] = $entry['content'];
302 $entry['pubDate'] = common_date_rfc2822($notice->created);
303 $entry['guid'] = $entry['link'];
308 function twitter_rss_dmsg_array($message)
313 $entry['title'] = sprintf('Message from %s to %s',
314 $message->getFrom()->nickname, $message->getTo()->nickname);
316 $entry['content'] = common_xml_safe_str(trim($message->content));
317 $entry['link'] = common_local_url('showmessage', array('message' => $message->id));
318 $entry['published'] = common_date_iso8601($message->created);
320 $taguribase = common_config('integration', 'taguri');
322 $entry['id'] = "tag:$taguribase,:$entry[link]";
323 $entry['updated'] = $entry['published'];
324 $entry['author'] = $message->getFrom()->getBestName();
327 $entry['description'] = $entry['content'];
328 $entry['pubDate'] = common_date_rfc2822($message->created);
329 $entry['guid'] = $entry['link'];
334 function twitter_dmsg_array($message)
336 $twitter_dm = array();
338 $from_profile = $message->getFrom();
339 $to_profile = $message->getTo();
341 $twitter_dm['id'] = $message->id;
342 $twitter_dm['sender_id'] = $message->from_profile;
343 $twitter_dm['text'] = trim($message->content);
344 $twitter_dm['recipient_id'] = $message->to_profile;
345 $twitter_dm['created_at'] = $this->date_twitter($message->created);
346 $twitter_dm['sender_screen_name'] = $from_profile->nickname;
347 $twitter_dm['recipient_screen_name'] = $to_profile->nickname;
348 $twitter_dm['sender'] = $this->twitter_user_array($from_profile, false);
349 $twitter_dm['recipient'] = $this->twitter_user_array($to_profile, false);
354 function twitter_relationship_array($source, $target)
356 $relationship = array();
358 $relationship['source'] =
359 $this->relationship_details_array($source, $target);
360 $relationship['target'] =
361 $this->relationship_details_array($target, $source);
363 return array('relationship' => $relationship);
366 function relationship_details_array($source, $target)
370 $details['screen_name'] = $source->nickname;
371 $details['followed_by'] = $target->isSubscribed($source);
372 $details['following'] = $source->isSubscribed($target);
374 $notifications = false;
376 if ($source->isSubscribed($target)) {
378 $sub = Subscription::pkeyGet(array('subscriber' =>
379 $source->id, 'subscribed' => $target->id));
382 $notifications = ($sub->jabber || $sub->sms);
386 $details['notifications_enabled'] = $notifications;
387 $details['blocking'] = $source->hasBlocked($target);
388 $details['id'] = $source->id;
393 function show_twitter_xml_relationship($relationship)
395 $this->elementStart('relationship');
397 foreach($relationship as $element => $value) {
398 if ($element == 'source' || $element == 'target') {
399 $this->elementStart($element);
400 $this->show_xml_relationship_details($value);
401 $this->elementEnd($element);
405 $this->elementEnd('relationship');
408 function show_xml_relationship_details($details)
410 foreach($details as $element => $value) {
411 $this->element($element, null, $value);
415 function show_twitter_xml_status($twitter_status)
417 $this->elementStart('status');
418 foreach($twitter_status as $element => $value) {
421 $this->show_twitter_xml_user($twitter_status['user']);
424 $this->element($element, null, common_xml_safe_str($value));
427 $this->show_xml_attachments($twitter_status['attachments']);
430 $this->element($element, null, $value);
433 $this->elementEnd('status');
436 function show_twitter_xml_group($twitter_group)
438 $this->elementStart('group');
439 foreach($twitter_group as $element => $value) {
440 $this->element($element, null, $value);
442 $this->elementEnd('group');
445 function show_twitter_xml_user($twitter_user, $role='user')
447 $this->elementStart($role);
448 foreach($twitter_user as $element => $value) {
449 if ($element == 'status') {
450 $this->show_twitter_xml_status($twitter_user['status']);
452 $this->element($element, null, $value);
455 $this->elementEnd($role);
458 function show_xml_attachments($attachments) {
459 if (!empty($attachments)) {
460 $this->elementStart('attachments', array('type' => 'array'));
461 foreach ($attachments as $attachment) {
463 $attrs['url'] = $attachment['url'];
464 $attrs['mimetype'] = $attachment['mimetype'];
465 $attrs['size'] = $attachment['size'];
466 $this->element('enclosure', $attrs, '');
468 $this->elementEnd('attachments');
472 function show_twitter_rss_item($entry)
474 $this->elementStart('item');
475 $this->element('title', null, $entry['title']);
476 $this->element('description', null, $entry['description']);
477 $this->element('pubDate', null, $entry['pubDate']);
478 $this->element('guid', null, $entry['guid']);
479 $this->element('link', null, $entry['link']);
481 # RSS only supports 1 enclosure per item
482 if(array_key_exists('enclosures', $entry) and !empty($entry['enclosures'])){
483 $enclosure = $entry['enclosures'][0];
484 $this->element('enclosure', array('url'=>$enclosure['url'],'type'=>$enclosure['mimetype'],'length'=>$enclosure['size']), null);
487 if(array_key_exists('tags', $entry)){
488 foreach($entry['tags'] as $tag){
489 $this->element('category', null,$tag);
493 $this->elementEnd('item');
496 function show_json_objects($objects)
498 print(json_encode($objects));
501 function show_single_xml_status($notice)
503 $this->init_document('xml');
504 $twitter_status = $this->twitter_status_array($notice);
505 $this->show_twitter_xml_status($twitter_status);
506 $this->end_document('xml');
509 function show_single_json_status($notice)
511 $this->init_document('json');
512 $status = $this->twitter_status_array($notice);
513 $this->show_json_objects($status);
514 $this->end_document('json');
517 function show_single_xml_dmsg($message)
519 $this->init_document('xml');
520 $dmsg = $this->twitter_dmsg_array($message);
521 $this->show_twitter_xml_dmsg($dmsg);
522 $this->end_document('xml');
525 function show_single_json_dmsg($message)
527 $this->init_document('json');
528 $dmsg = $this->twitter_dmsg_array($message);
529 $this->show_json_objects($dmsg);
530 $this->end_document('json');
533 function show_twitter_xml_dmsg($twitter_dm)
535 $this->elementStart('direct_message');
536 foreach($twitter_dm as $element => $value) {
540 $this->show_twitter_xml_user($value, $element);
543 $this->element($element, null, common_xml_safe_str($value));
546 $this->element($element, null, $value);
549 $this->elementEnd('direct_message');
552 function show_xml_timeline($notice)
555 $this->init_document('xml');
556 $this->elementStart('statuses', array('type' => 'array'));
558 if (is_array($notice)) {
559 foreach ($notice as $n) {
560 $twitter_status = $this->twitter_status_array($n);
561 $this->show_twitter_xml_status($twitter_status);
564 while ($notice->fetch()) {
565 $twitter_status = $this->twitter_status_array($notice);
566 $this->show_twitter_xml_status($twitter_status);
570 $this->elementEnd('statuses');
571 $this->end_document('xml');
574 function show_rss_timeline($notice, $title, $link, $subtitle, $suplink=null)
577 $this->init_document('rss');
579 $this->elementStart('channel');
580 $this->element('title', null, $title);
581 $this->element('link', null, $link);
582 if (!is_null($suplink)) {
583 # For FriendFeed's SUP protocol
584 $this->element('link', array('xmlns' => 'http://www.w3.org/2005/Atom',
585 'rel' => 'http://api.friendfeed.com/2008/03#sup',
587 'type' => 'application/json'));
589 $this->element('description', null, $subtitle);
590 $this->element('language', null, 'en-us');
591 $this->element('ttl', null, '40');
593 if (is_array($notice)) {
594 foreach ($notice as $n) {
595 $entry = $this->twitter_rss_entry_array($n);
596 $this->show_twitter_rss_item($entry);
599 while ($notice->fetch()) {
600 $entry = $this->twitter_rss_entry_array($notice);
601 $this->show_twitter_rss_item($entry);
605 $this->elementEnd('channel');
606 $this->end_twitter_rss();
609 function show_atom_timeline($notice, $title, $id, $link, $subtitle=null, $suplink=null, $selfuri=null)
612 $this->init_document('atom');
614 $this->element('title', null, $title);
615 $this->element('id', null, $id);
616 $this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null);
618 if (!is_null($suplink)) {
619 # For FriendFeed's SUP protocol
620 $this->element('link', array('rel' => 'http://api.friendfeed.com/2008/03#sup',
622 'type' => 'application/json'));
625 if (!is_null($selfuri)) {
626 $this->element('link', array('href' => $selfuri,
627 'rel' => 'self', 'type' => 'application/atom+xml'), null);
630 $this->element('updated', null, common_date_iso8601('now'));
631 $this->element('subtitle', null, $subtitle);
633 if (is_array($notice)) {
634 foreach ($notice as $n) {
635 $this->raw($n->asAtomEntry());
638 while ($notice->fetch()) {
639 $this->raw($notice->asAtomEntry());
643 $this->end_document('atom');
647 function show_json_timeline($notice)
650 $this->init_document('json');
654 if (is_array($notice)) {
655 foreach ($notice as $n) {
656 $twitter_status = $this->twitter_status_array($n);
657 array_push($statuses, $twitter_status);
660 while ($notice->fetch()) {
661 $twitter_status = $this->twitter_status_array($notice);
662 array_push($statuses, $twitter_status);
666 $this->show_json_objects($statuses);
668 $this->end_document('json');
671 function show_single_json_group($group)
673 $this->init_document('json');
674 $twitter_group = $this->twitter_group_array($group);
675 $this->show_json_objects($twitter_group);
676 $this->end_document('json');
679 function show_single_xml_group($group)
681 $this->init_document('xml');
682 $twitter_group = $this->twitter_group_array($group);
683 $this->show_twitter_xml_group($twitter_group);
684 $this->end_document('xml');
687 // Anyone know what date format this is?
688 // Twitter's dates look like this: "Mon Jul 14 23:52:38 +0000 2008" -- Zach
689 function date_twitter($dt)
692 return date("D M d H:i:s O Y", $t);
695 // XXX: Candidate for a general utility method somewhere?
696 function count_subscriptions($profile)
700 $sub = new Subscription();
701 $sub->subscribed = $profile->id;
703 $count = $sub->find();
712 function init_document($type='xml')
716 header('Content-Type: application/xml; charset=utf-8');
720 header('Content-Type: application/json; charset=utf-8');
722 // Check for JSONP callback
723 $callback = $this->arg('callback');
725 print $callback . '(';
729 header("Content-Type: application/rss+xml; charset=utf-8");
730 $this->init_twitter_rss();
733 header('Content-Type: application/atom+xml; charset=utf-8');
734 $this->init_twitter_atom();
737 $this->clientError(_('Not a supported data format.'));
744 function end_document($type='xml')
752 // Check for JSONP callback
753 $callback = $this->arg('callback');
759 $this->end_twitter_rss();
762 $this->end_twitter_rss();
765 $this->clientError(_('Not a supported data format.'));
771 function clientError($msg, $code = 400, $content_type = 'json')
774 static $status = array(400 => 'Bad Request',
775 401 => 'Unauthorized',
776 402 => 'Payment Required',
779 405 => 'Method Not Allowed',
780 406 => 'Not Acceptable',
781 407 => 'Proxy Authentication Required',
782 408 => 'Request Timeout',
785 411 => 'Length Required',
786 412 => 'Precondition Failed',
787 413 => 'Request Entity Too Large',
788 414 => 'Request-URI Too Long',
789 415 => 'Unsupported Media Type',
790 416 => 'Requested Range Not Satisfiable',
791 417 => 'Expectation Failed');
793 $action = $this->trimmed('action');
795 common_debug("User error '$code' on '$action': $msg", __FILE__);
797 if (!array_key_exists($code, $status)) {
801 $status_string = $status[$code];
802 header('HTTP/1.1 '.$code.' '.$status_string);
804 if ($content_type == 'xml') {
805 $this->init_document('xml');
806 $this->elementStart('hash');
807 $this->element('error', null, $msg);
808 $this->element('request', null, $_SERVER['REQUEST_URI']);
809 $this->elementEnd('hash');
810 $this->end_document('xml');
812 $this->init_document('json');
813 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
814 print(json_encode($error_array));
815 $this->end_document('json');
820 function init_twitter_rss()
823 $this->elementStart('rss', array('version' => '2.0'));
826 function end_twitter_rss()
828 $this->elementEnd('rss');
832 function init_twitter_atom()
835 // FIXME: don't hardcode the language here!
836 $this->elementStart('feed', array('xmlns' => 'http://www.w3.org/2005/Atom',
837 'xml:lang' => 'en-US',
838 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0'));
841 function end_twitter_atom()
843 $this->elementEnd('feed');
847 function show_profile($profile, $content_type='xml', $notice=null)
849 $profile_array = $this->twitter_user_array($profile, true);
850 switch ($content_type) {
852 $this->show_twitter_xml_user($profile_array);
855 $this->show_json_objects($profile_array);
858 $this->clientError(_('Not a supported data format.'));
864 function get_user($id, $apidata=null)
868 // Twitter supports these other ways of passing the user ID
869 if (is_numeric($this->arg('id'))) {
870 return User::staticGet($this->arg('id'));
871 } else if ($this->arg('id')) {
872 $nickname = common_canonical_nickname($this->arg('id'));
873 return User::staticGet('nickname', $nickname);
874 } else if ($this->arg('user_id')) {
875 // This is to ensure that a non-numeric user_id still
876 // overrides screen_name even if it doesn't get used
877 if (is_numeric($this->arg('user_id'))) {
878 return User::staticGet('id', $this->arg('user_id'));
880 } else if ($this->arg('screen_name')) {
881 $nickname = common_canonical_nickname($this->arg('screen_name'));
882 return User::staticGet('nickname', $nickname);
884 // Fall back to trying the currently authenticated user
885 return $apidata['user'];
888 } else if (is_numeric($id)) {
889 return User::staticGet($id);
891 $nickname = common_canonical_nickname($id);
892 return User::staticGet('nickname', $nickname);
896 function get_group($id, $apidata=null)
900 if (is_numeric($this->arg('id'))) {
901 return User_group::staticGet($this->arg('id'));
902 } else if ($this->arg('id')) {
903 $nickname = common_canonical_nickname($this->arg('id'));
904 return User_group::staticGet('nickname', $nickname);
905 } else if ($this->arg('group_id')) {
906 // This is to ensure that a non-numeric user_id still
907 // overrides screen_name even if it doesn't get used
908 if (is_numeric($this->arg('group_id'))) {
909 return User_group::staticGet('id', $this->arg('group_id'));
911 } else if ($this->arg('group_name')) {
912 $nickname = common_canonical_nickname($this->arg('group_name'));
913 return User_group::staticGet('nickname', $nickname);
916 } else if (is_numeric($id)) {
917 return User_group::staticGet($id);
919 $nickname = common_canonical_nickname($id);
920 return User_group::staticGet('nickname', $nickname);
924 function get_profile($id)
926 if (is_numeric($id)) {
927 return Profile::staticGet($id);
929 $user = User::staticGet('nickname', $id);
931 return $user->getProfile();
938 function source_link($source)
940 $source_name = _($source);
949 $ns = Notice_source::staticGet($source);
951 $source_name = '<a href="' . $ns->url . '">' . $ns->name . '</a>';
959 * Returns query argument or default value if not found. Certain
960 * parameters used throughout the API are lightly scrubbed and
961 * bounds checked. This overrides Action::arg().
963 * @param string $key requested argument
964 * @param string $def default value to return if $key is not provided
968 function arg($key, $def=null)
971 // XXX: Do even more input validation/scrubbing?
973 if (array_key_exists($key, $this->args)) {
976 $page = (int)$this->args['page'];
977 return ($page < 1) ? 1 : $page;
979 $count = (int)$this->args['count'];
982 } elseif ($count > 200) {
988 $since_id = (int)$this->args['since_id'];
989 return ($since_id < 1) ? 0 : $since_id;
991 $max_id = (int)$this->args['max_id'];
992 return ($max_id < 1) ? 0 : $max_id;
994 return strtotime($this->args['since']);
996 return parent::arg($key, $def);