lib/twitterapi.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 if (!defined('STATUSNET') && !defined('LACONICA')) {
  21     exit(1);
  22 }
  23
  24 class TwitterapiAction extends Action
  25 {
  26
  27     var $auth_user;
  28
  29     /**
  30      * Initialization.
  31      *
  32      * @param array $args Web and URL arguments
  33      *
  34      * @return boolean false if user doesn't exist
  35      */
  36
  37     function prepare($args)
  38     {
  39         parent::prepare($args);
  40         return true;
  41     }
  42
  43     /**
  44      * Handle a request
  45      *
  46      * @param array $args Arguments from $_REQUEST
  47      *
  48      * @return void
  49      */
  50
  51     function handle($args)
  52     {
  53         parent::handle($args);
  54     }
  55
  56     /**
  57      * Overrides XMLOutputter::element to write booleans as strings (true|false).
  58      * See that method's documentation for more info.
  59      *
  60      * @param string $tag     Element type or tagname
  61      * @param array  $attrs   Array of element attributes, as
  62      *                        key-value pairs
  63      * @param string $content string content of the element
  64      *
  65      * @return void
  66      */
  67     function element($tag, $attrs=null, $content=null)
  68     {
  69         if (is_bool($content)) {
  70             $content = ($content ? 'true' : 'false');
  71         }
  72
  73         return parent::element($tag, $attrs, $content);
  74     }
  75
  76     function twitter_user_array($profile, $get_notice=false)
  77     {
  78         $twitter_user = array();
  79
  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;
  85
  86         $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
  87         $twitter_user['profile_image_url'] = ($avatar) ? $avatar->displayUrl() :
  88             Avatar::defaultImage(AVATAR_STREAM_SIZE);
  89
  90         $twitter_user['url'] = ($profile->homepage) ? $profile->homepage : null;
  91         $twitter_user['protected'] = false; # not supported by StatusNet yet
  92         $twitter_user['followers_count'] = $profile->subscriberCount();
  93
  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'] = '';
 100
 101         $twitter_user['friends_count'] = $profile->subscriptionCount();
 102
 103         $twitter_user['created_at'] = $this->date_twitter($profile->created);
 104
 105         $twitter_user['favourites_count'] = $profile->faveCount(); // British spelling!
 106
 107         // Need to pull up the user for some of this
 108         $user = User::staticGet($profile->id);
 109
 110         $timezone = 'UTC';
 111
 112         if ($user->timezone) {
 113             $timezone = $user->timezone;
 114         }
 115
 116         $t = new DateTime;
 117         $t->setTimezone(new DateTimeZone($timezone));
 118
 119         $twitter_user['utc_offset'] = $t->format('Z');
 120         $twitter_user['time_zone'] = $timezone;
 121
 122         // To be supported some day, perhaps
 123         $twitter_user['profile_background_image_url'] = '';
 124         $twitter_user['profile_background_tile'] = false;
 125
 126         $twitter_user['statuses_count'] = $profile->noticeCount();
 127
 128         // Is the requesting user following this user?
 129         $twitter_user['following'] = false;
 130         $twitter_user['notifications'] = false;
 131
 132         if (isset($apidata['user'])) {
 133
 134             $twitter_user['following'] = $apidata['user']->isSubscribed($profile);
 135
 136             // Notifications on?
 137             $sub = Subscription::pkeyGet(array('subscriber' =>
 138                 $apidata['user']->id, 'subscribed' => $profile->id));
 139
 140             if ($sub) {
 141                 $twitter_user['notifications'] = ($sub->jabber || $sub->sms);
 142             }
 143         }
 144
 145         if ($get_notice) {
 146             $notice = $profile->getCurrentNotice();
 147             if ($notice) {
 148                 # don't get user!
 149                 $twitter_user['status'] = $this->twitter_status_array($notice, false);
 150             }
 151         }
 152
 153         return $twitter_user;
 154     }
 155
 156     function twitter_status_array($notice, $include_user=true)
 157     {
 158         $profile = $notice->getProfile();
 159
 160         $twitter_status = array();
 161         $twitter_status['text'] = $notice->content;
 162         $twitter_status['truncated'] = false; # Not possible on StatusNet
 163         $twitter_status['created_at'] = $this->date_twitter($notice->created);
 164         $twitter_status['in_reply_to_status_id'] = ($notice->reply_to) ?
 165             intval($notice->reply_to) : null;
 166         $twitter_status['source'] = $this->source_link($notice->source);
 167         $twitter_status['id'] = intval($notice->id);
 168
 169         $replier_profile = null;
 170
 171         if ($notice->reply_to) {
 172             $reply = Notice::staticGet(intval($notice->reply_to));
 173             if ($reply) {
 174                 $replier_profile = $reply->getProfile();
 175             }
 176         }
 177
 178         $twitter_status['in_reply_to_user_id'] =
 179             ($replier_profile) ? intval($replier_profile->id) : null;
 180         $twitter_status['in_reply_to_screen_name'] =
 181             ($replier_profile) ? $replier_profile->nickname : null;
 182
 183         if (isset($this->auth_user)) {
 184             $twitter_status['favorited'] = $this->auth_user->hasFave($notice);
 185         } else {
 186             $twitter_status['favorited'] = false;
 187         }
 188
 189         // Enclosures
 190         $attachments = $notice->attachments();
 191
 192         if (!empty($attachments)) {
 193
 194             $twitter_status['attachments'] = array();
 195
 196             foreach ($attachments as $attachment) {
 197                 if ($attachment->isEnclosure()) {
 198                     $enclosure = array();
 199                     $enclosure['url'] = $attachment->url;
 200                     $enclosure['mimetype'] = $attachment->mimetype;
 201                     $enclosure['size'] = $attachment->size;
 202                     $twitter_status['attachments'][] = $enclosure;
 203                 }
 204             }
 205         }
 206
 207         if ($include_user) {
 208             # Don't get notice (recursive!)
 209             $twitter_user = $this->twitter_user_array($profile, false);
 210             $twitter_status['user'] = $twitter_user;
 211         }
 212
 213         return $twitter_status;
 214     }
 215
 216     function twitter_group_array($group)
 217     {
 218         $twitter_group=array();
 219         $twitter_group['id']=$group->id;
 220         $twitter_group['url']=$group->permalink();
 221         $twitter_group['nickname']=$group->nickname;
 222         $twitter_group['fullname']=$group->fullname;
 223         $twitter_group['homepage_url']=$group->homepage_url;
 224         $twitter_group['original_logo']=$group->original_logo;
 225         $twitter_group['homepage_logo']=$group->homepage_logo;
 226         $twitter_group['stream_logo']=$group->stream_logo;
 227         $twitter_group['mini_logo']=$group->mini_logo;
 228         $twitter_group['homepage']=$group->homepage;
 229         $twitter_group['description']=$group->description;
 230         $twitter_group['location']=$group->location;
 231         $twitter_group['created']=$this->date_twitter($group->created);
 232         $twitter_group['modified']=$this->date_twitter($group->modified);
 233         return $twitter_group;
 234     }
 235
 236     function twitter_rss_group_array($group)
 237     {
 238         $entry = array();
 239         $entry['content']=$group->description;
 240         $entry['title']=$group->nickname;
 241         $entry['link']=$group->permalink();
 242         $entry['published']=common_date_iso8601($group->created);
 243         $entry['updated']==common_date_iso8601($group->modified);
 244         $taguribase = common_config('integration', 'groupuri');
 245         $entry['id'] = "group:$groupuribase:$entry[link]";
 246
 247         $entry['description'] = $entry['content'];
 248         $entry['pubDate'] = common_date_rfc2822($group->created);
 249         $entry['guid'] = $entry['link'];
 250
 251         return $entry;
 252     }
 253
 254     function twitter_rss_entry_array($notice)
 255     {
 256         $profile = $notice->getProfile();
 257         $entry = array();
 258
 259         // We trim() to avoid extraneous whitespace in the output
 260
 261         $entry['content'] = common_xml_safe_str(trim($notice->rendered));
 262         $entry['title'] = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
 263         $entry['link'] = common_local_url('shownotice', array('notice' => $notice->id));
 264         $entry['published'] = common_date_iso8601($notice->created);
 265
 266         $taguribase = common_config('integration', 'taguri');
 267         $entry['id'] = "tag:$taguribase:$entry[link]";
 268
 269         $entry['updated'] = $entry['published'];
 270         $entry['author'] = $profile->getBestName();
 271
 272         // Enclosures
 273         $attachments = $notice->attachments();
 274         $enclosures = array();
 275
 276         foreach ($attachments as $attachment) {
 277             $enclosure_o=$attachment->getEnclosure();
 278             if ($enclosure_o) {
 279                  $enclosure = array();
 280                  $enclosure['url'] = $enclosure_o->url;
 281                  $enclosure['mimetype'] = $enclosure_o->mimetype;
 282                  $enclosure['size'] = $enclosure_o->size;
 283                  $enclosures[] = $enclosure;
 284             }
 285         }
 286
 287         if (!empty($enclosures)) {
 288             $entry['enclosures'] = $enclosures;
 289         }
 290
 291 /*
 292         // Enclosure
 293         $attachments = $notice->attachments();
 294         if($attachments){
 295             $entry['enclosures']=array();
 296             foreach($attachments as $attachment){
 297                 if ($attachment->isEnclosure()) {
 298                     $enclosure=array();
 299                     $enclosure['url']=$attachment->url;
 300                     $enclosure['mimetype']=$attachment->mimetype;
 301                     $enclosure['size']=$attachment->size;
 302                     $entry['enclosures'][]=$enclosure;
 303                 }
 304             }
 305         }
 306 */
 307
 308         // Tags/Categories
 309         $tag = new Notice_tag();
 310         $tag->notice_id = $notice->id;
 311         if ($tag->find()) {
 312             $entry['tags']=array();
 313             while ($tag->fetch()) {
 314                 $entry['tags'][]=$tag->tag;
 315             }
 316         }
 317         $tag->free();
 318
 319         // RSS Item specific
 320         $entry['description'] = $entry['content'];
 321         $entry['pubDate'] = common_date_rfc2822($notice->created);
 322         $entry['guid'] = $entry['link'];
 323
 324         return $entry;
 325     }
 326
 327     function twitter_rss_dmsg_array($message)
 328     {
 329
 330         $entry = array();
 331
 332         $entry['title'] = sprintf('Message from %s to %s',
 333             $message->getFrom()->nickname, $message->getTo()->nickname);
 334
 335         $entry['content'] = common_xml_safe_str(trim($message->content));
 336         $entry['link'] = common_local_url('showmessage', array('message' => $message->id));
 337         $entry['published'] = common_date_iso8601($message->created);
 338
 339         $taguribase = common_config('integration', 'taguri');
 340
 341         $entry['id'] = "tag:$taguribase,:$entry[link]";
 342         $entry['updated'] = $entry['published'];
 343         $entry['author'] = $message->getFrom()->getBestName();
 344
 345         # RSS Item specific
 346         $entry['description'] = $entry['content'];
 347         $entry['pubDate'] = common_date_rfc2822($message->created);
 348         $entry['guid'] = $entry['link'];
 349
 350         return $entry;
 351     }
 352
 353     function twitter_dmsg_array($message)
 354     {
 355         $twitter_dm = array();
 356
 357         $from_profile = $message->getFrom();
 358         $to_profile = $message->getTo();
 359
 360         $twitter_dm['id'] = $message->id;
 361         $twitter_dm['sender_id'] = $message->from_profile;
 362         $twitter_dm['text'] = trim($message->content);
 363         $twitter_dm['recipient_id'] = $message->to_profile;
 364         $twitter_dm['created_at'] = $this->date_twitter($message->created);
 365         $twitter_dm['sender_screen_name'] = $from_profile->nickname;
 366         $twitter_dm['recipient_screen_name'] = $to_profile->nickname;
 367         $twitter_dm['sender'] = $this->twitter_user_array($from_profile, false);
 368         $twitter_dm['recipient'] = $this->twitter_user_array($to_profile, false);
 369
 370         return $twitter_dm;
 371     }
 372
 373     function twitter_relationship_array($source, $target)
 374     {
 375         $relationship = array();
 376
 377         $relationship['source'] =
 378             $this->relationship_details_array($source, $target);
 379         $relationship['target'] =
 380             $this->relationship_details_array($target, $source);
 381
 382         return array('relationship' => $relationship);
 383     }
 384
 385     function relationship_details_array($source, $target)
 386     {
 387         $details = array();
 388
 389         $details['screen_name'] = $source->nickname;
 390         $details['followed_by'] = $target->isSubscribed($source);
 391         $details['following'] = $source->isSubscribed($target);
 392
 393         $notifications = false;
 394
 395         if ($source->isSubscribed($target)) {
 396
 397             $sub = Subscription::pkeyGet(array('subscriber' =>
 398                 $source->id, 'subscribed' => $target->id));
 399
 400             if (!empty($sub)) {
 401                 $notifications = ($sub->jabber || $sub->sms);
 402             }
 403         }
 404
 405         $details['notifications_enabled'] = $notifications;
 406         $details['blocking'] = $source->hasBlocked($target);
 407         $details['id'] = $source->id;
 408
 409         return $details;
 410     }
 411
 412     function show_twitter_xml_relationship($relationship)
 413     {
 414         $this->elementStart('relationship');
 415
 416         foreach($relationship as $element => $value) {
 417             if ($element == 'source' || $element == 'target') {
 418                 $this->elementStart($element);
 419                 $this->show_xml_relationship_details($value);
 420                 $this->elementEnd($element);
 421             }
 422         }
 423
 424         $this->elementEnd('relationship');
 425     }
 426
 427     function show_xml_relationship_details($details)
 428     {
 429         foreach($details as $element => $value) {
 430             $this->element($element, null, $value);
 431         }
 432     }
 433
 434     function show_twitter_xml_status($twitter_status)
 435     {
 436         $this->elementStart('status');
 437         foreach($twitter_status as $element => $value) {
 438             switch ($element) {
 439             case 'user':
 440                 $this->show_twitter_xml_user($twitter_status['user']);
 441                 break;
 442             case 'text':
 443                 $this->element($element, null, common_xml_safe_str($value));
 444                 break;
 445             case 'attachments':
 446                 $this->show_xml_attachments($twitter_status['attachments']);
 447                 break;
 448             default:
 449                 $this->element($element, null, $value);
 450             }
 451         }
 452         $this->elementEnd('status');
 453     }
 454
 455     function show_twitter_xml_group($twitter_group)
 456     {
 457         $this->elementStart('group');
 458         foreach($twitter_group as $element => $value) {
 459             $this->element($element, null, $value);
 460         }
 461         $this->elementEnd('group');
 462     }
 463
 464     function show_twitter_xml_user($twitter_user, $role='user')
 465     {
 466         $this->elementStart($role);
 467         foreach($twitter_user as $element => $value) {
 468             if ($element == 'status') {
 469                 $this->show_twitter_xml_status($twitter_user['status']);
 470             } else {
 471                 $this->element($element, null, $value);
 472             }
 473         }
 474         $this->elementEnd($role);
 475     }
 476
 477     function show_xml_attachments($attachments) {
 478         if (!empty($attachments)) {
 479             $this->elementStart('attachments', array('type' => 'array'));
 480             foreach ($attachments as $attachment) {
 481                 $attrs = array();
 482                 $attrs['url'] = $attachment['url'];
 483                 $attrs['mimetype'] = $attachment['mimetype'];
 484                 $attrs['size'] = $attachment['size'];
 485                 $this->element('enclosure', $attrs, '');
 486             }
 487             $this->elementEnd('attachments');
 488         }
 489     }
 490
 491     function show_twitter_rss_item($entry)
 492     {
 493         $this->elementStart('item');
 494         $this->element('title', null, $entry['title']);
 495         $this->element('description', null, $entry['description']);
 496         $this->element('pubDate', null, $entry['pubDate']);
 497         $this->element('guid', null, $entry['guid']);
 498         $this->element('link', null, $entry['link']);
 499
 500         # RSS only supports 1 enclosure per item
 501         if(array_key_exists('enclosures', $entry) and !empty($entry['enclosures'])){
 502             $enclosure = $entry['enclosures'][0];
 503             $this->element('enclosure', array('url'=>$enclosure['url'],'type'=>$enclosure['mimetype'],'length'=>$enclosure['size']), null);
 504         }
 505
 506         if(array_key_exists('tags', $entry)){
 507             foreach($entry['tags'] as $tag){
 508                 $this->element('category', null,$tag);
 509             }
 510         }
 511
 512         $this->elementEnd('item');
 513     }
 514
 515     function show_json_objects($objects)
 516     {
 517         print(json_encode($objects));
 518     }
 519
 520     function show_single_xml_status($notice)
 521     {
 522         $this->init_document('xml');
 523         $twitter_status = $this->twitter_status_array($notice);
 524         $this->show_twitter_xml_status($twitter_status);
 525         $this->end_document('xml');
 526     }
 527
 528     function show_single_json_status($notice)
 529     {
 530         $this->init_document('json');
 531         $status = $this->twitter_status_array($notice);
 532         $this->show_json_objects($status);
 533         $this->end_document('json');
 534     }
 535
 536     function show_single_xml_dmsg($message)
 537     {
 538         $this->init_document('xml');
 539         $dmsg = $this->twitter_dmsg_array($message);
 540         $this->show_twitter_xml_dmsg($dmsg);
 541         $this->end_document('xml');
 542     }
 543
 544     function show_single_json_dmsg($message)
 545     {
 546         $this->init_document('json');
 547         $dmsg = $this->twitter_dmsg_array($message);
 548         $this->show_json_objects($dmsg);
 549         $this->end_document('json');
 550     }
 551
 552     function show_twitter_xml_dmsg($twitter_dm)
 553     {
 554         $this->elementStart('direct_message');
 555         foreach($twitter_dm as $element => $value) {
 556             switch ($element) {
 557             case 'sender':
 558             case 'recipient':
 559                 $this->show_twitter_xml_user($value, $element);
 560                 break;
 561             case 'text':
 562                 $this->element($element, null, common_xml_safe_str($value));
 563                 break;
 564             default:
 565                 $this->element($element, null, $value);
 566             }
 567         }
 568         $this->elementEnd('direct_message');
 569     }
 570
 571     function show_xml_timeline($notice)
 572     {
 573
 574         $this->init_document('xml');
 575         $this->elementStart('statuses', array('type' => 'array'));
 576
 577         if (is_array($notice)) {
 578             foreach ($notice as $n) {
 579                 $twitter_status = $this->twitter_status_array($n);
 580                 $this->show_twitter_xml_status($twitter_status);
 581             }
 582         } else {
 583             while ($notice->fetch()) {
 584                 $twitter_status = $this->twitter_status_array($notice);
 585                 $this->show_twitter_xml_status($twitter_status);
 586             }
 587         }
 588
 589         $this->elementEnd('statuses');
 590         $this->end_document('xml');
 591     }
 592
 593     function show_rss_timeline($notice, $title, $link, $subtitle, $suplink=null)
 594     {
 595
 596         $this->init_document('rss');
 597
 598         $this->element('title', null, $title);
 599         $this->element('link', null, $link);
 600         if (!is_null($suplink)) {
 601             # For FriendFeed's SUP protocol
 602             $this->element('link', array('xmlns' => 'http://www.w3.org/2005/Atom',
 603                                          'rel' => 'http://api.friendfeed.com/2008/03#sup',
 604                                          'href' => $suplink,
 605                                          'type' => 'application/json'));
 606         }
 607         $this->element('description', null, $subtitle);
 608         $this->element('language', null, 'en-us');
 609         $this->element('ttl', null, '40');
 610
 611         if (is_array($notice)) {
 612             foreach ($notice as $n) {
 613                 $entry = $this->twitter_rss_entry_array($n);
 614                 $this->show_twitter_rss_item($entry);
 615             }
 616         } else {
 617             while ($notice->fetch()) {
 618                 $entry = $this->twitter_rss_entry_array($notice);
 619                 $this->show_twitter_rss_item($entry);
 620             }
 621         }
 622
 623         $this->end_twitter_rss();
 624     }
 625
 626     function show_atom_timeline($notice, $title, $id, $link, $subtitle=null, $suplink=null, $selfuri=null)
 627     {
 628
 629         $this->init_document('atom');
 630
 631         $this->element('title', null, $title);
 632         $this->element('id', null, $id);
 633         $this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null);
 634
 635         if (!is_null($suplink)) {
 636             # For FriendFeed's SUP protocol
 637             $this->element('link', array('rel' => 'http://api.friendfeed.com/2008/03#sup',
 638                                          'href' => $suplink,
 639                                          'type' => 'application/json'));
 640         }
 641
 642         if (!is_null($selfuri)) {
 643             $this->element('link', array('href' => $selfuri,
 644                 'rel' => 'self', 'type' => 'application/atom+xml'), null);
 645         }
 646
 647         $this->element('updated', null, common_date_iso8601('now'));
 648         $this->element('subtitle', null, $subtitle);
 649
 650         if (is_array($notice)) {
 651             foreach ($notice as $n) {
 652                 $this->raw($n->asAtomEntry());
 653             }
 654         } else {
 655             while ($notice->fetch()) {
 656                 $this->raw($notice->asAtomEntry());
 657             }
 658         }
 659
 660         $this->end_document('atom');
 661
 662     }
 663
 664     function show_rss_groups($group, $title, $link, $subtitle)
 665     {
 666
 667         $this->init_document('rss');
 668
 669         $this->element('title', null, $title);
 670         $this->element('link', null, $link);
 671         $this->element('description', null, $subtitle);
 672         $this->element('language', null, 'en-us');
 673         $this->element('ttl', null, '40');
 674
 675         if (is_array($group)) {
 676             foreach ($group as $g) {
 677                 $twitter_group = $this->twitter_rss_group_array($g);
 678                 $this->show_twitter_rss_item($twitter_group);
 679             }
 680         } else {
 681             while ($group->fetch()) {
 682                 $twitter_group = $this->twitter_rss_group_array($group);
 683                 $this->show_twitter_rss_item($twitter_group);
 684             }
 685         }
 686
 687         $this->end_twitter_rss();
 688     }
 689
 690     function show_atom_groups($group, $title, $id, $link, $subtitle=null, $selfuri=null)
 691     {
 692
 693         $this->init_document('atom');
 694
 695         $this->element('title', null, $title);
 696         $this->element('id', null, $id);
 697         $this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null);
 698
 699         if (!is_null($selfuri)) {
 700             $this->element('link', array('href' => $selfuri,
 701                 'rel' => 'self', 'type' => 'application/atom+xml'), null);
 702         }
 703
 704         $this->element('updated', null, common_date_iso8601('now'));
 705         $this->element('subtitle', null, $subtitle);
 706
 707         if (is_array($group)) {
 708             foreach ($group as $g) {
 709                 $this->raw($g->asAtomEntry());
 710             }
 711         } else {
 712             while ($group->fetch()) {
 713                 $this->raw($group->asAtomEntry());
 714             }
 715         }
 716
 717         $this->end_document('atom');
 718
 719     }
 720
 721     function show_json_timeline($notice)
 722     {
 723
 724         $this->init_document('json');
 725
 726         $statuses = array();
 727
 728         if (is_array($notice)) {
 729             foreach ($notice as $n) {
 730                 $twitter_status = $this->twitter_status_array($n);
 731                 array_push($statuses, $twitter_status);
 732             }
 733         } else {
 734             while ($notice->fetch()) {
 735                 $twitter_status = $this->twitter_status_array($notice);
 736                 array_push($statuses, $twitter_status);
 737             }
 738         }
 739
 740         $this->show_json_objects($statuses);
 741
 742         $this->end_document('json');
 743     }
 744
 745     function show_json_groups($group)
 746     {
 747
 748         $this->init_document('json');
 749
 750         $groups = array();
 751
 752         if (is_array($group)) {
 753             foreach ($group as $g) {
 754                 $twitter_group = $this->twitter_group_array($g);
 755                 array_push($groups, $twitter_group);
 756             }
 757         } else {
 758             while ($group->fetch()) {
 759                 $twitter_group = $this->twitter_group_array($group);
 760                 array_push($groups, $twitter_group);
 761             }
 762         }
 763
 764         $this->show_json_objects($groups);
 765
 766         $this->end_document('json');
 767     }
 768
 769     function show_xml_groups($group)
 770     {
 771
 772         $this->init_document('xml');
 773         $this->elementStart('groups', array('type' => 'array'));
 774
 775         if (is_array($group)) {
 776             foreach ($group as $g) {
 777                 $twitter_group = $this->twitter_group_array($g);
 778                 $this->show_twitter_xml_group($twitter_group);
 779             }
 780         } else {
 781             while ($group->fetch()) {
 782                 $twitter_group = $this->twitter_group_array($group);
 783                 $this->show_twitter_xml_group($twitter_group);
 784             }
 785         }
 786
 787         $this->elementEnd('groups');
 788         $this->end_document('xml');
 789     }
 790
 791     function show_twitter_xml_users($user)
 792     {
 793
 794         $this->init_document('xml');
 795         $this->elementStart('users', array('type' => 'array'));
 796
 797         if (is_array($user)) {
 798             foreach ($group as $g) {
 799                 $twitter_user = $this->twitter_user_array($g);
 800                 $this->show_twitter_xml_user($twitter_user,'user');
 801             }
 802         } else {
 803             while ($user->fetch()) {
 804                 $twitter_user = $this->twitter_user_array($user);
 805                 $this->show_twitter_xml_user($twitter_user);
 806             }
 807         }
 808
 809         $this->elementEnd('users');
 810         $this->end_document('xml');
 811     }
 812
 813     function show_json_users($user)
 814     {
 815
 816         $this->init_document('json');
 817
 818         $users = array();
 819
 820         if (is_array($user)) {
 821             foreach ($user as $u) {
 822                 $twitter_user = $this->twitter_user_array($u);
 823                 array_push($users, $twitter_user);
 824             }
 825         } else {
 826             while ($user->fetch()) {
 827                 $twitter_user = $this->twitter_user_array($user);
 828                 array_push($users, $twitter_user);
 829             }
 830         }
 831
 832         $this->show_json_objects($users);
 833
 834         $this->end_document('json');
 835     }
 836
 837     function show_single_json_group($group)
 838     {
 839         $this->init_document('json');
 840         $twitter_group = $this->twitter_group_array($group);
 841         $this->show_json_objects($twitter_group);
 842         $this->end_document('json');
 843     }
 844
 845     function show_single_xml_group($group)
 846     {
 847         $this->init_document('xml');
 848         $twitter_group = $this->twitter_group_array($group);
 849         $this->show_twitter_xml_group($twitter_group);
 850         $this->end_document('xml');
 851     }
 852
 853     // Anyone know what date format this is?
 854     // Twitter's dates look like this: "Mon Jul 14 23:52:38 +0000 2008" -- Zach
 855     function date_twitter($dt)
 856     {
 857         $t = strtotime($dt);
 858         return date("D M d H:i:s O Y", $t);
 859     }
 860
 861     // XXX: Candidate for a general utility method somewhere?
 862     function count_subscriptions($profile)
 863     {
 864
 865         $count = 0;
 866         $sub = new Subscription();
 867         $sub->subscribed = $profile->id;
 868
 869         $count = $sub->find();
 870
 871         if ($count > 0) {
 872             return $count - 1;
 873         } else {
 874             return 0;
 875         }
 876     }
 877
 878     function init_document($type='xml')
 879     {
 880         switch ($type) {
 881         case 'xml':
 882             header('Content-Type: application/xml; charset=utf-8');
 883             $this->startXML();
 884             break;
 885         case 'json':
 886             header('Content-Type: application/json; charset=utf-8');
 887
 888             // Check for JSONP callback
 889             $callback = $this->arg('callback');
 890             if ($callback) {
 891                 print $callback . '(';
 892             }
 893             break;
 894         case 'rss':
 895             header("Content-Type: application/rss+xml; charset=utf-8");
 896             $this->init_twitter_rss();
 897             break;
 898         case 'atom':
 899             header('Content-Type: application/atom+xml; charset=utf-8');
 900             $this->init_twitter_atom();
 901             break;
 902         default:
 903             $this->clientError(_('Not a supported data format.'));
 904             break;
 905         }
 906
 907         return;
 908     }
 909
 910     function end_document($type='xml')
 911     {
 912         switch ($type) {
 913         case 'xml':
 914             $this->endXML();
 915             break;
 916         case 'json':
 917
 918             // Check for JSONP callback
 919             $callback = $this->arg('callback');
 920             if ($callback) {
 921                 print ')';
 922             }
 923             break;
 924         case 'rss':
 925             $this->end_twitter_rss();
 926             break;
 927         case 'atom':
 928             $this->end_twitter_rss();
 929             break;
 930         default:
 931             $this->clientError(_('Not a supported data format.'));
 932             break;
 933         }
 934         return;
 935     }
 936
 937     function clientError($msg, $code = 400, $format = 'xml')
 938     {
 939
 940         static $status = array(400 => 'Bad Request',
 941                                401 => 'Unauthorized',
 942                                402 => 'Payment Required',
 943                                403 => 'Forbidden',
 944                                404 => 'Not Found',
 945                                405 => 'Method Not Allowed',
 946                                406 => 'Not Acceptable',
 947                                407 => 'Proxy Authentication Required',
 948                                408 => 'Request Timeout',
 949                                409 => 'Conflict',
 950                                410 => 'Gone',
 951                                411 => 'Length Required',
 952                                412 => 'Precondition Failed',
 953                                413 => 'Request Entity Too Large',
 954                                414 => 'Request-URI Too Long',
 955                                415 => 'Unsupported Media Type',
 956                                416 => 'Requested Range Not Satisfiable',
 957                                417 => 'Expectation Failed');
 958
 959         $action = $this->trimmed('action');
 960
 961         common_debug("User error '$code' on '$action': $msg", __FILE__);
 962
 963         if (!array_key_exists($code, $status)) {
 964             $code = 400;
 965         }
 966
 967         $status_string = $status[$code];
 968         header('HTTP/1.1 '.$code.' '.$status_string);
 969
 970         if ($format == 'xml') {
 971             $this->init_document('xml');
 972             $this->elementStart('hash');
 973             $this->element('error', null, $msg);
 974             $this->element('request', null, $_SERVER['REQUEST_URI']);
 975             $this->elementEnd('hash');
 976             $this->end_document('xml');
 977         } elseif ($format == 'json'){
 978             $this->init_document('json');
 979             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
 980             print(json_encode($error_array));
 981             $this->end_document('json');
 982         } else {
 983
 984             // If user didn't request a useful format, throw a regular client error
 985             throw new ClientException($msg, $code);
 986         }
 987     }
 988
 989     function init_twitter_rss()
 990     {
 991         $this->startXML();
 992         $this->elementStart('rss', array('version' => '2.0', 'xmlns:atom'=>'http://www.w3.org/2005/Atom'));
 993         $this->elementStart('channel');
 994         Event::handle('StartApiRss', array($this));
 995     }
 996
 997     function end_twitter_rss()
 998     {
 999         $this->elementEnd('channel');
1000         $this->elementEnd('rss');
1001         $this->endXML();
1002     }
1003
1004     function init_twitter_atom()
1005     {
1006         $this->startXML();
1007         // FIXME: don't hardcode the language here!
1008         $this->elementStart('feed', array('xmlns' => 'http://www.w3.org/2005/Atom',
1009                                           'xml:lang' => 'en-US',
1010                                           'xmlns:thr' => 'http://purl.org/syndication/thread/1.0'));
1011         Event::handle('StartApiAtom', array($this));
1012     }
1013
1014     function end_twitter_atom()
1015     {
1016         $this->elementEnd('feed');
1017         $this->endXML();
1018     }
1019
1020     function show_profile($profile, $content_type='xml', $notice=null, $includeStatuses=true)
1021     {
1022         $profile_array = $this->twitter_user_array($profile, $includeStatuses);
1023         switch ($content_type) {
1024         case 'xml':
1025             $this->show_twitter_xml_user($profile_array);
1026             break;
1027         case 'json':
1028             $this->show_json_objects($profile_array);
1029             break;
1030         default:
1031             $this->clientError(_('Not a supported data format.'));
1032             return;
1033         }
1034         return;
1035     }
1036
1037     function get_user($id, $apidata=null)
1038     {
1039         if (empty($id)) {
1040
1041             // Twitter supports these other ways of passing the user ID
1042             if (is_numeric($this->arg('id'))) {
1043                 return User::staticGet($this->arg('id'));
1044             } else if ($this->arg('id')) {
1045                 $nickname = common_canonical_nickname($this->arg('id'));
1046                 return User::staticGet('nickname', $nickname);
1047             } else if ($this->arg('user_id')) {
1048                 // This is to ensure that a non-numeric user_id still
1049                 // overrides screen_name even if it doesn't get used
1050                 if (is_numeric($this->arg('user_id'))) {
1051                     return User::staticGet('id', $this->arg('user_id'));
1052                 }
1053             } else if ($this->arg('screen_name')) {
1054                 $nickname = common_canonical_nickname($this->arg('screen_name'));
1055                 return User::staticGet('nickname', $nickname);
1056             } else {
1057                 // Fall back to trying the currently authenticated user
1058                 return $apidata['user'];
1059             }
1060
1061         } else if (is_numeric($id)) {
1062             return User::staticGet($id);
1063         } else {
1064             $nickname = common_canonical_nickname($id);
1065             return User::staticGet('nickname', $nickname);
1066         }
1067     }
1068
1069     function getTargetUser($id)
1070     {
1071         if (empty($id)) {
1072
1073             // Twitter supports these other ways of passing the user ID
1074             if (is_numeric($this->arg('id'))) {
1075                 return User::staticGet($this->arg('id'));
1076             } else if ($this->arg('id')) {
1077                 $nickname = common_canonical_nickname($this->arg('id'));
1078                 return User::staticGet('nickname', $nickname);
1079             } else if ($this->arg('user_id')) {
1080                 // This is to ensure that a non-numeric user_id still
1081                 // overrides screen_name even if it doesn't get used
1082                 if (is_numeric($this->arg('user_id'))) {
1083                     return User::staticGet('id', $this->arg('user_id'));
1084                 }
1085             } else if ($this->arg('screen_name')) {
1086                 $nickname = common_canonical_nickname($this->arg('screen_name'));
1087                 return User::staticGet('nickname', $nickname);
1088             } else {
1089                 // Fall back to trying the currently authenticated user
1090                 return $this->auth_user;
1091             }
1092
1093         } else if (is_numeric($id)) {
1094             return User::staticGet($id);
1095         } else {
1096             $nickname = common_canonical_nickname($id);
1097             return User::staticGet('nickname', $nickname);
1098         }
1099     }
1100
1101     function get_group($id, $apidata=null)
1102     {
1103         if (empty($id)) {
1104
1105             if (is_numeric($this->arg('id'))) {
1106                 return User_group::staticGet($this->arg('id'));
1107             } else if ($this->arg('id')) {
1108                 $nickname = common_canonical_nickname($this->arg('id'));
1109                 return User_group::staticGet('nickname', $nickname);
1110             } else if ($this->arg('group_id')) {
1111                 // This is to ensure that a non-numeric user_id still
1112                 // overrides screen_name even if it doesn't get used
1113                 if (is_numeric($this->arg('group_id'))) {
1114                     return User_group::staticGet('id', $this->arg('group_id'));
1115                 }
1116             } else if ($this->arg('group_name')) {
1117                 $nickname = common_canonical_nickname($this->arg('group_name'));
1118                 return User_group::staticGet('nickname', $nickname);
1119             }
1120
1121         } else if (is_numeric($id)) {
1122             return User_group::staticGet($id);
1123         } else {
1124             $nickname = common_canonical_nickname($id);
1125             return User_group::staticGet('nickname', $nickname);
1126         }
1127     }
1128
1129     function get_profile($id)
1130     {
1131         if (is_numeric($id)) {
1132             return Profile::staticGet($id);
1133         } else {
1134             $user = User::staticGet('nickname', $id);
1135             if ($user) {
1136                 return $user->getProfile();
1137             } else {
1138                 return null;
1139             }
1140         }
1141     }
1142
1143     function source_link($source)
1144     {
1145         $source_name = _($source);
1146         switch ($source) {
1147         case 'web':
1148         case 'xmpp':
1149         case 'mail':
1150         case 'omb':
1151         case 'api':
1152             break;
1153         default:
1154             $ns = Notice_source::staticGet($source);
1155             if ($ns) {
1156                 $source_name = '<a href="' . $ns->url . '">' . $ns->name . '</a>';
1157             }
1158             break;
1159         }
1160         return $source_name;
1161     }
1162
1163     /**
1164      * Returns query argument or default value if not found. Certain
1165      * parameters used throughout the API are lightly scrubbed and
1166      * bounds checked.  This overrides Action::arg().
1167      *
1168      * @param string $key requested argument
1169      * @param string $def default value to return if $key is not provided
1170      *
1171      * @return var $var
1172      */
1173     function arg($key, $def=null)
1174     {
1175
1176         // XXX: Do even more input validation/scrubbing?
1177
1178         if (array_key_exists($key, $this->args)) {
1179             switch($key) {
1180             case 'page':
1181                 $page = (int)$this->args['page'];
1182                 return ($page < 1) ? 1 : $page;
1183             case 'count':
1184                 $count = (int)$this->args['count'];
1185                 if ($count < 1) {
1186                     return 20;
1187                 } elseif ($count > 200) {
1188                     return 200;
1189                 } else {
1190                     return $count;
1191                 }
1192             case 'since_id':
1193                 $since_id = (int)$this->args['since_id'];
1194                 return ($since_id < 1) ? 0 : $since_id;
1195             case 'max_id':
1196                 $max_id = (int)$this->args['max_id'];
1197                 return ($max_id < 1) ? 0 : $max_id;
1198             case 'since':
1199                 return strtotime($this->args['since']);
1200             default:
1201                 return parent::arg($key, $def);
1202             }
1203         } else {
1204             return $def;
1205         }
1206     }
1207
1208     function checkBasicAuthUser()
1209     {
1210         $this->basicAuthProcessHeader();
1211
1212         if (!isset($this->auth_user)) {
1213             header('WWW-Authenticate: Basic realm="StatusNet API"');
1214
1215             // show error if the user clicks 'cancel'
1216
1217             $this->showBasicAuthError();
1218             return false;
1219
1220         } else {
1221             $nickname = $this->auth_user;
1222             $password = $this->auth_pw;
1223             $this->auth_user = common_check_user($nickname, $password);
1224
1225             if (empty($this->auth_user)) {
1226
1227                 // basic authentication failed
1228
1229                 list($proxy, $ip) = common_client_ip();
1230                 common_log(LOG_WARNING,
1231                     "Failed API auth attempt, nickname = $nickname, proxy = $proxy, ip = $ip.");
1232                 $this->showBasicAuthError();
1233                 return false;
1234             }
1235         }
1236         return true;
1237     }
1238
1239     function basicAuthProcessHeader()
1240     {
1241         if (isset($_SERVER['AUTHORIZATION']) || isset($_SERVER['HTTP_AUTHORIZATION'])) {
1242             $authorization_header = isset($_SERVER['HTTP_AUTHORIZATION'])? $_SERVER['HTTP_AUTHORIZATION'] : $_SERVER['AUTHORIZATION'];
1243         }
1244
1245         if (isset($_SERVER['PHP_AUTH_USER'])) {
1246             $this->auth_user = $_SERVER['PHP_AUTH_USER'];
1247             $this->auth_pw = $_SERVER['PHP_AUTH_PW'];
1248         } elseif (isset($authorization_header) && strstr(substr($authorization_header, 0, 5), 'Basic')) {
1249             // decode the HTTP_AUTHORIZATION header on php-cgi server self
1250             // on fcgid server the header name is AUTHORIZATION
1251
1252             $auth_hash = base64_decode(substr($authorization_header, 6));
1253             list($this->auth_user, $this->auth_pw) = explode(':', $auth_hash);
1254
1255             // set all to null on a empty basic auth request
1256             if ($this->auth_user == "") {
1257                 $this->auth_user = null;
1258                 $this->auth_pw = null;
1259             }
1260         } else {
1261             $this->auth_user = null;
1262             $this->auth_pw = null;
1263         }
1264     }
1265
1266     function showBasicAuthError()
1267     {
1268         header('HTTP/1.1 401 Unauthorized');
1269         $msg = 'Could not authenticate you.';
1270
1271         if ($this->arg('format') == 'xml') {
1272             header('Content-Type: application/xml; charset=utf-8');
1273             $this->startXML();
1274             $this->elementStart('hash');
1275             $this->element('error', null, $msg);
1276             $this->element('request', null, $_SERVER['REQUEST_URI']);
1277             $this->elementEnd('hash');
1278             $this->endXML();
1279         } elseif ($this->arg('format') == 'json') {
1280             header('Content-Type: application/json; charset=utf-8');
1281             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1282             print(json_encode($error_array));
1283         } else {
1284             header('Content-type: text/plain');
1285             print "$msg\n";
1286         }
1287     }
1288
1289 }