plugins/TwitterBridge/twitter.php

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