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
  34     $luser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
  35
  36     if (!empty($luser)) {
  37         $result = $luser->delete();
  38         if ($result != false) {
  39             common_log(
  40                 LOG_INFO,
  41                 "Twitter bridge - removed old Twitter user: $screen_name ($twitter_id)."
  42             );
  43         }
  44     }
  45
  46     $fuser = new Foreign_user();
  47
  48     $fuser->nickname = $screen_name;
  49     $fuser->uri = 'http://twitter.com/' . $screen_name;
  50     $fuser->id = $twitter_id;
  51     $fuser->service = TWITTER_SERVICE;
  52     $fuser->created = common_sql_now();
  53     $result = $fuser->insert();
  54
  55     if (empty($result)) {
  56         common_log(LOG_WARNING,
  57             "Twitter bridge - failed to add new Twitter user: $twitter_id - $screen_name.");
  58         common_log_db_error($fuser, 'INSERT', __FILE__);
  59     } else {
  60         common_log(LOG_INFO,
  61                    "Twitter bridge - Added new Twitter user: $screen_name ($twitter_id).");
  62     }
  63
  64     return $result;
  65 }
  66
  67 // Creates or Updates a Twitter user
  68 function save_twitter_user($twitter_id, $screen_name)
  69 {
  70     // Check to see whether the Twitter user is already in the system,
  71     // and update its screen name and uri if so.
  72
  73     $fuser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
  74
  75     if (!empty($fuser)) {
  76
  77         // Delete old record if Twitter user changed screen name
  78
  79         if ($fuser->nickname != $screen_name) {
  80             $oldname = $fuser->nickname;
  81             $fuser->delete();
  82             common_log(LOG_INFO, sprintf('Twitter bridge - Updated nickname (and URI) ' .
  83                                          'for Twitter user %1$d - %2$s, was %3$s.',
  84                                          $fuser->id,
  85                                          $screen_name,
  86                                          $oldname));
  87         }
  88
  89     } else {
  90
  91         // Kill any old, invalid records for this screen name
  92
  93         $fuser = Foreign_user::getByNickname($screen_name, TWITTER_SERVICE);
  94
  95         if (!empty($fuser)) {
  96             $fuser->delete();
  97             common_log(
  98                 LOG_INFO,
  99                 sprintf(
 100                     'Twitter bridge - deteted old record for Twitter ' .
 101                     'screen name "%s" belonging to Twitter ID %d.',
 102                     $screen_name,
 103                     $fuser->id
 104                 )
 105             );
 106         }
 107     }
 108
 109     return add_twitter_user($twitter_id, $screen_name);
 110 }
 111
 112 function is_twitter_bound($notice, $flink) {
 113
 114     // Check to see if notice should go to Twitter
 115     if (!empty($flink) && ($flink->noticesync & FOREIGN_NOTICE_SEND)) {
 116
 117         // If it's not a Twitter-style reply, or if the user WANTS to send replies,
 118         // or if it's in reply to a twitter notice
 119
 120         if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
 121             ($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) ||
 122             is_twitter_notice($notice->reply_to)) {
 123             return true;
 124         }
 125     }
 126
 127     return false;
 128 }
 129
 130 function is_twitter_notice($id)
 131 {
 132     $n2s = Notice_to_status::staticGet('notice_id', $id);
 133
 134     return (!empty($n2s));
 135 }
 136
 137 function broadcast_twitter($notice)
 138 {
 139     $flink = Foreign_link::getByUserID($notice->profile_id,
 140                                        TWITTER_SERVICE);
 141
 142     // Don't bother with basic auth, since it's no longer allowed
 143
 144     if (!empty($flink) && TwitterOAuthClient::isPackedToken($flink->credentials)) {
 145         if (!empty($notice->repeat_of) && is_twitter_notice($notice->repeat_of)) {
 146             return retweet_notice($flink, Notice::staticGet('id', $notice->repeat_of));
 147         } else if (is_twitter_bound($notice, $flink)) {
 148             return broadcast_oauth($notice, $flink);
 149         }
 150     }
 151
 152     return true;
 153 }
 154
 155 function retweet_notice($flink, $notice)
 156 {
 157     $token = TwitterOAuthClient::unpackToken($flink->credentials);
 158     $client = new TwitterOAuthClient($token->key, $token->secret);
 159
 160     $id = twitter_status_id($notice);
 161
 162     try {
 163         $status = $client->statusesRetweet($id);
 164         if (!empty($status)) {
 165             Notice_to_status::saveNew($notice->id, $status->id);
 166         }
 167     } catch (OAuthClientException $e) {
 168         return process_error($e, $flink, $notice);
 169     }
 170 }
 171
 172 function twitter_status_id($notice)
 173 {
 174     $n2s = Notice_to_status::staticGet('notice_id', $id);
 175     if (empty($n2s)) {
 176         return null;
 177     } else {
 178         return $n2s->status_id;
 179     }
 180 }
 181
 182 /**
 183  * Pull any extra information from a notice that we should transfer over
 184  * to Twitter beyond the notice text itself.
 185  *
 186  * @param Notice $notice
 187  * @return array of key-value pairs for Twitter update submission
 188  * @access private
 189  */
 190 function twitter_update_params($notice)
 191 {
 192     $params = array();
 193     if ($notice->lat || $notice->lon) {
 194         $params['lat'] = $notice->lat;
 195         $params['long'] = $notice->lon;
 196     }
 197     if (!empty($notice->reply_to) && is_twitter_notice($notice->reply_to)) {
 198         $reply = Notice::staticGet('id', $notice->reply_to);
 199         $params['in_reply_to_status_id'] = twitter_status_id($reply);
 200     }
 201     return $params;
 202 }
 203
 204 function broadcast_oauth($notice, $flink) {
 205     $user = $flink->getUser();
 206     $statustxt = format_status($notice);
 207     $params = twitter_update_params($notice);
 208
 209     $token = TwitterOAuthClient::unpackToken($flink->credentials);
 210     $client = new TwitterOAuthClient($token->key, $token->secret);
 211     $status = null;
 212
 213     try {
 214         $status = $client->statusesUpdate($statustxt, $params);
 215         if (!empty($status)) {
 216             Notice_to_status::saveNew($notice->id, $status->id);
 217         }
 218     } catch (OAuthClientException $e) {
 219         return process_error($e, $flink, $notice);
 220     }
 221
 222     if (empty($status)) {
 223
 224         // This could represent a failure posting,
 225         // or the Twitter API might just be behaving flakey.
 226
 227         $errmsg = sprintf('Twitter bridge - No data returned by Twitter API when ' .
 228                           'trying to post notice %d for User %s (user id %d).',
 229                           $notice->id,
 230                           $user->nickname,
 231                           $user->id);
 232
 233         common_log(LOG_WARNING, $errmsg);
 234
 235         return false;
 236     }
 237
 238     // Notice crossed the great divide
 239
 240     $msg = sprintf('Twitter bridge - posted notice %d to Twitter using ' .
 241                    'OAuth for User %s (user id %d).',
 242                    $notice->id,
 243                    $user->nickname,
 244                    $user->id);
 245
 246     common_log(LOG_INFO, $msg);
 247
 248     return true;
 249 }
 250
 251 function process_error($e, $flink, $notice)
 252 {
 253     $user = $flink->getUser();
 254     $code = $e->getCode();
 255
 256     $logmsg = sprintf('Twitter bridge - %d posting notice %d for ' .
 257                       'User %s (user id: %d): %s.',
 258                       $code,
 259                       $notice->id,
 260                       $user->nickname,
 261                       $user->id,
 262                       $e->getMessage());
 263
 264     common_log(LOG_WARNING, $logmsg);
 265
 266     switch($code) {
 267      case 401:
 268         // Probably a revoked or otherwise bad access token - nuke!
 269         remove_twitter_link($flink);
 270         return true;
 271         break;
 272      case 403:
 273         // User has exceeder her rate limit -- toss the notice
 274         return true;
 275         break;
 276      default:
 277
 278         // For every other case, it's probably some flakiness so try
 279         // sending the notice again later (requeue).
 280
 281         return false;
 282         break;
 283     }
 284 }
 285
 286 function format_status($notice)
 287 {
 288     // XXX: Hack to get around PHP cURL's use of @ being a a meta character
 289     $statustxt = preg_replace('/^@/', ' @', $notice->content);
 290
 291     // Convert !groups to #hashes
 292
 293     // XXX: Make this an optional setting?
 294
 295     $statustxt = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/', "\\1#\\2", $statustxt);
 296
 297     if (mb_strlen($statustxt) > 140) {
 298         $noticeUrl = common_shorten_url($notice->uri);
 299         $urlLen = mb_strlen($noticeUrl);
 300         $statustxt = mb_substr($statustxt, 0, 140 - ($urlLen + 3)) . ' … ' . $noticeUrl;
 301     }
 302
 303     return $statustxt;
 304 }
 305
 306 function remove_twitter_link($flink)
 307 {
 308     $user = $flink->getUser();
 309
 310     common_log(LOG_INFO, 'Removing Twitter bridge Foreign link for ' .
 311                "user $user->nickname (user id: $user->id).");
 312
 313     $result = $flink->safeDelete();
 314
 315     if (empty($result)) {
 316         common_log(LOG_ERR, 'Could not remove Twitter bridge ' .
 317                    "Foreign_link for $user->nickname (user id: $user->id)!");
 318         common_log_db_error($flink, 'DELETE', __FILE__);
 319     }
 320
 321     // Notify the user that her Twitter bridge is down
 322
 323     if (isset($user->email)) {
 324
 325         $result = mail_twitter_bridge_removed($user);
 326
 327         if (!$result) {
 328
 329             $msg = 'Unable to send email to notify ' .
 330               "$user->nickname (user id: $user->id) " .
 331               'that their Twitter bridge link was ' .
 332               'removed!';
 333
 334             common_log(LOG_WARNING, $msg);
 335         }
 336     }
 337
 338 }
 339
 340 /**
 341  * Send a mail message to notify a user that her Twitter bridge link
 342  * has stopped working, and therefore has been removed.  This can
 343  * happen when the user changes her Twitter password, or otherwise
 344  * revokes access.
 345  *
 346  * @param User $user   user whose Twitter bridge link has been removed
 347  *
 348  * @return boolean success flag
 349  */
 350
 351 function mail_twitter_bridge_removed($user)
 352 {
 353     $profile = $user->getProfile();
 354
 355     common_switch_locale($user->language);
 356
 357     $subject = sprintf(_m('Your Twitter bridge has been disabled.'));
 358
 359     $site_name = common_config('site', 'name');
 360
 361     $body = sprintf(_m('Hi, %1$s. We\'re sorry to inform you that your ' .
 362         'link to Twitter has been disabled. We no longer seem to have ' .
 363     'permission to update your Twitter status. (Did you revoke ' .
 364     '%3$s\'s access?)' . "\n\n" .
 365     'You can re-enable your Twitter bridge by visiting your ' .
 366     "Twitter settings page:\n\n\t%2\$s\n\n" .
 367         "Regards,\n%3\$s\n"),
 368         $profile->getBestName(),
 369         common_local_url('twittersettings'),
 370         common_config('site', 'name'));
 371
 372     common_switch_locale();
 373     return mail_to_user($user, $subject, $body);
 374 }
 375