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'] = $this->count_subscriptions($profile);
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 $subbed = DB_DataObject::factory('subscription');
102 $subbed->subscriber = $profile->id;
103 $subbed_count = (int) $subbed->count() - 1;
104 $twitter_user['friends_count'] = (is_int($subbed_count)) ? $subbed_count : 0;
106 $twitter_user['created_at'] = $this->date_twitter($profile->created);
108 $faves = DB_DataObject::factory('fave');
109 $faves->user_id = $user->id;
110 $faves_count = (int) $faves->count();
111 $twitter_user['favourites_count'] = $faves_count; // British spelling!
113 // Need to pull up the user for some of this
114 $user = User::staticGet($profile->id);
118 if ($user->timezone) {
119 $timezone = $user->timezone;
123 $t->setTimezone(new DateTimeZone($timezone));
125 $twitter_user['utc_offset'] = $t->format('Z');
126 $twitter_user['time_zone'] = $timezone;
128 // To be supported some day, perhaps
129 $twitter_user['profile_background_image_url'] = '';
130 $twitter_user['profile_background_tile'] = false;
132 $notices = DB_DataObject::factory('notice');
133 $notices->profile_id = $profile->id;
134 $notice_count = (int) $notices->count();
136 $twitter_user['statuses_count'] = (is_int($notice_count)) ? $notice_count : 0;
138 // Is the requesting user following this user?
139 $twitter_user['following'] = false;
140 $twitter_user['notifications'] = false;
142 if (isset($apidata['user'])) {
144 $twitter_user['following'] = $apidata['user']->isSubscribed($profile);
147 $sub = Subscription::pkeyGet(array('subscriber' =>
148 $apidata['user']->id, 'subscribed' => $profile->id));
151 $twitter_user['notifications'] = ($sub->jabber || $sub->sms);
156 $notice = $profile->getCurrentNotice();
159 $twitter_user['status'] = $this->twitter_status_array($notice, false);
163 return $twitter_user;
166 function twitter_status_array($notice, $include_user=true)
168 $profile = $notice->getProfile();
170 $twitter_status = array();
171 $twitter_status['text'] = $notice->content;
172 $twitter_status['truncated'] = false; # Not possible on Laconica
173 $twitter_status['created_at'] = $this->date_twitter($notice->created);
174 $twitter_status['in_reply_to_status_id'] = ($notice->reply_to) ?
175 intval($notice->reply_to) : null;
176 $twitter_status['source'] = $this->source_link($notice->source);
177 $twitter_status['id'] = intval($notice->id);
179 $replier_profile = null;
181 if ($notice->reply_to) {
182 $reply = Notice::staticGet(intval($notice->reply_to));
184 $replier_profile = $reply->getProfile();
188 $twitter_status['in_reply_to_user_id'] =
189 ($replier_profile) ? intval($replier_profile->id) : null;
190 $twitter_status['in_reply_to_screen_name'] =
191 ($replier_profile) ? $replier_profile->nickname : null;
193 if (isset($this->auth_user)) {
194 $twitter_status['favorited'] = $this->auth_user->hasFave($notice);
196 $twitter_status['favorited'] = false;
200 # Don't get notice (recursive!)
201 $twitter_user = $this->twitter_user_array($profile, false);
202 $twitter_status['user'] = $twitter_user;
205 return $twitter_status;
208 function twitter_rss_entry_array($notice)
210 $profile = $notice->getProfile();
213 # We trim() to avoid extraneous whitespace in the output
215 $entry['content'] = common_xml_safe_str(trim($notice->rendered));
216 $entry['title'] = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
217 $entry['link'] = common_local_url('shownotice', array('notice' => $notice->id));
218 $entry['published'] = common_date_iso8601($notice->created);
220 $taguribase = common_config('integration', 'taguri');
221 $entry['id'] = "tag:$taguribase:$entry[link]";
223 $entry['updated'] = $entry['published'];
224 $entry['author'] = $profile->getBestName();
227 $attachments = $notice->attachments();
229 $entry['enclosures']=array();
230 foreach($attachments as $attachment){
232 $enclosure['url']=$attachment->url;
233 $enclosure['mimetype']=$attachment->mimetype;
234 $enclosure['size']=$attachment->size;
235 $entry['enclosures'][]=$enclosure;
240 $entry['description'] = $entry['content'];
241 $entry['pubDate'] = common_date_rfc2822($notice->created);
242 $entry['guid'] = $entry['link'];
247 function twitter_rss_dmsg_array($message)
252 $entry['title'] = sprintf('Message from %s to %s',
253 $message->getFrom()->nickname, $message->getTo()->nickname);
255 $entry['content'] = common_xml_safe_str(trim($message->content));
256 $entry['link'] = common_local_url('showmessage', array('message' => $message->id));
257 $entry['published'] = common_date_iso8601($message->created);
259 $taguribase = common_config('integration', 'taguri');
261 $entry['id'] = "tag:$taguribase,:$entry[link]";
262 $entry['updated'] = $entry['published'];
263 $entry['author'] = $message->getFrom()->getBestName();
266 $entry['description'] = $entry['content'];
267 $entry['pubDate'] = common_date_rfc2822($message->created);
268 $entry['guid'] = $entry['link'];
273 function twitter_dmsg_array($message)
275 $twitter_dm = array();
277 $from_profile = $message->getFrom();
278 $to_profile = $message->getTo();
280 $twitter_dm['id'] = $message->id;
281 $twitter_dm['sender_id'] = $message->from_profile;
282 $twitter_dm['text'] = trim($message->content);
283 $twitter_dm['recipient_id'] = $message->to_profile;
284 $twitter_dm['created_at'] = $this->date_twitter($message->created);
285 $twitter_dm['sender_screen_name'] = $from_profile->nickname;
286 $twitter_dm['recipient_screen_name'] = $to_profile->nickname;
287 $twitter_dm['sender'] = $this->twitter_user_array($from_profile, false);
288 $twitter_dm['recipient'] = $this->twitter_user_array($to_profile, false);
293 function twitter_relationship_array($source, $target)
295 $relationship = array();
297 $relationship['source'] =
298 $this->relationship_details_array($source, $target);
299 $relationship['target'] =
300 $this->relationship_details_array($target, $source);
302 return array('relationship' => $relationship);
305 function relationship_details_array($source, $target)
309 $details['screen_name'] = $source->nickname;
310 $details['followed_by'] = $target->isSubscribed($source);
311 $details['following'] = $source->isSubscribed($target);
313 $notifications = false;
315 if ($source->isSubscribed($target)) {
317 $sub = Subscription::pkeyGet(array('subscriber' =>
318 $source->id, 'subscribed' => $target->id));
321 $notifications = ($sub->jabber || $sub->sms);
325 $details['notifications_enabled'] = $notifications;
326 $details['blocking'] = $source->hasBlocked($target);
327 $details['id'] = $source->id;
332 function show_twitter_xml_relationship($relationship)
334 $this->elementStart('relationship');
336 foreach($relationship as $element => $value) {
337 if ($element == 'source' || $element == 'target') {
338 $this->elementStart($element);
339 $this->show_xml_relationship_details($value);
340 $this->elementEnd($element);
344 $this->elementEnd('relationship');
347 function show_xml_relationship_details($details)
349 foreach($details as $element => $value) {
350 $this->element($element, null, $value);
354 function show_twitter_xml_status($twitter_status)
356 $this->elementStart('status');
357 foreach($twitter_status as $element => $value) {
360 $this->show_twitter_xml_user($twitter_status['user']);
363 $this->element($element, null, common_xml_safe_str($value));
366 $this->element($element, null, $value);
369 $this->elementEnd('status');
372 function show_twitter_xml_user($twitter_user, $role='user')
374 $this->elementStart($role);
375 foreach($twitter_user as $element => $value) {
376 if ($element == 'status') {
377 $this->show_twitter_xml_status($twitter_user['status']);
379 $this->element($element, null, $value);
382 $this->elementEnd($role);
385 function show_twitter_rss_item($entry)
387 $this->elementStart('item');
388 $this->element('title', null, $entry['title']);
389 $this->element('description', null, $entry['description']);
390 $this->element('pubDate', null, $entry['pubDate']);
391 $this->element('guid', null, $entry['guid']);
392 $this->element('link', null, $entry['link']);
394 # RSS only supports 1 enclosure per item
395 if($entry['enclosures']){
396 $enclosure = $entry['enclosures'][0];
397 $this->element('enclosure', array('url'=>$enclosure['url'],'type'=>$enclosure['mimetype'],'length'=>$enclosure['size']), null);
400 $this->elementEnd('item');
403 function show_json_objects($objects)
405 print(json_encode($objects));
408 function show_single_xml_status($notice)
410 $this->init_document('xml');
411 $twitter_status = $this->twitter_status_array($notice);
412 $this->show_twitter_xml_status($twitter_status);
413 $this->end_document('xml');
416 function show_single_json_status($notice)
418 $this->init_document('json');
419 $status = $this->twitter_status_array($notice);
420 $this->show_json_objects($status);
421 $this->end_document('json');
424 function show_single_xml_dmsg($message)
426 $this->init_document('xml');
427 $dmsg = $this->twitter_dmsg_array($message);
428 $this->show_twitter_xml_dmsg($dmsg);
429 $this->end_document('xml');
432 function show_single_json_dmsg($message)
434 $this->init_document('json');
435 $dmsg = $this->twitter_dmsg_array($message);
436 $this->show_json_objects($dmsg);
437 $this->end_document('json');
440 function show_twitter_xml_dmsg($twitter_dm)
442 $this->elementStart('direct_message');
443 foreach($twitter_dm as $element => $value) {
447 $this->show_twitter_xml_user($value, $element);
450 $this->element($element, null, common_xml_safe_str($value));
453 $this->element($element, null, $value);
456 $this->elementEnd('direct_message');
459 function show_xml_timeline($notice)
462 $this->init_document('xml');
463 $this->elementStart('statuses', array('type' => 'array'));
465 if (is_array($notice)) {
466 foreach ($notice as $n) {
467 $twitter_status = $this->twitter_status_array($n);
468 $this->show_twitter_xml_status($twitter_status);
471 while ($notice->fetch()) {
472 $twitter_status = $this->twitter_status_array($notice);
473 $this->show_twitter_xml_status($twitter_status);
477 $this->elementEnd('statuses');
478 $this->end_document('xml');
481 function show_rss_timeline($notice, $title, $link, $subtitle, $suplink=null)
484 $this->init_document('rss');
486 $this->elementStart('channel');
487 $this->element('title', null, $title);
488 $this->element('link', null, $link);
489 if (!is_null($suplink)) {
490 # For FriendFeed's SUP protocol
491 $this->element('link', array('xmlns' => 'http://www.w3.org/2005/Atom',
492 'rel' => 'http://api.friendfeed.com/2008/03#sup',
494 'type' => 'application/json'));
496 $this->element('description', null, $subtitle);
497 $this->element('language', null, 'en-us');
498 $this->element('ttl', null, '40');
500 if (is_array($notice)) {
501 foreach ($notice as $n) {
502 $entry = $this->twitter_rss_entry_array($n);
503 $this->show_twitter_rss_item($entry);
506 while ($notice->fetch()) {
507 $entry = $this->twitter_rss_entry_array($notice);
508 $this->show_twitter_rss_item($entry);
512 $this->elementEnd('channel');
513 $this->end_twitter_rss();
516 function show_atom_timeline($notice, $title, $id, $link, $subtitle=null, $suplink=null, $selfuri=null)
519 $this->init_document('atom');
521 $this->element('title', null, $title);
522 $this->element('id', null, $id);
523 $this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null);
525 if (!is_null($suplink)) {
526 # For FriendFeed's SUP protocol
527 $this->element('link', array('rel' => 'http://api.friendfeed.com/2008/03#sup',
529 'type' => 'application/json'));
532 if (!is_null($selfuri)) {
533 $this->element('link', array('href' => $selfuri,
534 'rel' => 'self', 'type' => 'application/atom+xml'), null);
537 $this->element('updated', null, common_date_iso8601('now'));
538 $this->element('subtitle', null, $subtitle);
540 if (is_array($notice)) {
541 foreach ($notice as $n) {
542 $this->raw($n->asAtomEntry());
545 while ($notice->fetch()) {
546 $this->raw($notice->asAtomEntry());
550 $this->end_document('atom');
554 function show_json_timeline($notice)
557 $this->init_document('json');
561 if (is_array($notice)) {
562 foreach ($notice as $n) {
563 $twitter_status = $this->twitter_status_array($n);
564 array_push($statuses, $twitter_status);
567 while ($notice->fetch()) {
568 $twitter_status = $this->twitter_status_array($notice);
569 array_push($statuses, $twitter_status);
573 $this->show_json_objects($statuses);
575 $this->end_document('json');
578 // Anyone know what date format this is?
579 // Twitter's dates look like this: "Mon Jul 14 23:52:38 +0000 2008" -- Zach
580 function date_twitter($dt)
583 return date("D M d H:i:s O Y", $t);
586 // XXX: Candidate for a general utility method somewhere?
587 function count_subscriptions($profile)
591 $sub = new Subscription();
592 $sub->subscribed = $profile->id;
594 $count = $sub->find();
603 function init_document($type='xml')
607 header('Content-Type: application/xml; charset=utf-8');
611 header('Content-Type: application/json; charset=utf-8');
613 // Check for JSONP callback
614 $callback = $this->arg('callback');
616 print $callback . '(';
620 header("Content-Type: application/rss+xml; charset=utf-8");
621 $this->init_twitter_rss();
624 header('Content-Type: application/atom+xml; charset=utf-8');
625 $this->init_twitter_atom();
628 $this->clientError(_('Not a supported data format.'));
635 function end_document($type='xml')
643 // Check for JSONP callback
644 $callback = $this->arg('callback');
650 $this->end_twitter_rss();
653 $this->end_twitter_rss();
656 $this->clientError(_('Not a supported data format.'));
662 function clientError($msg, $code = 400, $content_type = 'json')
665 static $status = array(400 => 'Bad Request',
666 401 => 'Unauthorized',
667 402 => 'Payment Required',
670 405 => 'Method Not Allowed',
671 406 => 'Not Acceptable',
672 407 => 'Proxy Authentication Required',
673 408 => 'Request Timeout',
676 411 => 'Length Required',
677 412 => 'Precondition Failed',
678 413 => 'Request Entity Too Large',
679 414 => 'Request-URI Too Long',
680 415 => 'Unsupported Media Type',
681 416 => 'Requested Range Not Satisfiable',
682 417 => 'Expectation Failed');
684 $action = $this->trimmed('action');
686 common_debug("User error '$code' on '$action': $msg", __FILE__);
688 if (!array_key_exists($code, $status)) {
692 $status_string = $status[$code];
693 header('HTTP/1.1 '.$code.' '.$status_string);
695 if ($content_type == 'xml') {
696 $this->init_document('xml');
697 $this->elementStart('hash');
698 $this->element('error', null, $msg);
699 $this->element('request', null, $_SERVER['REQUEST_URI']);
700 $this->elementEnd('hash');
701 $this->end_document('xml');
703 $this->init_document('json');
704 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
705 print(json_encode($error_array));
706 $this->end_document('json');
711 function init_twitter_rss()
714 $this->elementStart('rss', array('version' => '2.0'));
717 function end_twitter_rss()
719 $this->elementEnd('rss');
723 function init_twitter_atom()
726 // FIXME: don't hardcode the language here!
727 $this->elementStart('feed', array('xmlns' => 'http://www.w3.org/2005/Atom',
728 'xml:lang' => 'en-US',
729 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0'));
732 function end_twitter_atom()
734 $this->elementEnd('feed');
738 function show_profile($profile, $content_type='xml', $notice=null)
740 $profile_array = $this->twitter_user_array($profile, true);
741 switch ($content_type) {
743 $this->show_twitter_xml_user($profile_array);
746 $this->show_json_objects($profile_array);
749 $this->clientError(_('Not a supported data format.'));
755 function get_user($id, $apidata=null)
759 // Twitter supports these other ways of passing the user ID
760 if (is_numeric($this->arg('id'))) {
761 return User::staticGet($this->arg('id'));
762 } else if ($this->arg('id')) {
763 $nickname = common_canonical_nickname($this->arg('id'));
764 return User::staticGet('nickname', $nickname);
765 } else if ($this->arg('user_id')) {
766 // This is to ensure that a non-numeric user_id still
767 // overrides screen_name even if it doesn't get used
768 if (is_numeric($this->arg('user_id'))) {
769 return User::staticGet('id', $this->arg('user_id'));
771 } else if ($this->arg('screen_name')) {
772 $nickname = common_canonical_nickname($this->arg('screen_name'));
773 return User::staticGet('nickname', $nickname);
775 // Fall back to trying the currently authenticated user
776 return $apidata['user'];
779 } else if (is_numeric($id)) {
780 return User::staticGet($id);
782 $nickname = common_canonical_nickname($id);
783 return User::staticGet('nickname', $nickname);
787 function get_profile($id)
789 if (is_numeric($id)) {
790 return Profile::staticGet($id);
792 $user = User::staticGet('nickname', $id);
794 return $user->getProfile();
801 function source_link($source)
803 $source_name = _($source);
812 $ns = Notice_source::staticGet($source);
814 $source_name = '<a href="' . $ns->url . '">' . $ns->name . '</a>';
822 * Returns query argument or default value if not found. Certain
823 * parameters used throughout the API are lightly scrubbed and
824 * bounds checked. This overrides Action::arg().
826 * @param string $key requested argument
827 * @param string $def default value to return if $key is not provided
831 function arg($key, $def=null)
834 // XXX: Do even more input validation/scrubbing?
836 if (array_key_exists($key, $this->args)) {
839 $page = (int)$this->args['page'];
840 return ($page < 1) ? 1 : $page;
842 $count = (int)$this->args['count'];
845 } elseif ($count > 200) {
851 $since_id = (int)$this->args['since_id'];
852 return ($since_id < 1) ? 0 : $since_id;
854 $max_id = (int)$this->args['max_id'];
855 return ($max_id < 1) ? 0 : $max_id;
857 return strtotime($this->args['since']);
859 return parent::arg($key, $def);