lib/twitterapi.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, Controlez-Vous, 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('LACONICA')) { exit(1); }
  21
  22 class TwitterapiAction extends Action {
  23
  24         function handle($args) {
  25                 parent::handle($args);
  26         }
  27
  28         function twitter_user_array($profile, $get_notice=false) {
  29
  30                 $twitter_user = array();
  31
  32                 $twitter_user['name'] = $profile->getBestName();
  33                 $twitter_user['followers_count'] = $this->count_subscriptions($profile);
  34                 $twitter_user['screen_name'] = $profile->nickname;
  35                 $twitter_user['description'] = ($profile->bio) ? $profile->bio : NULL;
  36                 $twitter_user['location'] = ($profile->location) ? $profile->location : NULL;
  37                 $twitter_user['id'] = intval($profile->id);
  38
  39                 $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
  40
  41                 $twitter_user['profile_image_url'] = ($avatar) ? common_avatar_display_url($avatar) : common_default_avatar(AVATAR_STREAM_SIZE);
  42                 $twitter_user['protected'] = 'false'; # not supported by Laconica yet
  43                 $twitter_user['url'] = ($profile->homepage) ? $profile->homepage : NULL;
  44
  45                 if ($get_notice) {
  46                         $notice = $profile->getCurrentNotice();
  47                         if ($notice) {
  48                                 # don't get user!
  49                                 $twitter_user['status'] = $this->twitter_status_array($notice, false);
  50                         }
  51                 }
  52
  53                 return $twitter_user;
  54         }
  55
  56         function twitter_status_array($notice, $get_user=true) {
  57
  58                 $twitter_status = array();
  59
  60                 $twitter_status['text'] = $notice->content;
  61                 $twitter_status['truncated'] = 'false'; # Not possible on Laconica
  62                 $twitter_status['created_at'] = $this->date_twitter($notice->created);
  63                 $twitter_status['in_reply_to_status_id'] = ($notice->reply_to) ? intval($notice->reply_to) : NULL;
  64                 $twitter_status['source'] = $this->source_link($notice->source);
  65                 $twitter_status['id'] = intval($notice->id);
  66                 $twitter_status['in_reply_to_user_id'] = ($notice->reply_to) ? $this->replier_by_reply(intval($notice->reply_to)) : NULL;
  67                 $twitter_status['favorited'] = NULL; # XXX: Not implemented on Laconica yet.
  68
  69                 if ($get_user) {
  70                         $profile = $notice->getProfile();
  71                         # Don't get notice (recursive!)
  72                         $twitter_user = $this->twitter_user_array($profile, false);
  73                         $twitter_status['user'] = $twitter_user;
  74                 }
  75
  76                 return $twitter_status;
  77         }
  78
  79         function twitter_rss_entry_array($notice) {
  80
  81                 $profile = $notice->getProfile();
  82
  83                 $server = common_config('site', 'server');
  84                 $entry = array();
  85
  86                 $entry['content'] = $profile->nickname . ': ' . $notice->content;
  87                 $entry['title'] = $entry['content'];
  88                 $entry['link'] = common_local_url('shownotice', array('notice' => $notice->id));
  89                 $entry['published'] = common_date_iso8601($notice->created);
  90                 $entry['id'] = "tag:$server,2008:$entry[link]";
  91                 $entry['updated'] = $entry['published'];
  92
  93                 # RSS Item specific
  94                 $entry['description'] = $entry['content'];
  95                 $entry['pubDate'] = common_date_rfc2822($notice->created);
  96                 $entry['guid'] = $entry['link'];
  97
  98                 return $entry;
  99         }
 100
 101         function twitter_rss_dmsg_array($message) {
 102
 103                 $server = common_config('site', 'server');
 104                 $entry = array();
 105
 106                 $entry['title'] = sprintf('Message from %s to %s',
 107                         $message->getFrom()->nickname, $message->getTo()->nickname);
 108
 109                 $entry['content'] = $message->content;
 110                 $entry['link'] = $message->uri;
 111                 $entry['published'] = common_date_iso8601($message->created);
 112                 $entry['id'] = "tag:$server,2008:$entry[link]";
 113                 $entry['updated'] = $entry['published'];
 114
 115                 # RSS Item specific
 116                 $entry['description'] = $message->content;
 117                 $entry['pubDate'] = common_date_rfc2822($message->created);
 118                 $entry['guid'] = $entry['link'];
 119
 120                 return $entry;
 121         }
 122
 123         function twitter_dmsg_array($message) {
 124
 125                 $twitter_dm = array();
 126
 127                 $from_profile = $message->getFrom();
 128                 $to_profile = $message->getTo();
 129
 130                 $twitter_dm['id'] = $message->id;
 131                 $twitter_dm['sender_id'] = $message->from_profile;
 132                 $twitter_dm['text'] = $message->content;
 133                 $twitter_dm['recipient_id'] = $message->to_profile;
 134                 $twitter_dm['created_at'] = $this->date_twitter($message->created);
 135                 $twitter_dm['sender_screen_name'] = $from_profile->nickname;
 136                 $twitter_dm['recipient_screen_name'] = $to_profile->nickname;
 137                 $twitter_dm['sender'] = $this->twitter_user_array($from_profile, false);
 138                 $twitter_dm['recipient'] = $this->twitter_user_array($to_profile, false);
 139
 140                 return $twitter_dm;
 141         }
 142
 143         function show_twitter_xml_status($twitter_status) {
 144                 common_element_start('status');
 145                 foreach($twitter_status as $element => $value) {
 146                         if ($element == 'user') {
 147                                 $this->show_twitter_xml_user($twitter_status['user']);
 148                         } else {
 149                                 common_element($element, NULL, $value);
 150                         }
 151                 }
 152                 common_element_end('status');
 153         }
 154
 155         function show_twitter_xml_user($twitter_user, $role='user') {
 156                 common_element_start($role);
 157                 foreach($twitter_user as $element => $value) {
 158                         if ($element == 'status') {
 159                                 $this->show_twitter_xml_status($twitter_user['status']);
 160                         } else {
 161                                 common_element($element, NULL, $value);
 162                         }
 163                 }
 164                 common_element_end($role);
 165         }
 166
 167         function show_twitter_rss_item($entry) {
 168                 common_element_start('item');
 169                 common_element('title', NULL, $entry['title']);
 170                 common_element('description', NULL, $entry['description']);
 171                 common_element('pubDate', NULL, $entry['pubDate']);
 172                 common_element('guid', NULL, $entry['guid']);
 173                 common_element('link', NULL, $entry['link']);
 174                 common_element_end('item');
 175         }
 176
 177         function show_twitter_atom_entry($entry) {
 178             common_element_start('entry');
 179                 common_element('title', NULL, $entry['title']);
 180                 common_element('content', array('type' => 'html'), $entry['title']);
 181                 common_element('id', NULL, $entry['id']);
 182                 common_element('published', NULL, $entry['published']);
 183                 common_element('updated', NULL, $entry['updated']);
 184                 common_element('link', array('href' => $entry['link'], 'rel' => 'alternate', 'type' => 'text/html'), NULL);
 185                 common_element_end('entry');
 186         }
 187
 188         function show_twitter_json_statuses($twitter_statuses) {
 189                 print(json_encode($twitter_statuses));
 190         }
 191
 192         function show_twitter_json_users($twitter_users) {
 193                 print(json_encode($twitter_users));
 194         }
 195
 196         function show_twitter_json_dmsgs($twitter_dms) {
 197                 print(json_encode($twitter_dms));
 198         }
 199
 200         function show_single_xml_status($notice) {
 201                 $this->init_document('xml');
 202                 $twitter_status = $this->twitter_status_array($notice);
 203                 $this->show_twitter_xml_status($twitter_status);
 204                 $this->end_document('xml');
 205                 exit();
 206         }
 207
 208         function show_single_json_status($notice) {
 209                 $this->init_document('json');
 210                 $status = $this->twitter_status_array($notice);
 211                 $this->show_twitter_json_statuses($status);
 212                 $this->end_document('json');
 213                 exit();
 214         }
 215
 216         function show_single_xml_dmsg($message) {
 217                 $this->init_document('xml');
 218                 $dmsg = $this->twitter_dmsg_array($message);
 219                 $this->show_twitter_xml_dmsg($dmsg);
 220                 $this->end_document('xml');
 221         }
 222
 223         function show_single_json_dmsg($message) {
 224                 $this->init_document('json');
 225                 $dmsg = $this->twitter_dmsg_array($message);
 226                 $this->show_twitter_json_dm($dmsg);
 227                 $this->end_document('json');
 228         }
 229
 230         function show_twitter_xml_dmsg($twitter_dm) {
 231                 common_element_start('direct_message');
 232                 foreach($twitter_dm as $element => $value) {
 233                         if ($element == 'sender' || $element == 'recipient') {
 234                                 $this->show_twitter_xml_user($value, $element);
 235                         } else {
 236                                 common_element($element, NULL, $value);
 237                         }
 238                 }
 239                 common_element_end('direct_message');
 240         }
 241
 242         function show_xml_timeline($notice) {
 243
 244                 $this->init_document('xml');
 245                 common_element_start('statuses', array('type' => 'array'));
 246
 247                 if (is_array($notice)) {
 248                         foreach ($notice as $n) {
 249                                 $twitter_status = $this->twitter_status_array($n);
 250                                 $this->show_twitter_xml_status($twitter_status);
 251                         }
 252                 } else {
 253                         while ($notice->fetch()) {
 254                                 $twitter_status = $this->twitter_status_array($notice);
 255                                 $this->show_twitter_xml_status($twitter_status);
 256                         }
 257                 }
 258
 259                 common_element_end('statuses');
 260                 $this->end_document('xml');
 261         }
 262
 263         function show_rss_timeline($notice, $title, $link, $subtitle) {
 264
 265                 $this->init_document('rss');
 266
 267                 common_element_start('channel');
 268                 common_element('title', NULL, $title);
 269                 common_element('link', NULL, $link);
 270                 common_element('description', NULL, $subtitle);
 271                 common_element('language', NULL, 'en-us');
 272                 common_element('ttl', NULL, '40');
 273
 274
 275                 if (is_array($notice)) {
 276                         foreach ($notice as $n) {
 277                                 $entry = $this->twitter_rss_entry_array($n);
 278                                 $this->show_twitter_rss_item($entry);
 279                         }
 280                 } else {
 281                         while ($notice->fetch()) {
 282                                 $entry = $this->twitter_rss_entry_array($notice);
 283                                 $this->show_twitter_rss_item($entry);
 284                         }
 285                 }
 286
 287                 common_element_end('channel');
 288                 $this->end_twitter_rss();
 289         }
 290
 291         function show_atom_timeline($notice, $title, $id, $link, $subtitle=NULL) {
 292
 293                 $this->init_document('atom');
 294
 295                 common_element('title', NULL, $title);
 296                 common_element('id', NULL, $id);
 297                 common_element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), NULL);
 298                 common_element('subtitle', NULL, $subtitle);
 299
 300                 if (is_array($notice)) {
 301                         foreach ($notice as $n) {
 302                                 $entry = $this->twitter_rss_entry_array($n);
 303                                 $this->show_twitter_atom_entry($entry);
 304                         }
 305                 } else {
 306                         while ($notice->fetch()) {
 307                                 $entry = $this->twitter_rss_entry_array($notice);
 308                                 $this->show_twitter_atom_entry($entry);
 309                         }
 310                 }
 311
 312                 $this->end_document('atom');
 313
 314         }
 315
 316         function show_json_timeline($notice) {
 317
 318                 $this->init_document('json');
 319
 320                 $statuses = array();
 321
 322                 if (is_array($notice)) {
 323                         foreach ($notice as $n) {
 324                                 $twitter_status = $this->twitter_status_array($n);
 325                                 array_push($statuses, $twitter_status);
 326                         }
 327                 } else {
 328                         while ($notice->fetch()) {
 329                                 $twitter_status = $this->twitter_status_array($notice);
 330                                 array_push($statuses, $twitter_status);
 331                         }
 332                 }
 333
 334                 $this->show_twitter_json_statuses($statuses);
 335
 336                 $this->end_document('json');
 337         }
 338
 339         // Anyone know what date format this is?
 340         // Twitter's dates look like this: "Mon Jul 14 23:52:38 +0000 2008" -- Zach
 341         function date_twitter($dt) {
 342                 $t = strtotime($dt);
 343                 return date("D M d G:i:s O Y", $t);
 344         }
 345
 346         function replier_by_reply($reply_id) {
 347                 $notice = Notice::staticGet($reply_id);
 348                 if ($notice) {
 349                         $profile = $notice->getProfile();
 350                         if ($profile) {
 351                                 return intval($profile->id);
 352                         } else {
 353                                 common_debug('Can\'t find a profile for notice: ' . $notice->id, __FILE__);
 354                         }
 355                 } else {
 356                         common_debug("Can't get notice: $reply_id", __FILE__);
 357                 }
 358                 return NULL;
 359         }
 360
 361         // XXX: Candidate for a general utility method somewhere?
 362         function count_subscriptions($profile) {
 363
 364                 $count = 0;
 365                 $sub = new Subscription();
 366                 $sub->subscribed = $profile->id;
 367
 368                 $count = $sub->find();
 369
 370                 if ($count > 0) {
 371                         return $count - 1;
 372                 } else {
 373                         return 0;
 374                 }
 375         }
 376
 377         function init_document($type='xml') {
 378                 switch ($type) {
 379                  case 'xml':
 380                         header('Content-Type: application/xml; charset=utf-8');
 381                         common_start_xml();
 382                         break;
 383                  case 'json':
 384                         header('Content-Type: application/json; charset=utf-8');
 385
 386                         // Check for JSONP callback
 387                         $callback = $this->arg('callback');
 388                         if ($callback) {
 389                                 print $callback . '(';
 390                         }
 391                         break;
 392                  case 'rss':
 393                         header("Content-Type: application/rss+xml; charset=utf-8");
 394                         $this->init_twitter_rss();
 395                         break;
 396                  case 'atom':
 397                         header('Content-Type: application/atom+xml; charset=utf-8');
 398                         $this->init_twitter_atom();
 399                         break;
 400                  default:
 401                         $this->client_error(_('Not a supported data format.'));
 402                         break;
 403                 }
 404
 405                 return;
 406         }
 407
 408         function end_document($type='xml') {
 409                 switch ($type) {
 410                  case 'xml':
 411                         common_end_xml();
 412                         break;
 413                  case 'json':
 414
 415                         // Check for JSONP callback
 416                         $callback = $this->arg('callback');
 417                         if ($callback) {
 418                                 print ')';
 419                         }
 420                         break;
 421                  case 'rss':
 422                         $this->end_twitter_rss();
 423                         break;
 424                  case 'atom':
 425                         $this->end_twitter_rss();
 426                         break;
 427                  default:
 428                         $this->client_error(_('Not a supported data format.'));
 429                         break;
 430                 }
 431                 return;
 432         }
 433
 434         function client_error($msg, $code = 400, $content_type = 'json') {
 435
 436                 static $status = array(400 => 'Bad Request',
 437                                                            401 => 'Unauthorized',
 438                                                            402 => 'Payment Required',
 439                                                            403 => 'Forbidden',
 440                                                            404 => 'Not Found',
 441                                                            405 => 'Method Not Allowed',
 442                                                            406 => 'Not Acceptable',
 443                                                            407 => 'Proxy Authentication Required',
 444                                                            408 => 'Request Timeout',
 445                                                            409 => 'Conflict',
 446                                                            410 => 'Gone',
 447                                                            411 => 'Length Required',
 448                                                            412 => 'Precondition Failed',
 449                                                            413 => 'Request Entity Too Large',
 450                                                            414 => 'Request-URI Too Long',
 451                                                            415 => 'Unsupported Media Type',
 452                                                            416 => 'Requested Range Not Satisfiable',
 453                                                            417 => 'Expectation Failed');
 454
 455                 $action = $this->trimmed('action');
 456
 457                 common_debug("User error '$code' on '$action': $msg", __FILE__);
 458
 459                 if (!array_key_exists($code, $status)) {
 460                         $code = 400;
 461                 }
 462
 463                 $status_string = $status[$code];
 464                 header('HTTP/1.1 '.$code.' '.$status_string);
 465
 466                 if ($content_type == 'xml') {
 467                         $this->init_document('xml');
 468                         common_element_start('hash');
 469                         common_element('error', NULL, $msg);
 470                         common_element('request', NULL, $_SERVER['REQUEST_URI']);
 471                         common_element_end('hash');
 472                         $this->end_document('xml');
 473                 } else {
 474                         $this->init_document('json');
 475                         $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
 476                         print(json_encode($error_array));
 477                         $this->end_document('json');
 478                 }
 479
 480                 exit();
 481         }
 482
 483         function init_twitter_rss() {
 484                 common_start_xml();
 485                 common_element_start('rss', array('version' => '2.0'));
 486         }
 487
 488         function end_twitter_rss() {
 489                 common_element_end('rss');
 490                 common_end_xml();
 491         }
 492
 493         function init_twitter_atom() {
 494                 common_start_xml();
 495                 common_element_start('feed', array('xmlns' => 'http://www.w3.org/2005/Atom', 'xml:lang' => 'en-US'));
 496         }
 497
 498         function end_twitter_atom() {
 499                 common_end_xml();
 500                 common_element_end('feed');
 501         }
 502
 503         function show_profile($profile, $content_type='xml', $notice=NULL) {
 504                 $profile_array = $this->twitter_user_array($profile, true);
 505                 switch ($content_type) {
 506                  case 'xml':
 507                         $this->show_twitter_xml_user($profile_array);
 508                         break;
 509                  case 'json':
 510                         $this->show_twitter_json_users($profile_array);
 511                         break;
 512                  default:
 513                         $this->client_error(_('Not a supported data format.'));
 514                         return;
 515                 }
 516                 return;
 517         }
 518
 519         function get_user($id) {
 520                 if (is_numeric($id)) {
 521                         return User::staticGet($id);
 522                 } else {
 523                         return User::staticGet('nickname', $id);
 524                 }
 525         }
 526
 527         function get_profile($id) {
 528                 if (is_numeric($id)) {
 529                         return Profile::staticGet($id);
 530                 } else {
 531                         $user = User::staticGet('nickname', $id);
 532                         if ($user) {
 533                                 return $user->getProfile();
 534                         } else {
 535                                 return NULL;
 536                         }
 537                 }
 538         }
 539
 540         function source_link($source) {
 541                 $source_name = _($source);
 542                 switch ($source) {
 543                  case 'web':
 544                  case 'xmpp':
 545                  case 'mail':
 546                  case 'omb':
 547                  case 'api':
 548                         break;
 549                  default:
 550                         $ns = Notice_source::staticGet($source);
 551                         if ($ns) {
 552                                 $source_name = '<a href="' . $ns->url . '">' . $ns->name . '</a>';
 553                         }
 554                         break;
 555                 }
 556                 return $source_name;
 557         }
 558
 559 }