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();
192 if (!empty($attachments)) {
194 $twitter_status['attachments'] = array();
196 foreach ($attachments as $attachment) {
197 if ($attachment->isEnclosure()) {
198 $enclosure = array();
199 $enclosure['url'] = $attachment->url;
200 $enclosure['mimetype'] = $attachment->mimetype;
201 $enclosure['size'] = $attachment->size;
202 $twitter_status['attachments'][] = $enclosure;
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_rss_entry_array($notice)
218 $profile = $notice->getProfile();
221 # We trim() to avoid extraneous whitespace in the output
223 $entry['content'] = common_xml_safe_str(trim($notice->rendered));
224 $entry['title'] = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
225 $entry['link'] = common_local_url('shownotice', array('notice' => $notice->id));
226 $entry['published'] = common_date_iso8601($notice->created);
228 $taguribase = common_config('integration', 'taguri');
229 $entry['id'] = "tag:$taguribase:$entry[link]";
231 $entry['updated'] = $entry['published'];
232 $entry['author'] = $profile->getBestName();
235 $attachments = $notice->attachments();
237 $entry['enclosures']=array();
238 foreach($attachments as $attachment){
239 if ($attachment->isEnclosure()) {
241 $enclosure['url']=$attachment->url;
242 $enclosure['mimetype']=$attachment->mimetype;
243 $enclosure['size']=$attachment->size;
244 $entry['enclosures'][]=$enclosure;
250 $entry['description'] = $entry['content'];
251 $entry['pubDate'] = common_date_rfc2822($notice->created);
252 $entry['guid'] = $entry['link'];
257 function twitter_rss_dmsg_array($message)
262 $entry['title'] = sprintf('Message from %s to %s',
263 $message->getFrom()->nickname, $message->getTo()->nickname);
265 $entry['content'] = common_xml_safe_str(trim($message->content));
266 $entry['link'] = common_local_url('showmessage', array('message' => $message->id));
267 $entry['published'] = common_date_iso8601($message->created);
269 $taguribase = common_config('integration', 'taguri');
271 $entry['id'] = "tag:$taguribase,:$entry[link]";
272 $entry['updated'] = $entry['published'];
273 $entry['author'] = $message->getFrom()->getBestName();
276 $entry['description'] = $entry['content'];
277 $entry['pubDate'] = common_date_rfc2822($message->created);
278 $entry['guid'] = $entry['link'];
283 function twitter_dmsg_array($message)
285 $twitter_dm = array();
287 $from_profile = $message->getFrom();
288 $to_profile = $message->getTo();
290 $twitter_dm['id'] = $message->id;
291 $twitter_dm['sender_id'] = $message->from_profile;
292 $twitter_dm['text'] = trim($message->content);
293 $twitter_dm['recipient_id'] = $message->to_profile;
294 $twitter_dm['created_at'] = $this->date_twitter($message->created);
295 $twitter_dm['sender_screen_name'] = $from_profile->nickname;
296 $twitter_dm['recipient_screen_name'] = $to_profile->nickname;
297 $twitter_dm['sender'] = $this->twitter_user_array($from_profile, false);
298 $twitter_dm['recipient'] = $this->twitter_user_array($to_profile, false);
303 function twitter_relationship_array($source, $target)
305 $relationship = array();
307 $relationship['source'] =
308 $this->relationship_details_array($source, $target);
309 $relationship['target'] =
310 $this->relationship_details_array($target, $source);
312 return array('relationship' => $relationship);
315 function relationship_details_array($source, $target)
319 $details['screen_name'] = $source->nickname;
320 $details['followed_by'] = $target->isSubscribed($source);
321 $details['following'] = $source->isSubscribed($target);
323 $notifications = false;
325 if ($source->isSubscribed($target)) {
327 $sub = Subscription::pkeyGet(array('subscriber' =>
328 $source->id, 'subscribed' => $target->id));
331 $notifications = ($sub->jabber || $sub->sms);
335 $details['notifications_enabled'] = $notifications;
336 $details['blocking'] = $source->hasBlocked($target);
337 $details['id'] = $source->id;
342 function show_twitter_xml_relationship($relationship)
344 $this->elementStart('relationship');
346 foreach($relationship as $element => $value) {
347 if ($element == 'source' || $element == 'target') {
348 $this->elementStart($element);
349 $this->show_xml_relationship_details($value);
350 $this->elementEnd($element);
354 $this->elementEnd('relationship');
357 function show_xml_relationship_details($details)
359 foreach($details as $element => $value) {
360 $this->element($element, null, $value);
364 function show_twitter_xml_status($twitter_status)
366 $this->elementStart('status');
367 foreach($twitter_status as $element => $value) {
370 $this->show_twitter_xml_user($twitter_status['user']);
373 $this->element($element, null, common_xml_safe_str($value));
376 $this->show_xml_attachments($twitter_status['attachments']);
379 $this->element($element, null, $value);
382 $this->elementEnd('status');
385 function show_twitter_xml_user($twitter_user, $role='user')
387 $this->elementStart($role);
388 foreach($twitter_user as $element => $value) {
389 if ($element == 'status') {
390 $this->show_twitter_xml_status($twitter_user['status']);
392 $this->element($element, null, $value);
395 $this->elementEnd($role);
398 function show_xml_attachments($attachments) {
399 if (!empty($attachments)) {
400 $this->elementStart('attachments', array('type' => 'array'));
401 foreach ($attachments as $attachment) {
403 $attrs['url'] = $attachment['url'];
404 $attrs['mimetype'] = $attachment['mimetype'];
405 $attrs['size'] = $attachment['size'];
406 $this->element('enclosure', $attrs, '');
408 $this->elementEnd('attachments');
412 function show_twitter_rss_item($entry)
414 $this->elementStart('item');
415 $this->element('title', null, $entry['title']);
416 $this->element('description', null, $entry['description']);
417 $this->element('pubDate', null, $entry['pubDate']);
418 $this->element('guid', null, $entry['guid']);
419 $this->element('link', null, $entry['link']);
421 # RSS only supports 1 enclosure per item
422 if($entry['enclosures']){
423 $enclosure = $entry['enclosures'][0];
424 $this->element('enclosure', array('url'=>$enclosure['url'],'type'=>$enclosure['mimetype'],'length'=>$enclosure['size']), null);
427 $this->elementEnd('item');
430 function show_json_objects($objects)
432 print(json_encode($objects));
435 function show_single_xml_status($notice)
437 $this->init_document('xml');
438 $twitter_status = $this->twitter_status_array($notice);
439 $this->show_twitter_xml_status($twitter_status);
440 $this->end_document('xml');
443 function show_single_json_status($notice)
445 $this->init_document('json');
446 $status = $this->twitter_status_array($notice);
447 $this->show_json_objects($status);
448 $this->end_document('json');
451 function show_single_xml_dmsg($message)
453 $this->init_document('xml');
454 $dmsg = $this->twitter_dmsg_array($message);
455 $this->show_twitter_xml_dmsg($dmsg);
456 $this->end_document('xml');
459 function show_single_json_dmsg($message)
461 $this->init_document('json');
462 $dmsg = $this->twitter_dmsg_array($message);
463 $this->show_json_objects($dmsg);
464 $this->end_document('json');
467 function show_twitter_xml_dmsg($twitter_dm)
469 $this->elementStart('direct_message');
470 foreach($twitter_dm as $element => $value) {
474 $this->show_twitter_xml_user($value, $element);
477 $this->element($element, null, common_xml_safe_str($value));
480 $this->element($element, null, $value);
483 $this->elementEnd('direct_message');
486 function show_xml_timeline($notice)
489 $this->init_document('xml');
490 $this->elementStart('statuses', array('type' => 'array'));
492 if (is_array($notice)) {
493 foreach ($notice as $n) {
494 $twitter_status = $this->twitter_status_array($n);
495 $this->show_twitter_xml_status($twitter_status);
498 while ($notice->fetch()) {
499 $twitter_status = $this->twitter_status_array($notice);
500 $this->show_twitter_xml_status($twitter_status);
504 $this->elementEnd('statuses');
505 $this->end_document('xml');
508 function show_rss_timeline($notice, $title, $link, $subtitle, $suplink=null)
511 $this->init_document('rss');
513 $this->elementStart('channel');
514 $this->element('title', null, $title);
515 $this->element('link', null, $link);
516 if (!is_null($suplink)) {
517 # For FriendFeed's SUP protocol
518 $this->element('link', array('xmlns' => 'http://www.w3.org/2005/Atom',
519 'rel' => 'http://api.friendfeed.com/2008/03#sup',
521 'type' => 'application/json'));
523 $this->element('description', null, $subtitle);
524 $this->element('language', null, 'en-us');
525 $this->element('ttl', null, '40');
527 if (is_array($notice)) {
528 foreach ($notice as $n) {
529 $entry = $this->twitter_rss_entry_array($n);
530 $this->show_twitter_rss_item($entry);
533 while ($notice->fetch()) {
534 $entry = $this->twitter_rss_entry_array($notice);
535 $this->show_twitter_rss_item($entry);
539 $this->elementEnd('channel');
540 $this->end_twitter_rss();
543 function show_atom_timeline($notice, $title, $id, $link, $subtitle=null, $suplink=null, $selfuri=null)
546 $this->init_document('atom');
548 $this->element('title', null, $title);
549 $this->element('id', null, $id);
550 $this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null);
552 if (!is_null($suplink)) {
553 # For FriendFeed's SUP protocol
554 $this->element('link', array('rel' => 'http://api.friendfeed.com/2008/03#sup',
556 'type' => 'application/json'));
559 if (!is_null($selfuri)) {
560 $this->element('link', array('href' => $selfuri,
561 'rel' => 'self', 'type' => 'application/atom+xml'), null);
564 $this->element('updated', null, common_date_iso8601('now'));
565 $this->element('subtitle', null, $subtitle);
567 if (is_array($notice)) {
568 foreach ($notice as $n) {
569 $this->raw($n->asAtomEntry());
572 while ($notice->fetch()) {
573 $this->raw($notice->asAtomEntry());
577 $this->end_document('atom');
581 function show_json_timeline($notice)
584 $this->init_document('json');
588 if (is_array($notice)) {
589 foreach ($notice as $n) {
590 $twitter_status = $this->twitter_status_array($n);
591 array_push($statuses, $twitter_status);
594 while ($notice->fetch()) {
595 $twitter_status = $this->twitter_status_array($notice);
596 array_push($statuses, $twitter_status);
600 $this->show_json_objects($statuses);
602 $this->end_document('json');
605 // Anyone know what date format this is?
606 // Twitter's dates look like this: "Mon Jul 14 23:52:38 +0000 2008" -- Zach
607 function date_twitter($dt)
610 return date("D M d H:i:s O Y", $t);
613 // XXX: Candidate for a general utility method somewhere?
614 function count_subscriptions($profile)
618 $sub = new Subscription();
619 $sub->subscribed = $profile->id;
621 $count = $sub->find();
630 function init_document($type='xml')
634 header('Content-Type: application/xml; charset=utf-8');
638 header('Content-Type: application/json; charset=utf-8');
640 // Check for JSONP callback
641 $callback = $this->arg('callback');
643 print $callback . '(';
647 header("Content-Type: application/rss+xml; charset=utf-8");
648 $this->init_twitter_rss();
651 header('Content-Type: application/atom+xml; charset=utf-8');
652 $this->init_twitter_atom();
655 $this->clientError(_('Not a supported data format.'));
662 function end_document($type='xml')
670 // Check for JSONP callback
671 $callback = $this->arg('callback');
677 $this->end_twitter_rss();
680 $this->end_twitter_rss();
683 $this->clientError(_('Not a supported data format.'));
689 function clientError($msg, $code = 400, $content_type = 'json')
692 static $status = array(400 => 'Bad Request',
693 401 => 'Unauthorized',
694 402 => 'Payment Required',
697 405 => 'Method Not Allowed',
698 406 => 'Not Acceptable',
699 407 => 'Proxy Authentication Required',
700 408 => 'Request Timeout',
703 411 => 'Length Required',
704 412 => 'Precondition Failed',
705 413 => 'Request Entity Too Large',
706 414 => 'Request-URI Too Long',
707 415 => 'Unsupported Media Type',
708 416 => 'Requested Range Not Satisfiable',
709 417 => 'Expectation Failed');
711 $action = $this->trimmed('action');
713 common_debug("User error '$code' on '$action': $msg", __FILE__);
715 if (!array_key_exists($code, $status)) {
719 $status_string = $status[$code];
720 header('HTTP/1.1 '.$code.' '.$status_string);
722 if ($content_type == 'xml') {
723 $this->init_document('xml');
724 $this->elementStart('hash');
725 $this->element('error', null, $msg);
726 $this->element('request', null, $_SERVER['REQUEST_URI']);
727 $this->elementEnd('hash');
728 $this->end_document('xml');
730 $this->init_document('json');
731 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
732 print(json_encode($error_array));
733 $this->end_document('json');
738 function init_twitter_rss()
741 $this->elementStart('rss', array('version' => '2.0'));
744 function end_twitter_rss()
746 $this->elementEnd('rss');
750 function init_twitter_atom()
753 // FIXME: don't hardcode the language here!
754 $this->elementStart('feed', array('xmlns' => 'http://www.w3.org/2005/Atom',
755 'xml:lang' => 'en-US',
756 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0'));
759 function end_twitter_atom()
761 $this->elementEnd('feed');
765 function show_profile($profile, $content_type='xml', $notice=null)
767 $profile_array = $this->twitter_user_array($profile, true);
768 switch ($content_type) {
770 $this->show_twitter_xml_user($profile_array);
773 $this->show_json_objects($profile_array);
776 $this->clientError(_('Not a supported data format.'));
782 function get_user($id, $apidata=null)
786 // Twitter supports these other ways of passing the user ID
787 if (is_numeric($this->arg('id'))) {
788 return User::staticGet($this->arg('id'));
789 } else if ($this->arg('id')) {
790 $nickname = common_canonical_nickname($this->arg('id'));
791 return User::staticGet('nickname', $nickname);
792 } else if ($this->arg('user_id')) {
793 // This is to ensure that a non-numeric user_id still
794 // overrides screen_name even if it doesn't get used
795 if (is_numeric($this->arg('user_id'))) {
796 return User::staticGet('id', $this->arg('user_id'));
798 } else if ($this->arg('screen_name')) {
799 $nickname = common_canonical_nickname($this->arg('screen_name'));
800 return User::staticGet('nickname', $nickname);
802 // Fall back to trying the currently authenticated user
803 return $apidata['user'];
806 } else if (is_numeric($id)) {
807 return User::staticGet($id);
809 $nickname = common_canonical_nickname($id);
810 return User::staticGet('nickname', $nickname);
814 function get_group($id, $apidata=null)
818 if (is_numeric($this->arg('id'))) {
819 return User_group::staticGet($this->arg('id'));
820 } else if ($this->arg('id')) {
821 $nickname = common_canonical_nickname($this->arg('id'));
822 return User_group::staticGet('nickname', $nickname);
823 } else if ($this->arg('group_id')) {
824 // This is to ensure that a non-numeric user_id still
825 // overrides screen_name even if it doesn't get used
826 if (is_numeric($this->arg('group_id'))) {
827 return User_group::staticGet('id', $this->arg('group_id'));
829 } else if ($this->arg('group_name')) {
830 $nickname = common_canonical_nickname($this->arg('group_name'));
831 return User_group::staticGet('nickname', $nickname);
834 } else if (is_numeric($id)) {
835 return User_group::staticGet($id);
837 $nickname = common_canonical_nickname($id);
838 return User_group::staticGet('nickname', $nickname);
842 function get_profile($id)
844 if (is_numeric($id)) {
845 return Profile::staticGet($id);
847 $user = User::staticGet('nickname', $id);
849 return $user->getProfile();
856 function source_link($source)
858 $source_name = _($source);
867 $ns = Notice_source::staticGet($source);
869 $source_name = '<a href="' . $ns->url . '">' . $ns->name . '</a>';
877 * Returns query argument or default value if not found. Certain
878 * parameters used throughout the API are lightly scrubbed and
879 * bounds checked. This overrides Action::arg().
881 * @param string $key requested argument
882 * @param string $def default value to return if $key is not provided
886 function arg($key, $def=null)
889 // XXX: Do even more input validation/scrubbing?
891 if (array_key_exists($key, $this->args)) {
894 $page = (int)$this->args['page'];
895 return ($page < 1) ? 1 : $page;
897 $count = (int)$this->args['count'];
900 } elseif ($count > 200) {
906 $since_id = (int)$this->args['since_id'];
907 return ($since_id < 1) ? 0 : $since_id;
909 $max_id = (int)$this->args['max_id'];
910 return ($max_id < 1) ? 0 : $max_id;
912 return strtotime($this->args['since']);
914 return parent::arg($key, $def);