lib/apiaction.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base API action
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  API
  23  * @package   StatusNet
  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/
  33  */
  34
  35 if (!defined('STATUSNET')) {
  36     exit(1);
  37 }
  38
  39 /**
  40  * Contains most of the Twitter-compatible API output functions.
  41  *
  42  * @category API
  43  * @package  StatusNet
  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/
  52  */
  53
  54 class ApiAction extends Action
  55 {
  56     const READ_ONLY  = 1;
  57     const READ_WRITE = 2;
  58
  59     var $format    = null;
  60     var $user      = null;
  61     var $auth_user = null;
  62     var $page      = null;
  63     var $count     = null;
  64     var $max_id    = null;
  65     var $since_id  = null;
  66
  67     var $access    = self::READ_ONLY;  // read (default) or read-write
  68
  69     /**
  70      * Initialization.
  71      *
  72      * @param array $args Web and URL arguments
  73      *
  74      * @return boolean false if user doesn't exist
  75      */
  76
  77     function prepare($args)
  78     {
  79         StatusNet::setApi(true); // reduce exception reports to aid in debugging
  80         parent::prepare($args);
  81
  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);
  87
  88         if ($this->arg('since')) {
  89             header('X-StatusNet-Warning: since parameter is disabled; use since_id');
  90         }
  91
  92         return true;
  93     }
  94
  95     /**
  96      * Handle a request
  97      *
  98      * @param array $args Arguments from $_REQUEST
  99      *
 100      * @return void
 101      */
 102
 103     function handle($args)
 104     {
 105         parent::handle($args);
 106     }
 107
 108     /**
 109      * Overrides XMLOutputter::element to write booleans as strings (true|false).
 110      * See that method's documentation for more info.
 111      *
 112      * @param string $tag     Element type or tagname
 113      * @param array  $attrs   Array of element attributes, as
 114      *                        key-value pairs
 115      * @param string $content string content of the element
 116      *
 117      * @return void
 118      */
 119     function element($tag, $attrs=null, $content=null)
 120     {
 121         if (is_bool($content)) {
 122             $content = ($content ? 'true' : 'false');
 123         }
 124
 125         return parent::element($tag, $attrs, $content);
 126     }
 127
 128     function twitterUserArray($profile, $get_notice=false)
 129     {
 130         $twitter_user = array();
 131
 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;
 137
 138         $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
 139         $twitter_user['profile_image_url'] = ($avatar) ? $avatar->displayUrl() :
 140             Avatar::defaultImage(AVATAR_STREAM_SIZE);
 141
 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();
 145
 146         $design        = null;
 147         $user          = $profile->getUser();
 148
 149         // Note: some profiles don't have an associated user
 150
 151         $defaultDesign = Design::siteDesign();
 152
 153         if (!empty($user)) {
 154             $design = $user->getDesign();
 155         }
 156
 157         if (empty($design)) {
 158             $design = $defaultDesign;
 159         }
 160
 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'] = '';
 170
 171         $twitter_user['friends_count'] = $profile->subscriptionCount();
 172
 173         $twitter_user['created_at'] = $this->dateTwitter($profile->created);
 174
 175         $twitter_user['favourites_count'] = $profile->faveCount(); // British spelling!
 176
 177         $timezone = 'UTC';
 178
 179         if (!empty($user) && $user->timezone) {
 180             $timezone = $user->timezone;
 181         }
 182
 183         $t = new DateTime;
 184         $t->setTimezone(new DateTimeZone($timezone));
 185
 186         $twitter_user['utc_offset'] = $t->format('Z');
 187         $twitter_user['time_zone'] = $timezone;
 188
 189         $twitter_user['profile_background_image_url']
 190             = empty($design->backgroundimage)
 191             ? '' : ($design->disposition & BACKGROUND_ON)
 192             ? Design::url($design->backgroundimage) : '';
 193
 194         $twitter_user['profile_background_tile']
 195             = empty($design->disposition)
 196             ? '' : ($design->disposition & BACKGROUND_TILE) ? 'true' : 'false';
 197
 198         $twitter_user['statuses_count'] = $profile->noticeCount();
 199
 200         // Is the requesting user following this user?
 201         $twitter_user['following'] = false;
 202         $twitter_user['notifications'] = false;
 203
 204         if (isset($this->auth_user)) {
 205
 206             $twitter_user['following'] = $this->auth_user->isSubscribed($profile);
 207
 208             // Notifications on?
 209             $sub = Subscription::pkeyGet(array('subscriber' =>
 210                                                $this->auth_user->id,
 211                                                'subscribed' => $profile->id));
 212
 213             if ($sub) {
 214                 $twitter_user['notifications'] = ($sub->jabber || $sub->sms);
 215             }
 216         }
 217
 218         if ($get_notice) {
 219             $notice = $profile->getCurrentNotice();
 220             if ($notice) {
 221                 # don't get user!
 222                 $twitter_user['status'] = $this->twitterStatusArray($notice, false);
 223             }
 224         }
 225
 226         return $twitter_user;
 227     }
 228
 229     function twitterStatusArray($notice, $include_user=true)
 230     {
 231         $base = $this->twitterSimpleStatusArray($notice, $include_user);
 232
 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;
 238             }
 239         }
 240
 241         return $base;
 242     }
 243
 244     function twitterSimpleStatusArray($notice, $include_user=true)
 245     {
 246         $profile = $notice->getProfile();
 247
 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);
 256
 257         $replier_profile = null;
 258
 259         if ($notice->reply_to) {
 260             $reply = Notice::staticGet(intval($notice->reply_to));
 261             if ($reply) {
 262                 $replier_profile = $reply->getProfile();
 263             }
 264         }
 265
 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;
 270
 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));
 276         } else {
 277             $twitter_status['geo'] = null;
 278         }
 279
 280         if (isset($this->auth_user)) {
 281             $twitter_status['favorited'] = $this->auth_user->hasFave($notice);
 282         } else {
 283             $twitter_status['favorited'] = false;
 284         }
 285
 286         // Enclosures
 287         $attachments = $notice->attachments();
 288
 289         if (!empty($attachments)) {
 290
 291             $twitter_status['attachments'] = array();
 292
 293             foreach ($attachments as $attachment) {
 294                 $enclosure_o=$attachment->getEnclosure();
 295                 if ($enclosure_o) {
 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;
 301                 }
 302             }
 303         }
 304
 305         if ($include_user && $profile) {
 306             # Don't get notice (recursive!)
 307             $twitter_user = $this->twitterUserArray($profile, false);
 308             $twitter_status['user'] = $twitter_user;
 309         }
 310
 311         return $twitter_status;
 312     }
 313
 314     function twitterGroupArray($group)
 315     {
 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;
 332     }
 333
 334     function twitterRssGroupArray($group)
 335     {
 336         $entry = array();
 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]";
 344
 345         $entry['description'] = $entry['content'];
 346         $entry['pubDate'] = common_date_rfc2822($group->created);
 347         $entry['guid'] = $entry['link'];
 348
 349         return $entry;
 350     }
 351
 352     function twitterRssEntryArray($notice)
 353     {
 354         $profile = $notice->getProfile();
 355         $entry = array();
 356
 357         // We trim() to avoid extraneous whitespace in the output
 358
 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);
 363
 364         $taguribase = TagURI::base();
 365         $entry['id'] = "tag:$taguribase:$entry[link]";
 366
 367         $entry['updated'] = $entry['published'];
 368         $entry['author'] = $profile->getBestName();
 369
 370         // Enclosures
 371         $attachments = $notice->attachments();
 372         $enclosures = array();
 373
 374         foreach ($attachments as $attachment) {
 375             $enclosure_o=$attachment->getEnclosure();
 376             if ($enclosure_o) {
 377                  $enclosure = array();
 378                  $enclosure['url'] = $enclosure_o->url;
 379                  $enclosure['mimetype'] = $enclosure_o->mimetype;
 380                  $enclosure['size'] = $enclosure_o->size;
 381                  $enclosures[] = $enclosure;
 382             }
 383         }
 384
 385         if (!empty($enclosures)) {
 386             $entry['enclosures'] = $enclosures;
 387         }
 388
 389         // Tags/Categories
 390         $tag = new Notice_tag();
 391         $tag->notice_id = $notice->id;
 392         if ($tag->find()) {
 393             $entry['tags']=array();
 394             while ($tag->fetch()) {
 395                 $entry['tags'][]=$tag->tag;
 396             }
 397         }
 398         $tag->free();
 399
 400         // RSS Item specific
 401         $entry['description'] = $entry['content'];
 402         $entry['pubDate'] = common_date_rfc2822($notice->created);
 403         $entry['guid'] = $entry['link'];
 404
 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));
 411         } else {
 412             $entry['geo'] = null;
 413         }
 414
 415         return $entry;
 416     }
 417
 418     function twitterRelationshipArray($source, $target)
 419     {
 420         $relationship = array();
 421
 422         $relationship['source'] =
 423             $this->relationshipDetailsArray($source, $target);
 424         $relationship['target'] =
 425             $this->relationshipDetailsArray($target, $source);
 426
 427         return array('relationship' => $relationship);
 428     }
 429
 430     function relationshipDetailsArray($source, $target)
 431     {
 432         $details = array();
 433
 434         $details['screen_name'] = $source->nickname;
 435         $details['followed_by'] = $target->isSubscribed($source);
 436         $details['following'] = $source->isSubscribed($target);
 437
 438         $notifications = false;
 439
 440         if ($source->isSubscribed($target)) {
 441
 442             $sub = Subscription::pkeyGet(array('subscriber' =>
 443                 $source->id, 'subscribed' => $target->id));
 444
 445             if (!empty($sub)) {
 446                 $notifications = ($sub->jabber || $sub->sms);
 447             }
 448         }
 449
 450         $details['notifications_enabled'] = $notifications;
 451         $details['blocking'] = $source->hasBlocked($target);
 452         $details['id'] = $source->id;
 453
 454         return $details;
 455     }
 456
 457     function showTwitterXmlRelationship($relationship)
 458     {
 459         $this->elementStart('relationship');
 460
 461         foreach($relationship as $element => $value) {
 462             if ($element == 'source' || $element == 'target') {
 463                 $this->elementStart($element);
 464                 $this->showXmlRelationshipDetails($value);
 465                 $this->elementEnd($element);
 466             }
 467         }
 468
 469         $this->elementEnd('relationship');
 470     }
 471
 472     function showXmlRelationshipDetails($details)
 473     {
 474         foreach($details as $element => $value) {
 475             $this->element($element, null, $value);
 476         }
 477     }
 478
 479     function showTwitterXmlStatus($twitter_status, $tag='status')
 480     {
 481         $this->elementStart($tag);
 482         foreach($twitter_status as $element => $value) {
 483             switch ($element) {
 484             case 'user':
 485                 $this->showTwitterXmlUser($twitter_status['user']);
 486                 break;
 487             case 'text':
 488                 $this->element($element, null, common_xml_safe_str($value));
 489                 break;
 490             case 'attachments':
 491                 $this->showXmlAttachments($twitter_status['attachments']);
 492                 break;
 493             case 'geo':
 494                 $this->showGeoRSS($value);
 495                 break;
 496             case 'retweeted_status':
 497                 $this->showTwitterXmlStatus($value, 'retweeted_status');
 498                 break;
 499             default:
 500                 $this->element($element, null, $value);
 501             }
 502         }
 503         $this->elementEnd($tag);
 504     }
 505
 506     function showTwitterXmlGroup($twitter_group)
 507     {
 508         $this->elementStart('group');
 509         foreach($twitter_group as $element => $value) {
 510             $this->element($element, null, $value);
 511         }
 512         $this->elementEnd('group');
 513     }
 514
 515     function showTwitterXmlUser($twitter_user, $role='user')
 516     {
 517         $this->elementStart($role);
 518         foreach($twitter_user as $element => $value) {
 519             if ($element == 'status') {
 520                 $this->showTwitterXmlStatus($twitter_user['status']);
 521             } else {
 522                 $this->element($element, null, $value);
 523             }
 524         }
 525         $this->elementEnd($role);
 526     }
 527
 528     function showXmlAttachments($attachments) {
 529         if (!empty($attachments)) {
 530             $this->elementStart('attachments', array('type' => 'array'));
 531             foreach ($attachments as $attachment) {
 532                 $attrs = array();
 533                 $attrs['url'] = $attachment['url'];
 534                 $attrs['mimetype'] = $attachment['mimetype'];
 535                 $attrs['size'] = $attachment['size'];
 536                 $this->element('enclosure', $attrs, '');
 537             }
 538             $this->elementEnd('attachments');
 539         }
 540     }
 541
 542     function showGeoRSS($geo)
 543     {
 544         if (!empty($geo)) {
 545             $this->element(
 546                 'georss:point',
 547                 null,
 548                 $geo['coordinates'][0] . ' ' . $geo['coordinates'][1]
 549             );
 550         }
 551     }
 552
 553     function showTwitterRssItem($entry)
 554     {
 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']);
 561
 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);
 566         }
 567
 568         if(array_key_exists('tags', $entry)){
 569             foreach($entry['tags'] as $tag){
 570                 $this->element('category', null,$tag);
 571             }
 572         }
 573
 574         $this->showGeoRSS($entry['geo']);
 575         $this->elementEnd('item');
 576     }
 577
 578     function showJsonObjects($objects)
 579     {
 580         print(json_encode($objects));
 581     }
 582
 583     function showSingleXmlStatus($notice)
 584     {
 585         $this->initDocument('xml');
 586         $twitter_status = $this->twitterStatusArray($notice);
 587         $this->showTwitterXmlStatus($twitter_status);
 588         $this->endDocument('xml');
 589     }
 590
 591     function show_single_json_status($notice)
 592     {
 593         $this->initDocument('json');
 594         $status = $this->twitterStatusArray($notice);
 595         $this->showJsonObjects($status);
 596         $this->endDocument('json');
 597     }
 598
 599     function showXmlTimeline($notice)
 600     {
 601
 602         $this->initDocument('xml');
 603         $this->elementStart('statuses', array('type' => 'array'));
 604
 605         if (is_array($notice)) {
 606             foreach ($notice as $n) {
 607                 $twitter_status = $this->twitterStatusArray($n);
 608                 $this->showTwitterXmlStatus($twitter_status);
 609             }
 610         } else {
 611             while ($notice->fetch()) {
 612                 $twitter_status = $this->twitterStatusArray($notice);
 613                 $this->showTwitterXmlStatus($twitter_status);
 614             }
 615         }
 616
 617         $this->elementEnd('statuses');
 618         $this->endDocument('xml');
 619     }
 620
 621     function showRssTimeline($notice, $title, $link, $subtitle, $suplink = null, $logo = null, $self = null)
 622     {
 623
 624         $this->initDocument('rss');
 625
 626         $this->element('title', null, $title);
 627         $this->element('link', null, $link);
 628
 629         if (!is_null($self)) {
 630             $this->element(
 631                 'atom:link',
 632                 array(
 633                     'type' => 'application/rss+xml',
 634                     'href' => $self,
 635                     'rel'  => 'self'
 636                 )
 637            );
 638         }
 639
 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',
 644                                          'href' => $suplink,
 645                                          'type' => 'application/json'));
 646         }
 647
 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');
 654         }
 655
 656         $this->element('description', null, $subtitle);
 657         $this->element('language', null, 'en-us');
 658         $this->element('ttl', null, '40');
 659
 660         if (is_array($notice)) {
 661             foreach ($notice as $n) {
 662                 $entry = $this->twitterRssEntryArray($n);
 663                 $this->showTwitterRssItem($entry);
 664             }
 665         } else {
 666             while ($notice->fetch()) {
 667                 $entry = $this->twitterRssEntryArray($notice);
 668                 $this->showTwitterRssItem($entry);
 669             }
 670         }
 671
 672         $this->endTwitterRss();
 673     }
 674
 675     function showAtomTimeline($notice, $title, $id, $link, $subtitle=null, $suplink=null, $selfuri=null, $logo=null)
 676     {
 677
 678         $this->initDocument('atom');
 679
 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);
 683
 684         if (!is_null($logo)) {
 685             $this->element('logo',null,$logo);
 686         }
 687
 688         if (!is_null($suplink)) {
 689             # For FriendFeed's SUP protocol
 690             $this->element('link', array('rel' => 'http://api.friendfeed.com/2008/03#sup',
 691                                          'href' => $suplink,
 692                                          'type' => 'application/json'));
 693         }
 694
 695         if (!is_null($selfuri)) {
 696             $this->element('link', array('href' => $selfuri,
 697                 'rel' => 'self', 'type' => 'application/atom+xml'), null);
 698         }
 699
 700         $this->element('updated', null, common_date_iso8601('now'));
 701         $this->element('subtitle', null, $subtitle);
 702
 703         if (is_array($notice)) {
 704             foreach ($notice as $n) {
 705                 $this->raw($n->asAtomEntry());
 706             }
 707         } else {
 708             while ($notice->fetch()) {
 709                 $this->raw($notice->asAtomEntry());
 710             }
 711         }
 712
 713         $this->endDocument('atom');
 714
 715     }
 716
 717     function showRssGroups($group, $title, $link, $subtitle)
 718     {
 719
 720         $this->initDocument('rss');
 721
 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');
 727
 728         if (is_array($group)) {
 729             foreach ($group as $g) {
 730                 $twitter_group = $this->twitterRssGroupArray($g);
 731                 $this->showTwitterRssItem($twitter_group);
 732             }
 733         } else {
 734             while ($group->fetch()) {
 735                 $twitter_group = $this->twitterRssGroupArray($group);
 736                 $this->showTwitterRssItem($twitter_group);
 737             }
 738         }
 739
 740         $this->endTwitterRss();
 741     }
 742
 743     function showTwitterAtomEntry($entry)
 744     {
 745         $this->elementStart('entry');
 746         $this->element('title', null, common_xml_safe_str($entry['title']));
 747         $this->element(
 748             'content',
 749             array('type' => 'html'),
 750             common_xml_safe_str($entry['content'])
 751         );
 752         $this->element('id', null, $entry['id']);
 753         $this->element('published', null, $entry['published']);
 754         $this->element('updated', null, $entry['updated']);
 755         $this->element('link', array('type' => 'text/html',
 756                                      'href' => $entry['link'],
 757                                      'rel' => 'alternate'));
 758         $this->element('link', array('type' => $entry['avatar-type'],
 759                                      'href' => $entry['avatar'],
 760                                      'rel' => 'image'));
 761         $this->elementStart('author');
 762
 763         $this->element('name', null, $entry['author-name']);
 764         $this->element('uri', null, $entry['author-uri']);
 765
 766         $this->elementEnd('author');
 767         $this->elementEnd('entry');
 768     }
 769
 770     function showXmlDirectMessage($dm)
 771     {
 772         $this->elementStart('direct_message');
 773         foreach($dm as $element => $value) {
 774             switch ($element) {
 775             case 'sender':
 776             case 'recipient':
 777                 $this->showTwitterXmlUser($value, $element);
 778                 break;
 779             case 'text':
 780                 $this->element($element, null, common_xml_safe_str($value));
 781                 break;
 782             default:
 783                 $this->element($element, null, $value);
 784                 break;
 785             }
 786         }
 787         $this->elementEnd('direct_message');
 788     }
 789
 790     function directMessageArray($message)
 791     {
 792         $dmsg = array();
 793
 794         $from_profile = $message->getFrom();
 795         $to_profile = $message->getTo();
 796
 797         $dmsg['id'] = $message->id;
 798         $dmsg['sender_id'] = $message->from_profile;
 799         $dmsg['text'] = trim($message->content);
 800         $dmsg['recipient_id'] = $message->to_profile;
 801         $dmsg['created_at'] = $this->dateTwitter($message->created);
 802         $dmsg['sender_screen_name'] = $from_profile->nickname;
 803         $dmsg['recipient_screen_name'] = $to_profile->nickname;
 804         $dmsg['sender'] = $this->twitterUserArray($from_profile, false);
 805         $dmsg['recipient'] = $this->twitterUserArray($to_profile, false);
 806
 807         return $dmsg;
 808     }
 809
 810     function rssDirectMessageArray($message)
 811     {
 812         $entry = array();
 813
 814         $from = $message->getFrom();
 815
 816         $entry['title'] = sprintf('Message from %1$s to %2$s',
 817             $from->nickname, $message->getTo()->nickname);
 818
 819         $entry['content'] = common_xml_safe_str($message->rendered);
 820         $entry['link'] = common_local_url('showmessage', array('message' => $message->id));
 821         $entry['published'] = common_date_iso8601($message->created);
 822
 823         $taguribase = TagURI::base();
 824
 825         $entry['id'] = "tag:$taguribase:$entry[link]";
 826         $entry['updated'] = $entry['published'];
 827
 828         $entry['author-name'] = $from->getBestName();
 829         $entry['author-uri'] = $from->homepage;
 830
 831         $avatar = $from->getAvatar(AVATAR_STREAM_SIZE);
 832
 833         $entry['avatar']      = (!empty($avatar)) ? $avatar->url : Avatar::defaultImage(AVATAR_STREAM_SIZE);
 834         $entry['avatar-type'] = (!empty($avatar)) ? $avatar->mediatype : 'image/png';
 835
 836         // RSS item specific
 837
 838         $entry['description'] = $entry['content'];
 839         $entry['pubDate'] = common_date_rfc2822($message->created);
 840         $entry['guid'] = $entry['link'];
 841
 842         return $entry;
 843     }
 844
 845     function showSingleXmlDirectMessage($message)
 846     {
 847         $this->initDocument('xml');
 848         $dmsg = $this->directMessageArray($message);
 849         $this->showXmlDirectMessage($dmsg);
 850         $this->endDocument('xml');
 851     }
 852
 853     function showSingleJsonDirectMessage($message)
 854     {
 855         $this->initDocument('json');
 856         $dmsg = $this->directMessageArray($message);
 857         $this->showJsonObjects($dmsg);
 858         $this->endDocument('json');
 859     }
 860
 861     function showAtomGroups($group, $title, $id, $link, $subtitle=null, $selfuri=null)
 862     {
 863
 864         $this->initDocument('atom');
 865
 866         $this->element('title', null, common_xml_safe_str($title));
 867         $this->element('id', null, $id);
 868         $this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null);
 869
 870         if (!is_null($selfuri)) {
 871             $this->element('link', array('href' => $selfuri,
 872                 'rel' => 'self', 'type' => 'application/atom+xml'), null);
 873         }
 874
 875         $this->element('updated', null, common_date_iso8601('now'));
 876         $this->element('subtitle', null, common_xml_safe_str($subtitle));
 877
 878         if (is_array($group)) {
 879             foreach ($group as $g) {
 880                 $this->raw($g->asAtomEntry());
 881             }
 882         } else {
 883             while ($group->fetch()) {
 884                 $this->raw($group->asAtomEntry());
 885             }
 886         }
 887
 888         $this->endDocument('atom');
 889
 890     }
 891
 892     function showJsonTimeline($notice)
 893     {
 894
 895         $this->initDocument('json');
 896
 897         $statuses = array();
 898
 899         if (is_array($notice)) {
 900             foreach ($notice as $n) {
 901                 $twitter_status = $this->twitterStatusArray($n);
 902                 array_push($statuses, $twitter_status);
 903             }
 904         } else {
 905             while ($notice->fetch()) {
 906                 $twitter_status = $this->twitterStatusArray($notice);
 907                 array_push($statuses, $twitter_status);
 908             }
 909         }
 910
 911         $this->showJsonObjects($statuses);
 912
 913         $this->endDocument('json');
 914     }
 915
 916     function showJsonGroups($group)
 917     {
 918
 919         $this->initDocument('json');
 920
 921         $groups = array();
 922
 923         if (is_array($group)) {
 924             foreach ($group as $g) {
 925                 $twitter_group = $this->twitterGroupArray($g);
 926                 array_push($groups, $twitter_group);
 927             }
 928         } else {
 929             while ($group->fetch()) {
 930                 $twitter_group = $this->twitterGroupArray($group);
 931                 array_push($groups, $twitter_group);
 932             }
 933         }
 934
 935         $this->showJsonObjects($groups);
 936
 937         $this->endDocument('json');
 938     }
 939
 940     function showXmlGroups($group)
 941     {
 942
 943         $this->initDocument('xml');
 944         $this->elementStart('groups', array('type' => 'array'));
 945
 946         if (is_array($group)) {
 947             foreach ($group as $g) {
 948                 $twitter_group = $this->twitterGroupArray($g);
 949                 $this->showTwitterXmlGroup($twitter_group);
 950             }
 951         } else {
 952             while ($group->fetch()) {
 953                 $twitter_group = $this->twitterGroupArray($group);
 954                 $this->showTwitterXmlGroup($twitter_group);
 955             }
 956         }
 957
 958         $this->elementEnd('groups');
 959         $this->endDocument('xml');
 960     }
 961
 962     function showTwitterXmlUsers($user)
 963     {
 964
 965         $this->initDocument('xml');
 966         $this->elementStart('users', array('type' => 'array'));
 967
 968         if (is_array($user)) {
 969             foreach ($user as $u) {
 970                 $twitter_user = $this->twitterUserArray($u);
 971                 $this->showTwitterXmlUser($twitter_user);
 972             }
 973         } else {
 974             while ($user->fetch()) {
 975                 $twitter_user = $this->twitterUserArray($user);
 976                 $this->showTwitterXmlUser($twitter_user);
 977             }
 978         }
 979
 980         $this->elementEnd('users');
 981         $this->endDocument('xml');
 982     }
 983
 984     function showJsonUsers($user)
 985     {
 986
 987         $this->initDocument('json');
 988
 989         $users = array();
 990
 991         if (is_array($user)) {
 992             foreach ($user as $u) {
 993                 $twitter_user = $this->twitterUserArray($u);
 994                 array_push($users, $twitter_user);
 995             }
 996         } else {
 997             while ($user->fetch()) {
 998                 $twitter_user = $this->twitterUserArray($user);
 999                 array_push($users, $twitter_user);
1000             }
1001         }
1002
1003         $this->showJsonObjects($users);
1004
1005         $this->endDocument('json');
1006     }
1007
1008     function showSingleJsonGroup($group)
1009     {
1010         $this->initDocument('json');
1011         $twitter_group = $this->twitterGroupArray($group);
1012         $this->showJsonObjects($twitter_group);
1013         $this->endDocument('json');
1014     }
1015
1016     function showSingleXmlGroup($group)
1017     {
1018         $this->initDocument('xml');
1019         $twitter_group = $this->twitterGroupArray($group);
1020         $this->showTwitterXmlGroup($twitter_group);
1021         $this->endDocument('xml');
1022     }
1023
1024     function dateTwitter($dt)
1025     {
1026         $dateStr = date('d F Y H:i:s', strtotime($dt));
1027         $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1028         $d->setTimezone(new DateTimeZone(common_timezone()));
1029         return $d->format('D M d H:i:s O Y');
1030     }
1031
1032     function initDocument($type='xml')
1033     {
1034         switch ($type) {
1035         case 'xml':
1036             header('Content-Type: application/xml; charset=utf-8');
1037             $this->startXML();
1038             break;
1039         case 'json':
1040             header('Content-Type: application/json; charset=utf-8');
1041
1042             // Check for JSONP callback
1043             $callback = $this->arg('callback');
1044             if ($callback) {
1045                 print $callback . '(';
1046             }
1047             break;
1048         case 'rss':
1049             header("Content-Type: application/rss+xml; charset=utf-8");
1050             $this->initTwitterRss();
1051             break;
1052         case 'atom':
1053             header('Content-Type: application/atom+xml; charset=utf-8');
1054             $this->initTwitterAtom();
1055             break;
1056         default:
1057             $this->clientError(_('Not a supported data format.'));
1058             break;
1059         }
1060
1061         return;
1062     }
1063
1064     function endDocument($type='xml')
1065     {
1066         switch ($type) {
1067         case 'xml':
1068             $this->endXML();
1069             break;
1070         case 'json':
1071
1072             // Check for JSONP callback
1073             $callback = $this->arg('callback');
1074             if ($callback) {
1075                 print ')';
1076             }
1077             break;
1078         case 'rss':
1079             $this->endTwitterRss();
1080             break;
1081         case 'atom':
1082             $this->endTwitterRss();
1083             break;
1084         default:
1085             $this->clientError(_('Not a supported data format.'));
1086             break;
1087         }
1088         return;
1089     }
1090
1091     function clientError($msg, $code = 400, $format = 'xml')
1092     {
1093         $action = $this->trimmed('action');
1094
1095         common_debug("User error '$code' on '$action': $msg", __FILE__);
1096
1097         if (!array_key_exists($code, ClientErrorAction::$status)) {
1098             $code = 400;
1099         }
1100
1101         $status_string = ClientErrorAction::$status[$code];
1102
1103         header('HTTP/1.1 '.$code.' '.$status_string);
1104
1105         if ($format == 'xml') {
1106             $this->initDocument('xml');
1107             $this->elementStart('hash');
1108             $this->element('error', null, $msg);
1109             $this->element('request', null, $_SERVER['REQUEST_URI']);
1110             $this->elementEnd('hash');
1111             $this->endDocument('xml');
1112         } elseif ($format == 'json'){
1113             $this->initDocument('json');
1114             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1115             print(json_encode($error_array));
1116             $this->endDocument('json');
1117         } else {
1118
1119             // If user didn't request a useful format, throw a regular client error
1120             throw new ClientException($msg, $code);
1121         }
1122     }
1123
1124     function serverError($msg, $code = 500, $content_type = 'xml')
1125     {
1126         $action = $this->trimmed('action');
1127
1128         common_debug("Server error '$code' on '$action': $msg", __FILE__);
1129
1130         if (!array_key_exists($code, ServerErrorAction::$status)) {
1131             $code = 400;
1132         }
1133
1134         $status_string = ServerErrorAction::$status[$code];
1135
1136         header('HTTP/1.1 '.$code.' '.$status_string);
1137
1138         if ($content_type == 'xml') {
1139             $this->initDocument('xml');
1140             $this->elementStart('hash');
1141             $this->element('error', null, $msg);
1142             $this->element('request', null, $_SERVER['REQUEST_URI']);
1143             $this->elementEnd('hash');
1144             $this->endDocument('xml');
1145         } else {
1146             $this->initDocument('json');
1147             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1148             print(json_encode($error_array));
1149             $this->endDocument('json');
1150         }
1151     }
1152
1153     function initTwitterRss()
1154     {
1155         $this->startXML();
1156         $this->elementStart(
1157             'rss',
1158             array(
1159                 'version'      => '2.0',
1160                 'xmlns:atom'   => 'http://www.w3.org/2005/Atom',
1161                 'xmlns:georss' => 'http://www.georss.org/georss'
1162             )
1163         );
1164         $this->elementStart('channel');
1165         Event::handle('StartApiRss', array($this));
1166     }
1167
1168     function endTwitterRss()
1169     {
1170         $this->elementEnd('channel');
1171         $this->elementEnd('rss');
1172         $this->endXML();
1173     }
1174
1175     function initTwitterAtom()
1176     {
1177         $this->startXML();
1178         // FIXME: don't hardcode the language here!
1179         $this->elementStart('feed', array('xmlns' => 'http://www.w3.org/2005/Atom',
1180                                           'xml:lang' => 'en-US',
1181                                           'xmlns:thr' => 'http://purl.org/syndication/thread/1.0'));
1182     }
1183
1184     function endTwitterAtom()
1185     {
1186         $this->elementEnd('feed');
1187         $this->endXML();
1188     }
1189
1190     function showProfile($profile, $content_type='xml', $notice=null, $includeStatuses=true)
1191     {
1192         $profile_array = $this->twitterUserArray($profile, $includeStatuses);
1193         switch ($content_type) {
1194         case 'xml':
1195             $this->showTwitterXmlUser($profile_array);
1196             break;
1197         case 'json':
1198             $this->showJsonObjects($profile_array);
1199             break;
1200         default:
1201             $this->clientError(_('Not a supported data format.'));
1202             return;
1203         }
1204         return;
1205     }
1206
1207     function getTargetUser($id)
1208     {
1209         if (empty($id)) {
1210
1211             // Twitter supports these other ways of passing the user ID
1212             if (is_numeric($this->arg('id'))) {
1213                 return User::staticGet($this->arg('id'));
1214             } else if ($this->arg('id')) {
1215                 $nickname = common_canonical_nickname($this->arg('id'));
1216                 return User::staticGet('nickname', $nickname);
1217             } else if ($this->arg('user_id')) {
1218                 // This is to ensure that a non-numeric user_id still
1219                 // overrides screen_name even if it doesn't get used
1220                 if (is_numeric($this->arg('user_id'))) {
1221                     return User::staticGet('id', $this->arg('user_id'));
1222                 }
1223             } else if ($this->arg('screen_name')) {
1224                 $nickname = common_canonical_nickname($this->arg('screen_name'));
1225                 return User::staticGet('nickname', $nickname);
1226             } else {
1227                 // Fall back to trying the currently authenticated user
1228                 return $this->auth_user;
1229             }
1230
1231         } else if (is_numeric($id)) {
1232             return User::staticGet($id);
1233         } else {
1234             $nickname = common_canonical_nickname($id);
1235             return User::staticGet('nickname', $nickname);
1236         }
1237     }
1238
1239     function getTargetGroup($id)
1240     {
1241         if (empty($id)) {
1242             if (is_numeric($this->arg('id'))) {
1243                 return User_group::staticGet($this->arg('id'));
1244             } else if ($this->arg('id')) {
1245                 $nickname = common_canonical_nickname($this->arg('id'));
1246                 $local = Local_group::staticGet('nickname', $nickname);
1247                 if (empty($local)) {
1248                     return null;
1249                 } else {
1250                     return User_group::staticGet('id', $local->id);
1251                 }
1252             } else if ($this->arg('group_id')) {
1253                 // This is to ensure that a non-numeric user_id still
1254                 // overrides screen_name even if it doesn't get used
1255                 if (is_numeric($this->arg('group_id'))) {
1256                     return User_group::staticGet('id', $this->arg('group_id'));
1257                 }
1258             } else if ($this->arg('group_name')) {
1259                 $nickname = common_canonical_nickname($this->arg('group_name'));
1260                 $local = Local_group::staticGet('nickname', $nickname);
1261                 if (empty($local)) {
1262                     return null;
1263                 } else {
1264                     return User_group::staticGet('id', $local->id);
1265                 }
1266             }
1267
1268         } else if (is_numeric($id)) {
1269             return User_group::staticGet($id);
1270         } else {
1271             $nickname = common_canonical_nickname($id);
1272             $local = Local_group::staticGet('nickname', $nickname);
1273             if (empty($local)) {
1274                 return null;
1275             } else {
1276                 return User_group::staticGet('id', $local->group_id);
1277             }
1278         }
1279     }
1280
1281     function sourceLink($source)
1282     {
1283         $source_name = _($source);
1284         switch ($source) {
1285         case 'web':
1286         case 'xmpp':
1287         case 'mail':
1288         case 'omb':
1289         case 'api':
1290             break;
1291         default:
1292
1293             $name = null;
1294             $url  = null;
1295
1296             $ns = Notice_source::staticGet($source);
1297
1298             if ($ns) {
1299                 $name = $ns->name;
1300                 $url  = $ns->url;
1301             } else {
1302                 $app = Oauth_application::staticGet('name', $source);
1303                 if ($app) {
1304                     $name = $app->name;
1305                     $url  = $app->source_url;
1306                 }
1307             }
1308
1309             if (!empty($name) && !empty($url)) {
1310                 $source_name = '<a href="' . $url . '">' . $name . '</a>';
1311             }
1312
1313             break;
1314         }
1315         return $source_name;
1316     }
1317
1318     /**
1319      * Returns query argument or default value if not found. Certain
1320      * parameters used throughout the API are lightly scrubbed and
1321      * bounds checked.  This overrides Action::arg().
1322      *
1323      * @param string $key requested argument
1324      * @param string $def default value to return if $key is not provided
1325      *
1326      * @return var $var
1327      */
1328     function arg($key, $def=null)
1329     {
1330
1331         // XXX: Do even more input validation/scrubbing?
1332
1333         if (array_key_exists($key, $this->args)) {
1334             switch($key) {
1335             case 'page':
1336                 $page = (int)$this->args['page'];
1337                 return ($page < 1) ? 1 : $page;
1338             case 'count':
1339                 $count = (int)$this->args['count'];
1340                 if ($count < 1) {
1341                     return 20;
1342                 } elseif ($count > 200) {
1343                     return 200;
1344                 } else {
1345                     return $count;
1346                 }
1347             case 'since_id':
1348                 $since_id = (int)$this->args['since_id'];
1349                 return ($since_id < 1) ? 0 : $since_id;
1350             case 'max_id':
1351                 $max_id = (int)$this->args['max_id'];
1352                 return ($max_id < 1) ? 0 : $max_id;
1353             default:
1354                 return parent::arg($key, $def);
1355             }
1356         } else {
1357             return $def;
1358         }
1359     }
1360
1361     function getSelfUri($action, $aargs)
1362     {
1363         parse_str($_SERVER['QUERY_STRING'], $params);
1364         $pstring = '';
1365         if (!empty($params)) {
1366             unset($params['p']);
1367             $pstring = http_build_query($params);
1368         }
1369
1370         $uri = common_local_url($action, $aargs);
1371
1372         if (!empty($pstring)) {
1373             $uri .= '?' . $pstring;
1374         }
1375
1376         return $uri;
1377     }
1378
1379 }