3 * StatusNet, the distributed open-source microblogging tool
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Craig Andrews <candrews@integralblue.com>
25 * @author Dan Moore <dan@moore.cx>
26 * @author Evan Prodromou <evan@status.net>
27 * @author Jeffery To <jeffery.to@gmail.com>
28 * @author Toby Inkster <mail@tobyinkster.co.uk>
29 * @author Zach Copley <zach@status.net>
30 * @copyright 2009 StatusNet, Inc.
31 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
32 * @link http://status.net/
35 if (!defined('STATUSNET')) {
40 * Contains most of the Twitter-compatible API output functions.
44 * @author Craig Andrews <candrews@integralblue.com>
45 * @author Dan Moore <dan@moore.cx>
46 * @author Evan Prodromou <evan@status.net>
47 * @author Jeffery To <jeffery.to@gmail.com>
48 * @author Toby Inkster <mail@tobyinkster.co.uk>
49 * @author Zach Copley <zach@status.net>
50 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
51 * @link http://status.net/
54 class ApiAction extends Action
61 var $auth_user = null;
67 var $access = self::READ_ONLY; // read (default) or read-write
72 * @param array $args Web and URL arguments
74 * @return boolean false if user doesn't exist
77 function prepare($args)
79 StatusNet::setApi(true); // reduce exception reports to aid in debugging
80 parent::prepare($args);
82 $this->format = $this->arg('format');
83 $this->page = (int)$this->arg('page', 1);
84 $this->count = (int)$this->arg('count', 20);
85 $this->max_id = (int)$this->arg('max_id', 0);
86 $this->since_id = (int)$this->arg('since_id', 0);
88 if ($this->arg('since')) {
89 header('X-StatusNet-Warning: since parameter is disabled; use since_id');
98 * @param array $args Arguments from $_REQUEST
103 function handle($args)
105 parent::handle($args);
109 * Overrides XMLOutputter::element to write booleans as strings (true|false).
110 * See that method's documentation for more info.
112 * @param string $tag Element type or tagname
113 * @param array $attrs Array of element attributes, as
115 * @param string $content string content of the element
119 function element($tag, $attrs=null, $content=null)
121 if (is_bool($content)) {
122 $content = ($content ? 'true' : 'false');
125 return parent::element($tag, $attrs, $content);
128 function twitterUserArray($profile, $get_notice=false)
130 $twitter_user = array();
132 $twitter_user['id'] = intval($profile->id);
133 $twitter_user['name'] = $profile->getBestName();
134 $twitter_user['screen_name'] = $profile->nickname;
135 $twitter_user['location'] = ($profile->location) ? $profile->location : null;
136 $twitter_user['description'] = ($profile->bio) ? $profile->bio : null;
138 $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
139 $twitter_user['profile_image_url'] = ($avatar) ? $avatar->displayUrl() :
140 Avatar::defaultImage(AVATAR_STREAM_SIZE);
142 $twitter_user['url'] = ($profile->homepage) ? $profile->homepage : null;
143 $twitter_user['protected'] = false; # not supported by StatusNet yet
144 $twitter_user['followers_count'] = $profile->subscriberCount();
147 $user = $profile->getUser();
149 // Note: some profiles don't have an associated user
151 $defaultDesign = Design::siteDesign();
154 $design = $user->getDesign();
157 if (empty($design)) {
158 $design = $defaultDesign;
161 $color = Design::toWebColor(empty($design->backgroundcolor) ? $defaultDesign->backgroundcolor : $design->backgroundcolor);
162 $twitter_user['profile_background_color'] = ($color == null) ? '' : '#'.$color->hexValue();
163 $color = Design::toWebColor(empty($design->textcolor) ? $defaultDesign->textcolor : $design->textcolor);
164 $twitter_user['profile_text_color'] = ($color == null) ? '' : '#'.$color->hexValue();
165 $color = Design::toWebColor(empty($design->linkcolor) ? $defaultDesign->linkcolor : $design->linkcolor);
166 $twitter_user['profile_link_color'] = ($color == null) ? '' : '#'.$color->hexValue();
167 $color = Design::toWebColor(empty($design->sidebarcolor) ? $defaultDesign->sidebarcolor : $design->sidebarcolor);
168 $twitter_user['profile_sidebar_fill_color'] = ($color == null) ? '' : '#'.$color->hexValue();
169 $twitter_user['profile_sidebar_border_color'] = '';
171 $twitter_user['friends_count'] = $profile->subscriptionCount();
173 $twitter_user['created_at'] = $this->dateTwitter($profile->created);
175 $twitter_user['favourites_count'] = $profile->faveCount(); // British spelling!
179 if (!empty($user) && $user->timezone) {
180 $timezone = $user->timezone;
184 $t->setTimezone(new DateTimeZone($timezone));
186 $twitter_user['utc_offset'] = $t->format('Z');
187 $twitter_user['time_zone'] = $timezone;
189 $twitter_user['profile_background_image_url']
190 = empty($design->backgroundimage)
191 ? '' : ($design->disposition & BACKGROUND_ON)
192 ? Design::url($design->backgroundimage) : '';
194 $twitter_user['profile_background_tile']
195 = empty($design->disposition)
196 ? '' : ($design->disposition & BACKGROUND_TILE) ? 'true' : 'false';
198 $twitter_user['statuses_count'] = $profile->noticeCount();
200 // Is the requesting user following this user?
201 $twitter_user['following'] = false;
202 $twitter_user['notifications'] = false;
204 if (isset($this->auth_user)) {
206 $twitter_user['following'] = $this->auth_user->isSubscribed($profile);
209 $sub = Subscription::pkeyGet(array('subscriber' =>
210 $this->auth_user->id,
211 'subscribed' => $profile->id));
214 $twitter_user['notifications'] = ($sub->jabber || $sub->sms);
219 $notice = $profile->getCurrentNotice();
222 $twitter_user['status'] = $this->twitterStatusArray($notice, false);
226 return $twitter_user;
229 function twitterStatusArray($notice, $include_user=true)
231 $base = $this->twitterSimpleStatusArray($notice, $include_user);
233 if (!empty($notice->repeat_of)) {
234 $original = Notice::staticGet('id', $notice->repeat_of);
235 if (!empty($original)) {
236 $original_array = $this->twitterSimpleStatusArray($original, $include_user);
237 $base['retweeted_status'] = $original_array;
244 function twitterSimpleStatusArray($notice, $include_user=true)
246 $profile = $notice->getProfile();
248 $twitter_status = array();
249 $twitter_status['text'] = $notice->content;
250 $twitter_status['truncated'] = false; # Not possible on StatusNet
251 $twitter_status['created_at'] = $this->dateTwitter($notice->created);
252 $twitter_status['in_reply_to_status_id'] = ($notice->reply_to) ?
253 intval($notice->reply_to) : null;
254 $twitter_status['source'] = $this->sourceLink($notice->source);
255 $twitter_status['id'] = intval($notice->id);
257 $replier_profile = null;
259 if ($notice->reply_to) {
260 $reply = Notice::staticGet(intval($notice->reply_to));
262 $replier_profile = $reply->getProfile();
266 $twitter_status['in_reply_to_user_id'] =
267 ($replier_profile) ? intval($replier_profile->id) : null;
268 $twitter_status['in_reply_to_screen_name'] =
269 ($replier_profile) ? $replier_profile->nickname : null;
271 if (isset($notice->lat) && isset($notice->lon)) {
272 // This is the format that GeoJSON expects stuff to be in
273 $twitter_status['geo'] = array('type' => 'Point',
274 'coordinates' => array((float) $notice->lat,
275 (float) $notice->lon));
277 $twitter_status['geo'] = null;
280 if (isset($this->auth_user)) {
281 $twitter_status['favorited'] = $this->auth_user->hasFave($notice);
283 $twitter_status['favorited'] = false;
287 $attachments = $notice->attachments();
289 if (!empty($attachments)) {
291 $twitter_status['attachments'] = array();
293 foreach ($attachments as $attachment) {
294 $enclosure_o=$attachment->getEnclosure();
296 $enclosure = array();
297 $enclosure['url'] = $enclosure_o->url;
298 $enclosure['mimetype'] = $enclosure_o->mimetype;
299 $enclosure['size'] = $enclosure_o->size;
300 $twitter_status['attachments'][] = $enclosure;
305 if ($include_user && $profile) {
306 # Don't get notice (recursive!)
307 $twitter_user = $this->twitterUserArray($profile, false);
308 $twitter_status['user'] = $twitter_user;
311 return $twitter_status;
314 function twitterGroupArray($group)
316 $twitter_group=array();
317 $twitter_group['id']=$group->id;
318 $twitter_group['url']=$group->permalink();
319 $twitter_group['nickname']=$group->nickname;
320 $twitter_group['fullname']=$group->fullname;
321 $twitter_group['homepage_url']=$group->homepage_url;
322 $twitter_group['original_logo']=$group->original_logo;
323 $twitter_group['homepage_logo']=$group->homepage_logo;
324 $twitter_group['stream_logo']=$group->stream_logo;
325 $twitter_group['mini_logo']=$group->mini_logo;
326 $twitter_group['homepage']=$group->homepage;
327 $twitter_group['description']=$group->description;
328 $twitter_group['location']=$group->location;
329 $twitter_group['created']=$this->dateTwitter($group->created);
330 $twitter_group['modified']=$this->dateTwitter($group->modified);
331 return $twitter_group;
334 function twitterRssGroupArray($group)
337 $entry['content']=$group->description;
338 $entry['title']=$group->nickname;
339 $entry['link']=$group->permalink();
340 $entry['published']=common_date_iso8601($group->created);
341 $entry['updated']==common_date_iso8601($group->modified);
342 $taguribase = common_config('integration', 'groupuri');
343 $entry['id'] = "group:$groupuribase:$entry[link]";
345 $entry['description'] = $entry['content'];
346 $entry['pubDate'] = common_date_rfc2822($group->created);
347 $entry['guid'] = $entry['link'];
352 function twitterRssEntryArray($notice)
354 $profile = $notice->getProfile();
357 // We trim() to avoid extraneous whitespace in the output
359 $entry['content'] = common_xml_safe_str(trim($notice->rendered));
360 $entry['title'] = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
361 $entry['link'] = common_local_url('shownotice', array('notice' => $notice->id));
362 $entry['published'] = common_date_iso8601($notice->created);
364 $taguribase = TagURI::base();
365 $entry['id'] = "tag:$taguribase:$entry[link]";
367 $entry['updated'] = $entry['published'];
368 $entry['author'] = $profile->getBestName();
371 $attachments = $notice->attachments();
372 $enclosures = array();
374 foreach ($attachments as $attachment) {
375 $enclosure_o=$attachment->getEnclosure();
377 $enclosure = array();
378 $enclosure['url'] = $enclosure_o->url;
379 $enclosure['mimetype'] = $enclosure_o->mimetype;
380 $enclosure['size'] = $enclosure_o->size;
381 $enclosures[] = $enclosure;
385 if (!empty($enclosures)) {
386 $entry['enclosures'] = $enclosures;
390 $tag = new Notice_tag();
391 $tag->notice_id = $notice->id;
393 $entry['tags']=array();
394 while ($tag->fetch()) {
395 $entry['tags'][]=$tag->tag;
401 $entry['description'] = $entry['content'];
402 $entry['pubDate'] = common_date_rfc2822($notice->created);
403 $entry['guid'] = $entry['link'];
405 if (isset($notice->lat) && isset($notice->lon)) {
406 // This is the format that GeoJSON expects stuff to be in.
407 // showGeoRSS() below uses it for XML output, so we reuse it
408 $entry['geo'] = array('type' => 'Point',
409 'coordinates' => array((float) $notice->lat,
410 (float) $notice->lon));
412 $entry['geo'] = null;
418 function twitterRelationshipArray($source, $target)
420 $relationship = array();
422 $relationship['source'] =
423 $this->relationshipDetailsArray($source, $target);
424 $relationship['target'] =
425 $this->relationshipDetailsArray($target, $source);
427 return array('relationship' => $relationship);
430 function relationshipDetailsArray($source, $target)
434 $details['screen_name'] = $source->nickname;
435 $details['followed_by'] = $target->isSubscribed($source);
436 $details['following'] = $source->isSubscribed($target);
438 $notifications = false;
440 if ($source->isSubscribed($target)) {
442 $sub = Subscription::pkeyGet(array('subscriber' =>
443 $source->id, 'subscribed' => $target->id));
446 $notifications = ($sub->jabber || $sub->sms);
450 $details['notifications_enabled'] = $notifications;
451 $details['blocking'] = $source->hasBlocked($target);
452 $details['id'] = $source->id;
457 function showTwitterXmlRelationship($relationship)
459 $this->elementStart('relationship');
461 foreach($relationship as $element => $value) {
462 if ($element == 'source' || $element == 'target') {
463 $this->elementStart($element);
464 $this->showXmlRelationshipDetails($value);
465 $this->elementEnd($element);
469 $this->elementEnd('relationship');
472 function showXmlRelationshipDetails($details)
474 foreach($details as $element => $value) {
475 $this->element($element, null, $value);
479 function showTwitterXmlStatus($twitter_status, $tag='status')
481 $this->elementStart($tag);
482 foreach($twitter_status as $element => $value) {
485 $this->showTwitterXmlUser($twitter_status['user']);
488 $this->element($element, null, common_xml_safe_str($value));
491 $this->showXmlAttachments($twitter_status['attachments']);
494 $this->showGeoRSS($value);
496 case 'retweeted_status':
497 $this->showTwitterXmlStatus($value, 'retweeted_status');
500 $this->element($element, null, $value);
503 $this->elementEnd($tag);
506 function showTwitterXmlGroup($twitter_group)
508 $this->elementStart('group');
509 foreach($twitter_group as $element => $value) {
510 $this->element($element, null, $value);
512 $this->elementEnd('group');
515 function showTwitterXmlUser($twitter_user, $role='user')
517 $this->elementStart($role);
518 foreach($twitter_user as $element => $value) {
519 if ($element == 'status') {
520 $this->showTwitterXmlStatus($twitter_user['status']);
522 $this->element($element, null, $value);
525 $this->elementEnd($role);
528 function showXmlAttachments($attachments) {
529 if (!empty($attachments)) {
530 $this->elementStart('attachments', array('type' => 'array'));
531 foreach ($attachments as $attachment) {
533 $attrs['url'] = $attachment['url'];
534 $attrs['mimetype'] = $attachment['mimetype'];
535 $attrs['size'] = $attachment['size'];
536 $this->element('enclosure', $attrs, '');
538 $this->elementEnd('attachments');
542 function showGeoRSS($geo)
548 $geo['coordinates'][0] . ' ' . $geo['coordinates'][1]
553 function showTwitterRssItem($entry)
555 $this->elementStart('item');
556 $this->element('title', null, $entry['title']);
557 $this->element('description', null, $entry['description']);
558 $this->element('pubDate', null, $entry['pubDate']);
559 $this->element('guid', null, $entry['guid']);
560 $this->element('link', null, $entry['link']);
562 # RSS only supports 1 enclosure per item
563 if(array_key_exists('enclosures', $entry) and !empty($entry['enclosures'])){
564 $enclosure = $entry['enclosures'][0];
565 $this->element('enclosure', array('url'=>$enclosure['url'],'type'=>$enclosure['mimetype'],'length'=>$enclosure['size']), null);
568 if(array_key_exists('tags', $entry)){
569 foreach($entry['tags'] as $tag){
570 $this->element('category', null,$tag);
574 $this->showGeoRSS($entry['geo']);
575 $this->elementEnd('item');
578 function showJsonObjects($objects)
580 print(json_encode($objects));
583 function showSingleXmlStatus($notice)
585 $this->initDocument('xml');
586 $twitter_status = $this->twitterStatusArray($notice);
587 $this->showTwitterXmlStatus($twitter_status);
588 $this->endDocument('xml');
591 function show_single_json_status($notice)
593 $this->initDocument('json');
594 $status = $this->twitterStatusArray($notice);
595 $this->showJsonObjects($status);
596 $this->endDocument('json');
599 function showXmlTimeline($notice)
602 $this->initDocument('xml');
603 $this->elementStart('statuses', array('type' => 'array'));
605 if (is_array($notice)) {
606 foreach ($notice as $n) {
607 $twitter_status = $this->twitterStatusArray($n);
608 $this->showTwitterXmlStatus($twitter_status);
611 while ($notice->fetch()) {
612 $twitter_status = $this->twitterStatusArray($notice);
613 $this->showTwitterXmlStatus($twitter_status);
617 $this->elementEnd('statuses');
618 $this->endDocument('xml');
621 function showRssTimeline($notice, $title, $link, $subtitle, $suplink = null, $logo = null, $self = null)
624 $this->initDocument('rss');
626 $this->element('title', null, $title);
627 $this->element('link', null, $link);
629 if (!is_null($self)) {
633 'type' => 'application/rss+xml',
640 if (!is_null($suplink)) {
641 // For FriendFeed's SUP protocol
642 $this->element('link', array('xmlns' => 'http://www.w3.org/2005/Atom',
643 'rel' => 'http://api.friendfeed.com/2008/03#sup',
645 'type' => 'application/json'));
648 if (!is_null($logo)) {
649 $this->elementStart('image');
650 $this->element('link', null, $link);
651 $this->element('title', null, $title);
652 $this->element('url', null, $logo);
653 $this->elementEnd('image');
656 $this->element('description', null, $subtitle);
657 $this->element('language', null, 'en-us');
658 $this->element('ttl', null, '40');
660 if (is_array($notice)) {
661 foreach ($notice as $n) {
662 $entry = $this->twitterRssEntryArray($n);
663 $this->showTwitterRssItem($entry);
666 while ($notice->fetch()) {
667 $entry = $this->twitterRssEntryArray($notice);
668 $this->showTwitterRssItem($entry);
672 $this->endTwitterRss();
675 function showAtomTimeline($notice, $title, $id, $link, $subtitle=null, $suplink=null, $selfuri=null, $logo=null)
678 $this->initDocument('atom');
680 $this->element('title', null, $title);
681 $this->element('id', null, $id);
682 $this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null);
684 if (!is_null($logo)) {
685 $this->element('logo',null,$logo);
688 if (!is_null($suplink)) {
689 # For FriendFeed's SUP protocol
690 $this->element('link', array('rel' => 'http://api.friendfeed.com/2008/03#sup',
692 'type' => 'application/json'));
695 if (!is_null($selfuri)) {
696 $this->element('link', array('href' => $selfuri,
697 'rel' => 'self', 'type' => 'application/atom+xml'), null);
700 $this->element('updated', null, common_date_iso8601('now'));
701 $this->element('subtitle', null, $subtitle);
703 if (is_array($notice)) {
704 foreach ($notice as $n) {
705 $this->raw($n->asAtomEntry());
708 while ($notice->fetch()) {
709 $this->raw($notice->asAtomEntry());
713 $this->endDocument('atom');
717 function showRssGroups($group, $title, $link, $subtitle)
720 $this->initDocument('rss');
722 $this->element('title', null, $title);
723 $this->element('link', null, $link);
724 $this->element('description', null, $subtitle);
725 $this->element('language', null, 'en-us');
726 $this->element('ttl', null, '40');
728 if (is_array($group)) {
729 foreach ($group as $g) {
730 $twitter_group = $this->twitterRssGroupArray($g);
731 $this->showTwitterRssItem($twitter_group);
734 while ($group->fetch()) {
735 $twitter_group = $this->twitterRssGroupArray($group);
736 $this->showTwitterRssItem($twitter_group);
740 $this->endTwitterRss();
743 function showTwitterAtomEntry($entry)
745 $this->elementStart('entry');
746 $this->element('title', null, $entry['title']);
747 $this->element('content', array('type' => 'html'), $entry['content']);
748 $this->element('id', null, $entry['id']);
749 $this->element('published', null, $entry['published']);
750 $this->element('updated', null, $entry['updated']);
751 $this->element('link', array('type' => 'text/html',
752 'href' => $entry['link'],
753 'rel' => 'alternate'));
754 $this->element('link', array('type' => $entry['avatar-type'],
755 'href' => $entry['avatar'],
757 $this->elementStart('author');
759 $this->element('name', null, $entry['author-name']);
760 $this->element('uri', null, $entry['author-uri']);
762 $this->elementEnd('author');
763 $this->elementEnd('entry');
766 function showXmlDirectMessage($dm)
768 $this->elementStart('direct_message');
769 foreach($dm as $element => $value) {
773 $this->showTwitterXmlUser($value, $element);
776 $this->element($element, null, common_xml_safe_str($value));
779 $this->element($element, null, $value);
783 $this->elementEnd('direct_message');
786 function directMessageArray($message)
790 $from_profile = $message->getFrom();
791 $to_profile = $message->getTo();
793 $dmsg['id'] = $message->id;
794 $dmsg['sender_id'] = $message->from_profile;
795 $dmsg['text'] = trim($message->content);
796 $dmsg['recipient_id'] = $message->to_profile;
797 $dmsg['created_at'] = $this->dateTwitter($message->created);
798 $dmsg['sender_screen_name'] = $from_profile->nickname;
799 $dmsg['recipient_screen_name'] = $to_profile->nickname;
800 $dmsg['sender'] = $this->twitterUserArray($from_profile, false);
801 $dmsg['recipient'] = $this->twitterUserArray($to_profile, false);
806 function rssDirectMessageArray($message)
810 $from = $message->getFrom();
812 $entry['title'] = sprintf('Message from %1$s to %2$s',
813 $from->nickname, $message->getTo()->nickname);
815 $entry['content'] = common_xml_safe_str($message->rendered);
816 $entry['link'] = common_local_url('showmessage', array('message' => $message->id));
817 $entry['published'] = common_date_iso8601($message->created);
819 $taguribase = TagURI::base();
821 $entry['id'] = "tag:$taguribase:$entry[link]";
822 $entry['updated'] = $entry['published'];
824 $entry['author-name'] = $from->getBestName();
825 $entry['author-uri'] = $from->homepage;
827 $avatar = $from->getAvatar(AVATAR_STREAM_SIZE);
829 $entry['avatar'] = (!empty($avatar)) ? $avatar->url : Avatar::defaultImage(AVATAR_STREAM_SIZE);
830 $entry['avatar-type'] = (!empty($avatar)) ? $avatar->mediatype : 'image/png';
834 $entry['description'] = $entry['content'];
835 $entry['pubDate'] = common_date_rfc2822($message->created);
836 $entry['guid'] = $entry['link'];
841 function showSingleXmlDirectMessage($message)
843 $this->initDocument('xml');
844 $dmsg = $this->directMessageArray($message);
845 $this->showXmlDirectMessage($dmsg);
846 $this->endDocument('xml');
849 function showSingleJsonDirectMessage($message)
851 $this->initDocument('json');
852 $dmsg = $this->directMessageArray($message);
853 $this->showJsonObjects($dmsg);
854 $this->endDocument('json');
857 function showAtomGroups($group, $title, $id, $link, $subtitle=null, $selfuri=null)
860 $this->initDocument('atom');
862 $this->element('title', null, $title);
863 $this->element('id', null, $id);
864 $this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null);
866 if (!is_null($selfuri)) {
867 $this->element('link', array('href' => $selfuri,
868 'rel' => 'self', 'type' => 'application/atom+xml'), null);
871 $this->element('updated', null, common_date_iso8601('now'));
872 $this->element('subtitle', null, $subtitle);
874 if (is_array($group)) {
875 foreach ($group as $g) {
876 $this->raw($g->asAtomEntry());
879 while ($group->fetch()) {
880 $this->raw($group->asAtomEntry());
884 $this->endDocument('atom');
888 function showJsonTimeline($notice)
891 $this->initDocument('json');
895 if (is_array($notice)) {
896 foreach ($notice as $n) {
897 $twitter_status = $this->twitterStatusArray($n);
898 array_push($statuses, $twitter_status);
901 while ($notice->fetch()) {
902 $twitter_status = $this->twitterStatusArray($notice);
903 array_push($statuses, $twitter_status);
907 $this->showJsonObjects($statuses);
909 $this->endDocument('json');
912 function showJsonGroups($group)
915 $this->initDocument('json');
919 if (is_array($group)) {
920 foreach ($group as $g) {
921 $twitter_group = $this->twitterGroupArray($g);
922 array_push($groups, $twitter_group);
925 while ($group->fetch()) {
926 $twitter_group = $this->twitterGroupArray($group);
927 array_push($groups, $twitter_group);
931 $this->showJsonObjects($groups);
933 $this->endDocument('json');
936 function showXmlGroups($group)
939 $this->initDocument('xml');
940 $this->elementStart('groups', array('type' => 'array'));
942 if (is_array($group)) {
943 foreach ($group as $g) {
944 $twitter_group = $this->twitterGroupArray($g);
945 $this->showTwitterXmlGroup($twitter_group);
948 while ($group->fetch()) {
949 $twitter_group = $this->twitterGroupArray($group);
950 $this->showTwitterXmlGroup($twitter_group);
954 $this->elementEnd('groups');
955 $this->endDocument('xml');
958 function showTwitterXmlUsers($user)
961 $this->initDocument('xml');
962 $this->elementStart('users', array('type' => 'array'));
964 if (is_array($user)) {
965 foreach ($user as $u) {
966 $twitter_user = $this->twitterUserArray($u);
967 $this->showTwitterXmlUser($twitter_user);
970 while ($user->fetch()) {
971 $twitter_user = $this->twitterUserArray($user);
972 $this->showTwitterXmlUser($twitter_user);
976 $this->elementEnd('users');
977 $this->endDocument('xml');
980 function showJsonUsers($user)
983 $this->initDocument('json');
987 if (is_array($user)) {
988 foreach ($user as $u) {
989 $twitter_user = $this->twitterUserArray($u);
990 array_push($users, $twitter_user);
993 while ($user->fetch()) {
994 $twitter_user = $this->twitterUserArray($user);
995 array_push($users, $twitter_user);
999 $this->showJsonObjects($users);
1001 $this->endDocument('json');
1004 function showSingleJsonGroup($group)
1006 $this->initDocument('json');
1007 $twitter_group = $this->twitterGroupArray($group);
1008 $this->showJsonObjects($twitter_group);
1009 $this->endDocument('json');
1012 function showSingleXmlGroup($group)
1014 $this->initDocument('xml');
1015 $twitter_group = $this->twitterGroupArray($group);
1016 $this->showTwitterXmlGroup($twitter_group);
1017 $this->endDocument('xml');
1020 function dateTwitter($dt)
1022 $dateStr = date('d F Y H:i:s', strtotime($dt));
1023 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1024 $d->setTimezone(new DateTimeZone(common_timezone()));
1025 return $d->format('D M d H:i:s O Y');
1028 function initDocument($type='xml')
1032 header('Content-Type: application/xml; charset=utf-8');
1036 header('Content-Type: application/json; charset=utf-8');
1038 // Check for JSONP callback
1039 $callback = $this->arg('callback');
1041 print $callback . '(';
1045 header("Content-Type: application/rss+xml; charset=utf-8");
1046 $this->initTwitterRss();
1049 header('Content-Type: application/atom+xml; charset=utf-8');
1050 $this->initTwitterAtom();
1053 $this->clientError(_('Not a supported data format.'));
1060 function endDocument($type='xml')
1068 // Check for JSONP callback
1069 $callback = $this->arg('callback');
1075 $this->endTwitterRss();
1078 $this->endTwitterRss();
1081 $this->clientError(_('Not a supported data format.'));
1087 function clientError($msg, $code = 400, $format = 'xml')
1089 $action = $this->trimmed('action');
1091 common_debug("User error '$code' on '$action': $msg", __FILE__);
1093 if (!array_key_exists($code, ClientErrorAction::$status)) {
1097 $status_string = ClientErrorAction::$status[$code];
1099 header('HTTP/1.1 '.$code.' '.$status_string);
1101 if ($format == 'xml') {
1102 $this->initDocument('xml');
1103 $this->elementStart('hash');
1104 $this->element('error', null, $msg);
1105 $this->element('request', null, $_SERVER['REQUEST_URI']);
1106 $this->elementEnd('hash');
1107 $this->endDocument('xml');
1108 } elseif ($format == 'json'){
1109 $this->initDocument('json');
1110 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1111 print(json_encode($error_array));
1112 $this->endDocument('json');
1115 // If user didn't request a useful format, throw a regular client error
1116 throw new ClientException($msg, $code);
1120 function serverError($msg, $code = 500, $content_type = 'xml')
1122 $action = $this->trimmed('action');
1124 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1126 if (!array_key_exists($code, ServerErrorAction::$status)) {
1130 $status_string = ServerErrorAction::$status[$code];
1132 header('HTTP/1.1 '.$code.' '.$status_string);
1134 if ($content_type == 'xml') {
1135 $this->initDocument('xml');
1136 $this->elementStart('hash');
1137 $this->element('error', null, $msg);
1138 $this->element('request', null, $_SERVER['REQUEST_URI']);
1139 $this->elementEnd('hash');
1140 $this->endDocument('xml');
1142 $this->initDocument('json');
1143 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1144 print(json_encode($error_array));
1145 $this->endDocument('json');
1149 function initTwitterRss()
1152 $this->elementStart(
1156 'xmlns:atom' => 'http://www.w3.org/2005/Atom',
1157 'xmlns:georss' => 'http://www.georss.org/georss'
1160 $this->elementStart('channel');
1161 Event::handle('StartApiRss', array($this));
1164 function endTwitterRss()
1166 $this->elementEnd('channel');
1167 $this->elementEnd('rss');
1171 function initTwitterAtom()
1174 // FIXME: don't hardcode the language here!
1175 $this->elementStart('feed', array('xmlns' => 'http://www.w3.org/2005/Atom',
1176 'xml:lang' => 'en-US',
1177 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0'));
1180 function endTwitterAtom()
1182 $this->elementEnd('feed');
1186 function showProfile($profile, $content_type='xml', $notice=null, $includeStatuses=true)
1188 $profile_array = $this->twitterUserArray($profile, $includeStatuses);
1189 switch ($content_type) {
1191 $this->showTwitterXmlUser($profile_array);
1194 $this->showJsonObjects($profile_array);
1197 $this->clientError(_('Not a supported data format.'));
1203 function getTargetUser($id)
1207 // Twitter supports these other ways of passing the user ID
1208 if (is_numeric($this->arg('id'))) {
1209 return User::staticGet($this->arg('id'));
1210 } else if ($this->arg('id')) {
1211 $nickname = common_canonical_nickname($this->arg('id'));
1212 return User::staticGet('nickname', $nickname);
1213 } else if ($this->arg('user_id')) {
1214 // This is to ensure that a non-numeric user_id still
1215 // overrides screen_name even if it doesn't get used
1216 if (is_numeric($this->arg('user_id'))) {
1217 return User::staticGet('id', $this->arg('user_id'));
1219 } else if ($this->arg('screen_name')) {
1220 $nickname = common_canonical_nickname($this->arg('screen_name'));
1221 return User::staticGet('nickname', $nickname);
1223 // Fall back to trying the currently authenticated user
1224 return $this->auth_user;
1227 } else if (is_numeric($id)) {
1228 return User::staticGet($id);
1230 $nickname = common_canonical_nickname($id);
1231 return User::staticGet('nickname', $nickname);
1235 function getTargetGroup($id)
1238 if (is_numeric($this->arg('id'))) {
1239 return User_group::staticGet($this->arg('id'));
1240 } else if ($this->arg('id')) {
1241 $nickname = common_canonical_nickname($this->arg('id'));
1242 $local = Local_group::staticGet('nickname', $nickname);
1243 if (empty($local)) {
1246 return User_group::staticGet('id', $local->id);
1248 } else if ($this->arg('group_id')) {
1249 // This is to ensure that a non-numeric user_id still
1250 // overrides screen_name even if it doesn't get used
1251 if (is_numeric($this->arg('group_id'))) {
1252 return User_group::staticGet('id', $this->arg('group_id'));
1254 } else if ($this->arg('group_name')) {
1255 $nickname = common_canonical_nickname($this->arg('group_name'));
1256 $local = Local_group::staticGet('nickname', $nickname);
1257 if (empty($local)) {
1260 return User_group::staticGet('id', $local->id);
1264 } else if (is_numeric($id)) {
1265 return User_group::staticGet($id);
1267 $nickname = common_canonical_nickname($id);
1268 $local = Local_group::staticGet('nickname', $nickname);
1269 if (empty($local)) {
1272 return User_group::staticGet('id', $local->group_id);
1277 function sourceLink($source)
1279 $source_name = _($source);
1292 $ns = Notice_source::staticGet($source);
1298 $app = Oauth_application::staticGet('name', $source);
1301 $url = $app->source_url;
1305 if (!empty($name) && !empty($url)) {
1306 $source_name = '<a href="' . $url . '">' . $name . '</a>';
1311 return $source_name;
1315 * Returns query argument or default value if not found. Certain
1316 * parameters used throughout the API are lightly scrubbed and
1317 * bounds checked. This overrides Action::arg().
1319 * @param string $key requested argument
1320 * @param string $def default value to return if $key is not provided
1324 function arg($key, $def=null)
1327 // XXX: Do even more input validation/scrubbing?
1329 if (array_key_exists($key, $this->args)) {
1332 $page = (int)$this->args['page'];
1333 return ($page < 1) ? 1 : $page;
1335 $count = (int)$this->args['count'];
1338 } elseif ($count > 200) {
1344 $since_id = (int)$this->args['since_id'];
1345 return ($since_id < 1) ? 0 : $since_id;
1347 $max_id = (int)$this->args['max_id'];
1348 return ($max_id < 1) ? 0 : $max_id;
1350 return parent::arg($key, $def);
1357 function getSelfUri($action, $aargs)
1359 parse_str($_SERVER['QUERY_STRING'], $params);
1361 if (!empty($params)) {
1362 unset($params['p']);
1363 $pstring = http_build_query($params);
1366 $uri = common_local_url($action, $aargs);
1368 if (!empty($pstring)) {
1369 $uri .= '?' . $pstring;