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 $twitter_status['attachments']=array();
193 foreach($attachments as $attachment){
194 if ($attachment->isEnclosure()) {
196 $enclosure['url']=$attachment->url;
197 $enclosure['mimetype']=$attachment->mimetype;
198 $enclosure['size']=$attachment->size;
199 $twitter_status['attachments'][]=$enclosure;
205 # Don't get notice (recursive!)
206 $twitter_user = $this->twitter_user_array($profile, false);
207 $twitter_status['user'] = $twitter_user;
210 return $twitter_status;
213 function twitter_rss_entry_array($notice)
215 $profile = $notice->getProfile();
218 # We trim() to avoid extraneous whitespace in the output
220 $entry['content'] = common_xml_safe_str(trim($notice->rendered));
221 $entry['title'] = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
222 $entry['link'] = common_local_url('shownotice', array('notice' => $notice->id));
223 $entry['published'] = common_date_iso8601($notice->created);
225 $taguribase = common_config('integration', 'taguri');
226 $entry['id'] = "tag:$taguribase:$entry[link]";
228 $entry['updated'] = $entry['published'];
229 $entry['author'] = $profile->getBestName();
232 $attachments = $notice->attachments();
234 $entry['enclosures']=array();
235 foreach($attachments as $attachment){
236 if ($attachment->isEnclosure()) {
238 $enclosure['url']=$attachment->url;
239 $enclosure['mimetype']=$attachment->mimetype;
240 $enclosure['size']=$attachment->size;
241 $entry['enclosures'][]=$enclosure;
247 $entry['description'] = $entry['content'];
248 $entry['pubDate'] = common_date_rfc2822($notice->created);
249 $entry['guid'] = $entry['link'];
254 function twitter_rss_dmsg_array($message)
259 $entry['title'] = sprintf('Message from %s to %s',
260 $message->getFrom()->nickname, $message->getTo()->nickname);
262 $entry['content'] = common_xml_safe_str(trim($message->content));
263 $entry['link'] = common_local_url('showmessage', array('message' => $message->id));
264 $entry['published'] = common_date_iso8601($message->created);
266 $taguribase = common_config('integration', 'taguri');
268 $entry['id'] = "tag:$taguribase,:$entry[link]";
269 $entry['updated'] = $entry['published'];
270 $entry['author'] = $message->getFrom()->getBestName();
273 $entry['description'] = $entry['content'];
274 $entry['pubDate'] = common_date_rfc2822($message->created);
275 $entry['guid'] = $entry['link'];
280 function twitter_dmsg_array($message)
282 $twitter_dm = array();
284 $from_profile = $message->getFrom();
285 $to_profile = $message->getTo();
287 $twitter_dm['id'] = $message->id;
288 $twitter_dm['sender_id'] = $message->from_profile;
289 $twitter_dm['text'] = trim($message->content);
290 $twitter_dm['recipient_id'] = $message->to_profile;
291 $twitter_dm['created_at'] = $this->date_twitter($message->created);
292 $twitter_dm['sender_screen_name'] = $from_profile->nickname;
293 $twitter_dm['recipient_screen_name'] = $to_profile->nickname;
294 $twitter_dm['sender'] = $this->twitter_user_array($from_profile, false);
295 $twitter_dm['recipient'] = $this->twitter_user_array($to_profile, false);
300 function twitter_relationship_array($source, $target)
302 $relationship = array();
304 $relationship['source'] =
305 $this->relationship_details_array($source, $target);
306 $relationship['target'] =
307 $this->relationship_details_array($target, $source);
309 return array('relationship' => $relationship);
312 function relationship_details_array($source, $target)
316 $details['screen_name'] = $source->nickname;
317 $details['followed_by'] = $target->isSubscribed($source);
318 $details['following'] = $source->isSubscribed($target);
320 $notifications = false;
322 if ($source->isSubscribed($target)) {
324 $sub = Subscription::pkeyGet(array('subscriber' =>
325 $source->id, 'subscribed' => $target->id));
328 $notifications = ($sub->jabber || $sub->sms);
332 $details['notifications_enabled'] = $notifications;
333 $details['blocking'] = $source->hasBlocked($target);
334 $details['id'] = $source->id;
339 function show_twitter_xml_relationship($relationship)
341 $this->elementStart('relationship');
343 foreach($relationship as $element => $value) {
344 if ($element == 'source' || $element == 'target') {
345 $this->elementStart($element);
346 $this->show_xml_relationship_details($value);
347 $this->elementEnd($element);
351 $this->elementEnd('relationship');
354 function show_xml_relationship_details($details)
356 foreach($details as $element => $value) {
357 $this->element($element, null, $value);
361 function show_twitter_xml_status($twitter_status)
363 $this->elementStart('status');
364 foreach($twitter_status as $element => $value) {
367 $this->show_twitter_xml_user($twitter_status['user']);
370 $this->element($element, null, common_xml_safe_str($value));
373 $this->show_xml_attachments($twitter_status['attachments']);
376 $this->element($element, null, $value);
379 $this->elementEnd('status');
382 function show_twitter_xml_user($twitter_user, $role='user')
384 $this->elementStart($role);
385 foreach($twitter_user as $element => $value) {
386 if ($element == 'status') {
387 $this->show_twitter_xml_status($twitter_user['status']);
389 $this->element($element, null, $value);
392 $this->elementEnd($role);
395 function show_xml_attachments($attachments) {
396 if (!empty($attachments)) {
397 $this->elementStart('attachments', array('type' => 'array'));
398 foreach ($attachments as $attachment) {
400 $attrs['url'] = $attachment['url'];
401 $attrs['mimetype'] = $attachment['mimetype'];
402 $attrs['size'] = $attachment['size'];
403 $this->element('enclosure', $attrs, '');
405 $this->elementEnd('attachments');
409 function show_twitter_rss_item($entry)
411 $this->elementStart('item');
412 $this->element('title', null, $entry['title']);
413 $this->element('description', null, $entry['description']);
414 $this->element('pubDate', null, $entry['pubDate']);
415 $this->element('guid', null, $entry['guid']);
416 $this->element('link', null, $entry['link']);
418 # RSS only supports 1 enclosure per item
419 if($entry['enclosures']){
420 $enclosure = $entry['enclosures'][0];
421 $this->element('enclosure', array('url'=>$enclosure['url'],'type'=>$enclosure['mimetype'],'length'=>$enclosure['size']), null);
424 $this->elementEnd('item');
427 function show_json_objects($objects)
429 print(json_encode($objects));
432 function show_single_xml_status($notice)
434 $this->init_document('xml');
435 $twitter_status = $this->twitter_status_array($notice);
436 $this->show_twitter_xml_status($twitter_status);
437 $this->end_document('xml');
440 function show_single_json_status($notice)
442 $this->init_document('json');
443 $status = $this->twitter_status_array($notice);
444 $this->show_json_objects($status);
445 $this->end_document('json');
448 function show_single_xml_dmsg($message)
450 $this->init_document('xml');
451 $dmsg = $this->twitter_dmsg_array($message);
452 $this->show_twitter_xml_dmsg($dmsg);
453 $this->end_document('xml');
456 function show_single_json_dmsg($message)
458 $this->init_document('json');
459 $dmsg = $this->twitter_dmsg_array($message);
460 $this->show_json_objects($dmsg);
461 $this->end_document('json');
464 function show_twitter_xml_dmsg($twitter_dm)
466 $this->elementStart('direct_message');
467 foreach($twitter_dm as $element => $value) {
471 $this->show_twitter_xml_user($value, $element);
474 $this->element($element, null, common_xml_safe_str($value));
477 $this->element($element, null, $value);
480 $this->elementEnd('direct_message');
483 function show_xml_timeline($notice)
486 $this->init_document('xml');
487 $this->elementStart('statuses', array('type' => 'array'));
489 if (is_array($notice)) {
490 foreach ($notice as $n) {
491 $twitter_status = $this->twitter_status_array($n);
492 $this->show_twitter_xml_status($twitter_status);
495 while ($notice->fetch()) {
496 $twitter_status = $this->twitter_status_array($notice);
497 $this->show_twitter_xml_status($twitter_status);
501 $this->elementEnd('statuses');
502 $this->end_document('xml');
505 function show_rss_timeline($notice, $title, $link, $subtitle, $suplink=null)
508 $this->init_document('rss');
510 $this->elementStart('channel');
511 $this->element('title', null, $title);
512 $this->element('link', null, $link);
513 if (!is_null($suplink)) {
514 # For FriendFeed's SUP protocol
515 $this->element('link', array('xmlns' => 'http://www.w3.org/2005/Atom',
516 'rel' => 'http://api.friendfeed.com/2008/03#sup',
518 'type' => 'application/json'));
520 $this->element('description', null, $subtitle);
521 $this->element('language', null, 'en-us');
522 $this->element('ttl', null, '40');
524 if (is_array($notice)) {
525 foreach ($notice as $n) {
526 $entry = $this->twitter_rss_entry_array($n);
527 $this->show_twitter_rss_item($entry);
530 while ($notice->fetch()) {
531 $entry = $this->twitter_rss_entry_array($notice);
532 $this->show_twitter_rss_item($entry);
536 $this->elementEnd('channel');
537 $this->end_twitter_rss();
540 function show_atom_timeline($notice, $title, $id, $link, $subtitle=null, $suplink=null, $selfuri=null)
543 $this->init_document('atom');
545 $this->element('title', null, $title);
546 $this->element('id', null, $id);
547 $this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null);
549 if (!is_null($suplink)) {
550 # For FriendFeed's SUP protocol
551 $this->element('link', array('rel' => 'http://api.friendfeed.com/2008/03#sup',
553 'type' => 'application/json'));
556 if (!is_null($selfuri)) {
557 $this->element('link', array('href' => $selfuri,
558 'rel' => 'self', 'type' => 'application/atom+xml'), null);
561 $this->element('updated', null, common_date_iso8601('now'));
562 $this->element('subtitle', null, $subtitle);
564 if (is_array($notice)) {
565 foreach ($notice as $n) {
566 $this->raw($n->asAtomEntry());
569 while ($notice->fetch()) {
570 $this->raw($notice->asAtomEntry());
574 $this->end_document('atom');
578 function show_json_timeline($notice)
581 $this->init_document('json');
585 if (is_array($notice)) {
586 foreach ($notice as $n) {
587 $twitter_status = $this->twitter_status_array($n);
588 array_push($statuses, $twitter_status);
591 while ($notice->fetch()) {
592 $twitter_status = $this->twitter_status_array($notice);
593 array_push($statuses, $twitter_status);
597 $this->show_json_objects($statuses);
599 $this->end_document('json');
602 // Anyone know what date format this is?
603 // Twitter's dates look like this: "Mon Jul 14 23:52:38 +0000 2008" -- Zach
604 function date_twitter($dt)
607 return date("D M d H:i:s O Y", $t);
610 // XXX: Candidate for a general utility method somewhere?
611 function count_subscriptions($profile)
615 $sub = new Subscription();
616 $sub->subscribed = $profile->id;
618 $count = $sub->find();
627 function init_document($type='xml')
631 header('Content-Type: application/xml; charset=utf-8');
635 header('Content-Type: application/json; charset=utf-8');
637 // Check for JSONP callback
638 $callback = $this->arg('callback');
640 print $callback . '(';
644 header("Content-Type: application/rss+xml; charset=utf-8");
645 $this->init_twitter_rss();
648 header('Content-Type: application/atom+xml; charset=utf-8');
649 $this->init_twitter_atom();
652 $this->clientError(_('Not a supported data format.'));
659 function end_document($type='xml')
667 // Check for JSONP callback
668 $callback = $this->arg('callback');
674 $this->end_twitter_rss();
677 $this->end_twitter_rss();
680 $this->clientError(_('Not a supported data format.'));
686 function clientError($msg, $code = 400, $content_type = 'json')
689 static $status = array(400 => 'Bad Request',
690 401 => 'Unauthorized',
691 402 => 'Payment Required',
694 405 => 'Method Not Allowed',
695 406 => 'Not Acceptable',
696 407 => 'Proxy Authentication Required',
697 408 => 'Request Timeout',
700 411 => 'Length Required',
701 412 => 'Precondition Failed',
702 413 => 'Request Entity Too Large',
703 414 => 'Request-URI Too Long',
704 415 => 'Unsupported Media Type',
705 416 => 'Requested Range Not Satisfiable',
706 417 => 'Expectation Failed');
708 $action = $this->trimmed('action');
710 common_debug("User error '$code' on '$action': $msg", __FILE__);
712 if (!array_key_exists($code, $status)) {
716 $status_string = $status[$code];
717 header('HTTP/1.1 '.$code.' '.$status_string);
719 if ($content_type == 'xml') {
720 $this->init_document('xml');
721 $this->elementStart('hash');
722 $this->element('error', null, $msg);
723 $this->element('request', null, $_SERVER['REQUEST_URI']);
724 $this->elementEnd('hash');
725 $this->end_document('xml');
727 $this->init_document('json');
728 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
729 print(json_encode($error_array));
730 $this->end_document('json');
735 function init_twitter_rss()
738 $this->elementStart('rss', array('version' => '2.0'));
741 function end_twitter_rss()
743 $this->elementEnd('rss');
747 function init_twitter_atom()
750 // FIXME: don't hardcode the language here!
751 $this->elementStart('feed', array('xmlns' => 'http://www.w3.org/2005/Atom',
752 'xml:lang' => 'en-US',
753 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0'));
756 function end_twitter_atom()
758 $this->elementEnd('feed');
762 function show_profile($profile, $content_type='xml', $notice=null)
764 $profile_array = $this->twitter_user_array($profile, true);
765 switch ($content_type) {
767 $this->show_twitter_xml_user($profile_array);
770 $this->show_json_objects($profile_array);
773 $this->clientError(_('Not a supported data format.'));
779 function get_user($id, $apidata=null)
783 // Twitter supports these other ways of passing the user ID
784 if (is_numeric($this->arg('id'))) {
785 return User::staticGet($this->arg('id'));
786 } else if ($this->arg('id')) {
787 $nickname = common_canonical_nickname($this->arg('id'));
788 return User::staticGet('nickname', $nickname);
789 } else if ($this->arg('user_id')) {
790 // This is to ensure that a non-numeric user_id still
791 // overrides screen_name even if it doesn't get used
792 if (is_numeric($this->arg('user_id'))) {
793 return User::staticGet('id', $this->arg('user_id'));
795 } else if ($this->arg('screen_name')) {
796 $nickname = common_canonical_nickname($this->arg('screen_name'));
797 return User::staticGet('nickname', $nickname);
799 // Fall back to trying the currently authenticated user
800 return $apidata['user'];
803 } else if (is_numeric($id)) {
804 return User::staticGet($id);
806 $nickname = common_canonical_nickname($id);
807 return User::staticGet('nickname', $nickname);
811 function get_group($id, $apidata=null)
815 if (is_numeric($this->arg('id'))) {
816 return User_group::staticGet($this->arg('id'));
817 } else if ($this->arg('id')) {
818 $nickname = common_canonical_nickname($this->arg('id'));
819 return User_group::staticGet('nickname', $nickname);
820 } else if ($this->arg('group_id')) {
821 // This is to ensure that a non-numeric user_id still
822 // overrides screen_name even if it doesn't get used
823 if (is_numeric($this->arg('group_id'))) {
824 return User_group::staticGet('id', $this->arg('group_id'));
826 } else if ($this->arg('group_name')) {
827 $nickname = common_canonical_nickname($this->arg('group_name'));
828 return User_group::staticGet('nickname', $nickname);
831 } else if (is_numeric($id)) {
832 return User_group::staticGet($id);
834 $nickname = common_canonical_nickname($id);
835 return User_group::staticGet('nickname', $nickname);
839 function get_profile($id)
841 if (is_numeric($id)) {
842 return Profile::staticGet($id);
844 $user = User::staticGet('nickname', $id);
846 return $user->getProfile();
853 function source_link($source)
855 $source_name = _($source);
864 $ns = Notice_source::staticGet($source);
866 $source_name = '<a href="' . $ns->url . '">' . $ns->name . '</a>';
874 * Returns query argument or default value if not found. Certain
875 * parameters used throughout the API are lightly scrubbed and
876 * bounds checked. This overrides Action::arg().
878 * @param string $key requested argument
879 * @param string $def default value to return if $key is not provided
883 function arg($key, $def=null)
886 // XXX: Do even more input validation/scrubbing?
888 if (array_key_exists($key, $this->args)) {
891 $page = (int)$this->args['page'];
892 return ($page < 1) ? 1 : $page;
894 $count = (int)$this->args['count'];
897 } elseif ($count > 200) {
903 $since_id = (int)$this->args['since_id'];
904 return ($since_id < 1) ? 0 : $since_id;
906 $max_id = (int)$this->args['max_id'];
907 return ($max_id < 1) ? 0 : $max_id;
909 return strtotime($this->args['since']);
911 return parent::arg($key, $def);