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'] = $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,$entry[published]:$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_dm_array($message) {
 102
 103                 $twitter_dm = array();
 104
 105                 $from_profile = $message->getFrom();
 106                 $to_profile = $message->getTo();
 107
 108                 $twitter_dm['id'] = $message->id;
 109                 $twitter_dm['sender_id'] = $message->from_profile;
 110                 $twitter_dm['text'] = $message->content;
 111                 $twitter_dm['recipient_id'] = $message->to_profile;
 112                 $twitter_dm['created_at'] = $this->date_twitter($message->created);
 113                 $twitter_dm['sender_screen_name'] = $from_profile->nickname;
 114                 $twitter_dm['recipient_screen_name'] = $to_profile->nickname;
 115                 $twitter_dm['sender'] = $this->twitter_user_array($from_profile, false);
 116                 $twitter_dm['recipient'] = $this->twitter_user_array($to_profile, false);
 117
 118                 return $twitter_dm;
 119         }
 120
 121         function show_twitter_xml_status($twitter_status) {
 122                 common_element_start('status');
 123                 foreach($twitter_status as $element => $value) {
 124                         if ($element == 'user') {
 125                                 $this->show_twitter_xml_user($twitter_status['user']);
 126                         } else {
 127                                 common_element($element, NULL, $value);
 128                         }
 129                 }
 130                 common_element_end('status');
 131         }
 132
 133         function show_twitter_xml_user($twitter_user, $role='user') {
 134                 common_element_start($role);
 135                 foreach($twitter_user as $element => $value) {
 136                         if ($element == 'status') {
 137                                 $this->show_twitter_xml_status($twitter_user['status']);
 138                         } else {
 139                                 common_element($element, NULL, $value);
 140                         }
 141                 }
 142                 common_element_end($role);
 143         }
 144
 145         function show_twitter_rss_item($entry) {
 146                 common_element_start('item');
 147                 common_element('title', NULL, $entry['title']);
 148                 common_element('description', NULL, $entry['description']);
 149                 common_element('pubDate', NULL, $entry['pubDate']);
 150                 common_element('guid', NULL, $entry['guid']);
 151                 common_element('link', NULL, $entry['link']);
 152                 common_element_end('item');
 153         }
 154
 155         function show_twitter_atom_entry($entry) {
 156             common_element_start('entry');
 157                 common_element('title', NULL, $entry['title']);
 158                 common_element('content', array('type' => 'html'), $entry['title']);
 159                 common_element('id', NULL, $entry['id']);
 160                 common_element('published', NULL, $entry['published']);
 161                 common_element('updated', NULL, $entry['updated']);
 162                 common_element('link', array('href' => $entry['link'], 'rel' => 'alternate', 'type' => 'text/html'), NULL);
 163                 common_element_end('entry');
 164         }
 165
 166         function show_twitter_json_statuses($twitter_statuses) {
 167                 print(json_encode($twitter_statuses));
 168         }
 169
 170         function show_twitter_json_users($twitter_users) {
 171                 print(json_encode($twitter_users));
 172         }
 173
 174         function show_twitter_json_dmsgs($twitter_dms) {
 175                 print(json_encode($twitter_dms));
 176         }
 177
 178         function show_single_xml_status($notice) {
 179                 $this->init_document('xml');
 180                 $twitter_status = $this->twitter_status_array($notice);
 181                 $this->show_twitter_xml_status($twitter_status);
 182                 $this->end_document('xml');
 183                 exit();
 184         }
 185
 186         function show_single_json_status($notice) {
 187                 $this->init_document('json');
 188                 $status = $this->twitter_status_array($notice);
 189                 $this->show_twitter_json_statuses($status);
 190                 $this->end_document('json');
 191                 exit();
 192         }
 193
 194         function show_twitter_xml_dm($twitter_dm) {
 195                 common_element_start('direct_message');
 196                 foreach($twitter_dm as $element => $value) {
 197                         if ($element == 'sender' || $element == 'recipient') {
 198                                 $this->show_twitter_xml_user($value, $element);
 199                         } else {
 200                                 common_element($element, NULL, $value);
 201                         }
 202                 }
 203                 common_element_end('direct_message');
 204         }
 205
 206         // Anyone know what date format this is?
 207         // Twitter's dates look like this: "Mon Jul 14 23:52:38 +0000 2008" -- Zach
 208         function date_twitter($dt) {
 209                 $t = strtotime($dt);
 210                 return date("D M d G:i:s O Y", $t);
 211         }
 212
 213         function replier_by_reply($reply_id) {
 214                 $notice = Notice::staticGet($reply_id);
 215                 if ($notice) {
 216                         $profile = $notice->getProfile();
 217                         if ($profile) {
 218                                 return intval($profile->id);
 219                         } else {
 220                                 common_debug('Can\'t find a profile for notice: ' . $notice->id, __FILE__);
 221                         }
 222                 } else {
 223                         common_debug("Can't get notice: $reply_id", __FILE__);
 224                 }
 225                 return NULL;
 226         }
 227
 228         // XXX: Candidate for a general utility method somewhere?
 229         function count_subscriptions($profile) {
 230
 231                 $count = 0;
 232                 $sub = new Subscription();
 233                 $sub->subscribed = $profile->id;
 234
 235                 $count = $sub->find();
 236
 237                 if ($count > 0) {
 238                         return $count - 1;
 239                 } else {
 240                         return 0;
 241                 }
 242         }
 243
 244         function init_document($type='xml') {
 245                 switch ($type) {
 246                  case 'xml':
 247                         header('Content-Type: application/xml; charset=utf-8');
 248                         common_start_xml();
 249                         break;
 250                  case 'json':
 251                         header('Content-Type: application/json; charset=utf-8');
 252
 253                         // Check for JSONP callback
 254                         $callback = $this->arg('callback');
 255                         if ($callback) {
 256                                 print $callback . '(';
 257                         }
 258                         break;
 259                  case 'rss':
 260                         header("Content-Type: application/rss+xml; charset=utf-8");
 261                         $this->init_twitter_rss();
 262                         break;
 263                  case 'atom':
 264                         header('Content-Type: application/atom+xml; charset=utf-8');
 265                         $this->init_twitter_atom();
 266                         break;
 267                  default:
 268                         $this->client_error(_('Not a supported data format.'));
 269                         break;
 270                 }
 271
 272                 return;
 273         }
 274
 275         function end_document($type='xml') {
 276                 switch ($type) {
 277                  case 'xml':
 278                         common_end_xml();
 279                         break;
 280                  case 'json':
 281
 282                         // Check for JSONP callback
 283                         $callback = $this->arg('callback');
 284                         if ($callback) {
 285                                 print ')';
 286                         }
 287                         break;
 288                  case 'rss':
 289                         $this->end_twitter_rss();
 290                         break;
 291                  case 'atom':
 292                         $this->end_twitter_rss();
 293                         break;
 294                  default:
 295                         $this->client_error(_('Not a supported data format.'));
 296                         break;
 297                 }
 298                 return;
 299         }
 300
 301         function client_error($msg, $code = 400, $content_type = 'json') {
 302
 303                 static $status = array(400 => 'Bad Request',
 304                                                            401 => 'Unauthorized',
 305                                                            402 => 'Payment Required',
 306                                                            403 => 'Forbidden',
 307                                                            404 => 'Not Found',
 308                                                            405 => 'Method Not Allowed',
 309                                                            406 => 'Not Acceptable',
 310                                                            407 => 'Proxy Authentication Required',
 311                                                            408 => 'Request Timeout',
 312                                                            409 => 'Conflict',
 313                                                            410 => 'Gone',
 314                                                            411 => 'Length Required',
 315                                                            412 => 'Precondition Failed',
 316                                                            413 => 'Request Entity Too Large',
 317                                                            414 => 'Request-URI Too Long',
 318                                                            415 => 'Unsupported Media Type',
 319                                                            416 => 'Requested Range Not Satisfiable',
 320                                                            417 => 'Expectation Failed');
 321
 322                 $action = $this->trimmed('action');
 323
 324                 common_debug("User error '$code' on '$action': $msg", __FILE__);
 325
 326                 if (!array_key_exists($code, $status)) {
 327                         $code = 400;
 328                 }
 329
 330                 $status_string = $status[$code];
 331                 header('HTTP/1.1 '.$code.' '.$status_string);
 332
 333                 if ($content_type == 'xml') {
 334                         $this->init_document('xml');
 335                         common_element_start('hash');
 336                         common_element('error', NULL, $msg);
 337                         common_element('request', NULL, $_SERVER['REQUEST_URI']);
 338                         common_element_end('hash');
 339                         $this->end_document('xml');
 340                 } else {
 341                         $this->init_document('json');
 342                         $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
 343                         print(json_encode($error_array));
 344                         $this->end_document('json');
 345                 }
 346
 347                 exit();
 348         }
 349
 350         function init_twitter_rss() {
 351                 common_start_xml();
 352                 common_element_start('rss', array('version' => '2.0'));
 353         }
 354
 355         function end_twitter_rss() {
 356                 common_element_end('rss');
 357                 common_end_xml();
 358         }
 359
 360         function init_twitter_atom() {
 361                 common_start_xml();
 362                 common_element_start('feed', array('xmlns' => 'http://www.w3.org/2005/Atom', 'xml:lang' => 'en-US'));
 363         }
 364
 365         function end_twitter_atom() {
 366                 common_end_xml();
 367                 common_element_end('feed');
 368         }
 369
 370         function show_profile($profile, $content_type='xml', $notice=NULL) {
 371                 $profile_array = $this->twitter_user_array($profile, true);
 372                 switch ($content_type) {
 373                  case 'xml':
 374                         $this->show_twitter_xml_user($profile_array);
 375                         break;
 376                  case 'json':
 377                         $this->show_twitter_json_users($profile_array);
 378                         break;
 379                  default:
 380                         $this->client_error(_('Not a supported data format.'));
 381                         return;
 382                 }
 383                 return;
 384         }
 385 }