plugins/TwitterBridge/twitter.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008-2010 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 define('TWITTER_SERVICE', 1); // Twitter is foreign_service ID 1
  25
  26 require_once INSTALLDIR . '/plugins/TwitterBridge/twitteroauthclient.php';
  27
  28 function add_twitter_user($twitter_id, $screen_name)
  29 {
  30     // Clear out any bad old foreign_users with the new user's legit URL
  31     // This can happen when users move around or fakester accounts get
  32     // repoed, and things like that.
  33     $luser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
  34
  35     if (!empty($luser)) {
  36         $result = $luser->delete();
  37         if ($result != false) {
  38             common_log(
  39                 LOG_INFO,
  40                 "Twitter bridge - removed old Twitter user: $screen_name ($twitter_id)."
  41             );
  42         }
  43     }
  44
  45     $fuser = new Foreign_user();
  46
  47     $fuser->nickname = $screen_name;
  48     $fuser->uri = 'http://twitter.com/' . $screen_name;
  49     $fuser->id = $twitter_id;
  50     $fuser->service = TWITTER_SERVICE;
  51     $fuser->created = common_sql_now();
  52     $result = $fuser->insert();
  53
  54     if (empty($result)) {
  55         common_log(LOG_WARNING,
  56             "Twitter bridge - failed to add new Twitter user: $twitter_id - $screen_name.");
  57         common_log_db_error($fuser, 'INSERT', __FILE__);
  58     } else {
  59         common_log(LOG_INFO,
  60                    "Twitter bridge - Added new Twitter user: $screen_name ($twitter_id).");
  61     }
  62
  63     return $result;
  64 }
  65
  66 // Creates or Updates a Twitter user
  67 function save_twitter_user($twitter_id, $screen_name)
  68 {
  69     // Check to see whether the Twitter user is already in the system,
  70     // and update its screen name and uri if so.
  71     $fuser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
  72
  73     if (!empty($fuser)) {
  74
  75         // Delete old record if Twitter user changed screen name
  76
  77         if ($fuser->nickname != $screen_name) {
  78             $oldname = $fuser->nickname;
  79             $fuser->delete();
  80             common_log(LOG_INFO, sprintf('Twitter bridge - Updated nickname (and URI) ' .
  81                                          'for Twitter user %1$d - %2$s, was %3$s.',
  82                                          $fuser->id,
  83                                          $screen_name,
  84                                          $oldname));
  85         }
  86     } else {
  87         // Kill any old, invalid records for this screen name
  88         $fuser = Foreign_user::getByNickname($screen_name, TWITTER_SERVICE);
  89
  90         if (!empty($fuser)) {
  91             $fuser->delete();
  92             common_log(
  93                 LOG_INFO,
  94                 sprintf(
  95                     'Twitter bridge - deteted old record for Twitter ' .
  96                     'screen name "%s" belonging to Twitter ID %d.',
  97                     $screen_name,
  98                     $fuser->id
  99                 )
 100             );
 101         }
 102     }
 103
 104     return add_twitter_user($twitter_id, $screen_name);
 105 }
 106
 107 function is_twitter_bound($notice, $flink) {
 108     // Check to see if notice should go to Twitter
 109     if (!empty($flink) && ($flink->noticesync & FOREIGN_NOTICE_SEND)) {
 110
 111         // If it's not a Twitter-style reply, or if the user WANTS to send replies,
 112         // or if it's in reply to a twitter notice
 113         if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
 114             ($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) ||
 115             is_twitter_notice($notice->reply_to)) {
 116             return true;
 117         }
 118     }
 119
 120     return false;
 121 }
 122
 123 function is_twitter_notice($id)
 124 {
 125     $n2s = Notice_to_status::staticGet('notice_id', $id);
 126
 127     return (!empty($n2s));
 128 }
 129
 130 /**
 131  * Pull the formatted status ID number from a Twitter status object
 132  * returned via JSON from Twitter API.
 133  *
 134  * Encapsulates checking for the id_str attribute, which is required
 135  * to read 64-bit "Snowflake" ID numbers on a 32-bit system -- the
 136  * integer id attribute gets corrupted into a double-precision float,
 137  * losing a few digits of precision.
 138  *
 139  * Warning: avoid performing arithmetic or direct comparisons with
 140  * this number, as it may get coerced back to a double on 32-bit.
 141  *
 142  * @param object $status
 143  * @param string $field base field name if not 'id'
 144  * @return mixed id number as int or string
 145  */
 146 function twitter_id($status, $field='id')
 147 {
 148     $field_str = "{$field}_str";
 149     if (isset($status->$field_str)) {
 150         // String version of the id -- required on 32-bit systems
 151         // since the 64-bit numbers get corrupted as ints.
 152         return $status->$field_str;
 153     } else {
 154         return $status->$field;
 155     }
 156 }
 157
 158 /**
 159  * Check if we need to broadcast a notice over the Twitter bridge, and
 160  * do so if necessary. Will determine whether to do a straight post or
 161  * a repeat/retweet
 162  *
 163  * This function is meant to be called directly from TwitterQueueHandler.
 164  *
 165  * @param Notice $notice
 166  * @return boolean true if complete or successful, false if we should retry
 167  */
 168 function broadcast_twitter($notice)
 169 {
 170     $flink = Foreign_link::getByUserID($notice->profile_id,
 171                                        TWITTER_SERVICE);
 172
 173     // Don't bother with basic auth, since it's no longer allowed
 174     if (!empty($flink) && TwitterOAuthClient::isPackedToken($flink->credentials)) {
 175         if (is_twitter_bound($notice, $flink)) {
 176             if (!empty($notice->repeat_of) && is_twitter_notice($notice->repeat_of)) {
 177                 $retweet = retweet_notice($flink, Notice::staticGet('id', $notice->repeat_of));
 178                 if (is_object($retweet)) {
 179                     Notice_to_status::saveNew($notice->id, twitter_id($retweet));
 180                     return true;
 181                 } else {
 182                     // Our error processing will have decided if we need to requeue
 183                     // this or can discard safely.
 184                     return $retweet;
 185                 }
 186             } else {
 187                 return broadcast_oauth($notice, $flink);
 188             }
 189         }
 190     }
 191
 192     return true;
 193 }
 194
 195 /**
 196  * Send a retweet to Twitter for a notice that has been previously bridged
 197  * in or out.
 198  *
 199  * Warning: the return value is not guaranteed to be an object; some error
 200  * conditions will return a 'true' which should be passed on to a calling
 201  * queue handler.
 202  *
 203  * No local information about the resulting retweet is saved: it's up to
 204  * caller to save new mappings etc if appropriate.
 205  *
 206  * @param Foreign_link $flink
 207  * @param Notice $notice
 208  * @return mixed object with resulting Twitter status data on success, or true/false/null on error conditions.
 209  */
 210 function retweet_notice($flink, $notice)
 211 {
 212     $token = TwitterOAuthClient::unpackToken($flink->credentials);
 213     $client = new TwitterOAuthClient($token->key, $token->secret);
 214
 215     $id = twitter_status_id($notice);
 216
 217     if (empty($id)) {
 218         common_log(LOG_WARNING, "Trying to retweet notice {$notice->id} with no known status id.");
 219         return null;
 220     }
 221
 222     try {
 223         $status = $client->statusesRetweet($id);
 224         return $status;
 225     } catch (OAuthClientException $e) {
 226         return process_error($e, $flink, $notice);
 227     }
 228 }
 229
 230 function twitter_status_id($notice)
 231 {
 232     $n2s = Notice_to_status::staticGet('notice_id', $notice->id);
 233     if (empty($n2s)) {
 234         return null;
 235     } else {
 236         return $n2s->status_id;
 237     }
 238 }
 239
 240 /**
 241  * Pull any extra information from a notice that we should transfer over
 242  * to Twitter beyond the notice text itself.
 243  *
 244  * @param Notice $notice
 245  * @return array of key-value pairs for Twitter update submission
 246  * @access private
 247  */
 248 function twitter_update_params($notice)
 249 {
 250     $params = array();
 251     if ($notice->lat || $notice->lon) {
 252         $params['lat'] = $notice->lat;
 253         $params['long'] = $notice->lon;
 254     }
 255     if (!empty($notice->reply_to) && is_twitter_notice($notice->reply_to)) {
 256         $reply = Notice::staticGet('id', $notice->reply_to);
 257         $params['in_reply_to_status_id'] = twitter_status_id($reply);
 258     }
 259     return $params;
 260 }
 261
 262 function broadcast_oauth($notice, $flink) {
 263     $user = $flink->getUser();
 264     $statustxt = format_status($notice);
 265     $params = twitter_update_params($notice);
 266
 267     $token = TwitterOAuthClient::unpackToken($flink->credentials);
 268     $client = new TwitterOAuthClient($token->key, $token->secret);
 269     $status = null;
 270
 271     try {
 272         $status = $client->statusesUpdate($statustxt, $params);
 273         if (!empty($status)) {
 274             Notice_to_status::saveNew($notice->id, twitter_id($status));
 275         }
 276     } catch (OAuthClientException $e) {
 277         return process_error($e, $flink, $notice);
 278     }
 279
 280     if (empty($status)) {
 281         // This could represent a failure posting,
 282         // or the Twitter API might just be behaving flakey.
 283         $errmsg = sprintf('Twitter bridge - No data returned by Twitter API when ' .
 284                           'trying to post notice %d for User %s (user id %d).',
 285                           $notice->id,
 286                           $user->nickname,
 287                           $user->id);
 288
 289         common_log(LOG_WARNING, $errmsg);
 290
 291         return false;
 292     }
 293
 294     // Notice crossed the great divide
 295     $msg = sprintf('Twitter bridge - posted notice %d to Twitter using ' .
 296                    'OAuth for User %s (user id %d).',
 297                    $notice->id,
 298                    $user->nickname,
 299                    $user->id);
 300
 301     common_log(LOG_INFO, $msg);
 302
 303     return true;
 304 }
 305
 306 function process_error($e, $flink, $notice)
 307 {
 308     $user = $flink->getUser();
 309     $code = $e->getCode();
 310
 311     $logmsg = sprintf('Twitter bridge - %d posting notice %d for ' .
 312                       'User %s (user id: %d): %s.',
 313                       $code,
 314                       $notice->id,
 315                       $user->nickname,
 316                       $user->id,
 317                       $e->getMessage());
 318
 319     common_log(LOG_WARNING, $logmsg);
 320
 321     // http://dev.twitter.com/pages/responses_errors
 322     switch($code) {
 323      case 400:
 324          // Probably invalid data (bad Unicode chars or coords) that
 325          // cannot be resolved by just sending again.
 326          //
 327          // It could also be rate limiting, but retrying immediately
 328          // won't help much with that, so we'll discard for now.
 329          // If a facility for retrying things later comes up in future,
 330          // we can detect the rate-limiting headers and use that.
 331          //
 332          // Discard the message permanently.
 333          return true;
 334          break;
 335      case 401:
 336         // Probably a revoked or otherwise bad access token - nuke!
 337         remove_twitter_link($flink);
 338         return true;
 339         break;
 340      case 403:
 341         // User has exceeder her rate limit -- toss the notice
 342         return true;
 343         break;
 344      case 404:
 345          // Resource not found. Shouldn't happen much on posting,
 346          // but just in case!
 347          //
 348          // Consider it a matter for tossing the notice.
 349          return true;
 350          break;
 351      default:
 352
 353         // For every other case, it's probably some flakiness so try
 354         // sending the notice again later (requeue).
 355
 356         return false;
 357         break;
 358     }
 359 }
 360
 361 function format_status($notice)
 362 {
 363     // Start with the plaintext source of this notice...
 364     $statustxt = $notice->content;
 365
 366     // Convert !groups to #hashes
 367     // XXX: Make this an optional setting?
 368     $statustxt = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/', "\\1#\\2", $statustxt);
 369
 370     // Twitter still has a 140-char hardcoded max.
 371     if (mb_strlen($statustxt) > 140) {
 372         $noticeUrl = common_shorten_url($notice->uri);
 373         $urlLen = mb_strlen($noticeUrl);
 374         $statustxt = mb_substr($statustxt, 0, 140 - ($urlLen + 3)) . ' … ' . $noticeUrl;
 375     }
 376
 377     return $statustxt;
 378 }
 379
 380 function remove_twitter_link($flink)
 381 {
 382     $user = $flink->getUser();
 383
 384     common_log(LOG_INFO, 'Removing Twitter bridge Foreign link for ' .
 385                "user $user->nickname (user id: $user->id).");
 386
 387     $result = $flink->safeDelete();
 388
 389     if (empty($result)) {
 390         common_log(LOG_ERR, 'Could not remove Twitter bridge ' .
 391                    "Foreign_link for $user->nickname (user id: $user->id)!");
 392         common_log_db_error($flink, 'DELETE', __FILE__);
 393     }
 394
 395     // Notify the user that her Twitter bridge is down
 396
 397     if (isset($user->email)) {
 398         $result = mail_twitter_bridge_removed($user);
 399
 400         if (!$result) {
 401             $msg = 'Unable to send email to notify ' .
 402               "$user->nickname (user id: $user->id) " .
 403               'that their Twitter bridge link was ' .
 404               'removed!';
 405
 406             common_log(LOG_WARNING, $msg);
 407         }
 408     }
 409 }
 410
 411 /**
 412  * Send a mail message to notify a user that her Twitter bridge link
 413  * has stopped working, and therefore has been removed.  This can
 414  * happen when the user changes her Twitter password, or otherwise
 415  * revokes access.
 416  *
 417  * @param User $user   user whose Twitter bridge link has been removed
 418  *
 419  * @return boolean success flag
 420  */
 421 function mail_twitter_bridge_removed($user)
 422 {
 423     $profile = $user->getProfile();
 424
 425     common_switch_locale($user->language);
 426
 427     // TRANS: Mail subject after forwarding notices to Twitter has stopped working.
 428     $subject = sprintf(_m('Your Twitter bridge has been disabled'));
 429
 430     $site_name = common_config('site', 'name');
 431
 432     // TRANS: Mail body after forwarding notices to Twitter has stopped working.
 433     // TRANS: %1$ is the name of the user the mail is sent to, %2$s is a URL to the
 434     // TRANS: Twitter settings, %3$s is the StatusNet sitename.
 435     $body = sprintf(_m('Hi, %1$s. We\'re sorry to inform you that your ' .
 436         'link to Twitter has been disabled. We no longer seem to have ' .
 437     'permission to update your Twitter status. Did you maybe revoke ' .
 438     '%3$s\'s access?' . "\n\n" .
 439     'You can re-enable your Twitter bridge by visiting your ' .
 440     "Twitter settings page:\n\n\t%2\$s\n\n" .
 441         "Regards,\n%3\$s"),
 442         $profile->getBestName(),
 443         common_local_url('twittersettings'),
 444         common_config('site', 'name'));
 445
 446     common_switch_locale();
 447     return mail_to_user($user, $subject, $body);
 448 }