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