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     $notice = Notice::staticGet('id', $id);
 133
 134     if (empty($notice)) {
 135         // it's not any kind of notice, so it's definitely not a Twitter notice.
 136         return false;
 137     }
 138
 139     return ($notice->source == 'twitter');
 140 }
 141
 142 function broadcast_twitter($notice)
 143 {
 144     $flink = Foreign_link::getByUserID($notice->profile_id,
 145                                        TWITTER_SERVICE);
 146
 147     // Don't bother with basic auth, since it's no longer allowed
 148
 149     if (!empty($flink) && TwitterOAuthClient::isPackedToken($flink->credentials)) {
 150         if (!empty($notice->repeat_of) && is_twitter_notice($notice->repeat_of)) {
 151             return retweet_notice($flink, Notice::staticGet('id', $notice->repeat_of));
 152         } else if (is_twitter_bound($notice, $flink)) {
 153             return broadcast_oauth($notice, $flink);
 154         }
 155     }
 156
 157     return true;
 158 }
 159
 160 function retweet_notice($flink, $notice)
 161 {
 162     $token = TwitterOAuthClient::unpackToken($flink->credentials);
 163     $client = new TwitterOAuthClient($token->key, $token->secret);
 164
 165     $id = twitter_status_id($notice);
 166
 167     try {
 168         $status = $client->statusesRetweet($id);
 169     } catch (OAuthClientException $e) {
 170         return process_error($e, $flink, $notice);
 171     }
 172 }
 173
 174 function twitter_status_id($notice)
 175 {
 176     if ($notice->source == 'twitter' &&
 177         preg_match('#^http://twitter.com/[\w_.]+/status/(\d+)$#', $notice->uri, $match)) {
 178         return $match[1];
 179     }
 180
 181     return null;
 182 }
 183
 184 /**
 185  * Pull any extra information from a notice that we should transfer over
 186  * to Twitter beyond the notice text itself.
 187  *
 188  * @param Notice $notice
 189  * @return array of key-value pairs for Twitter update submission
 190  * @access private
 191  */
 192 function twitter_update_params($notice)
 193 {
 194     $params = array();
 195     if ($notice->lat || $notice->lon) {
 196         $params['lat'] = $notice->lat;
 197         $params['long'] = $notice->lon;
 198     }
 199     if (!empty($notice->reply_to) && is_twitter_notice($notice->reply_to)) {
 200         $reply = Notice::staticGet('id', $notice->reply_to);
 201         $params['in_reply_to_status_id'] = twitter_status_id($reply);
 202     }
 203     return $params;
 204 }
 205
 206 function broadcast_oauth($notice, $flink) {
 207     $user = $flink->getUser();
 208     $statustxt = format_status($notice);
 209     $params = twitter_update_params($notice);
 210
 211     $token = TwitterOAuthClient::unpackToken($flink->credentials);
 212     $client = new TwitterOAuthClient($token->key, $token->secret);
 213     $status = null;
 214
 215     try {
 216         $status = $client->statusesUpdate($statustxt, $params);
 217     } catch (OAuthClientException $e) {
 218         return process_error($e, $flink, $notice);
 219     }
 220
 221     if (empty($status)) {
 222
 223         // This could represent a failure posting,
 224         // or the Twitter API might just be behaving flakey.
 225
 226         $errmsg = sprintf('Twitter bridge - No data returned by Twitter API when ' .
 227                           'trying to post notice %d for User %s (user id %d).',
 228                           $notice->id,
 229                           $user->nickname,
 230                           $user->id);
 231
 232         common_log(LOG_WARNING, $errmsg);
 233
 234         return false;
 235     }
 236
 237     // Notice crossed the great divide
 238
 239     $msg = sprintf('Twitter bridge - posted notice %d to Twitter using ' .
 240                    'OAuth for User %s (user id %d).',
 241                    $notice->id,
 242                    $user->nickname,
 243                    $user->id);
 244
 245     common_log(LOG_INFO, $msg);
 246
 247     return true;
 248 }
 249
 250 function process_error($e, $flink, $notice)
 251 {
 252     $user = $flink->getUser();
 253     $code = $e->getCode();
 254
 255     $logmsg = sprintf('Twitter bridge - %d posting notice %d for ' .
 256                       'User %s (user id: %d): %s.',
 257                       $code,
 258                       $notice->id,
 259                       $user->nickname,
 260                       $user->id,
 261                       $e->getMessage());
 262
 263     common_log(LOG_WARNING, $logmsg);
 264
 265     switch($code) {
 266      case 401:
 267         // Probably a revoked or otherwise bad access token - nuke!
 268         remove_twitter_link($flink);
 269         return true;
 270         break;
 271      case 403:
 272         // User has exceeder her rate limit -- toss the notice
 273         return true;
 274         break;
 275      default:
 276
 277         // For every other case, it's probably some flakiness so try
 278         // sending the notice again later (requeue).
 279
 280         return false;
 281         break;
 282     }
 283 }
 284
 285 function format_status($notice)
 286 {
 287     // XXX: Hack to get around PHP cURL's use of @ being a a meta character
 288     $statustxt = preg_replace('/^@/', ' @', $notice->content);
 289
 290     // Convert !groups to #hashes
 291
 292     // XXX: Make this an optional setting?
 293
 294     $statustxt = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/', "\\1#\\2", $statustxt);
 295
 296     if (mb_strlen($statustxt) > 140) {
 297         $noticeUrl = common_shorten_url($notice->uri);
 298         $urlLen = mb_strlen($noticeUrl);
 299         $statustxt = mb_substr($statustxt, 0, 140 - ($urlLen + 3)) . ' … ' . $noticeUrl;
 300     }
 301
 302     return $statustxt;
 303 }
 304
 305 function remove_twitter_link($flink)
 306 {
 307     $user = $flink->getUser();
 308
 309     common_log(LOG_INFO, 'Removing Twitter bridge Foreign link for ' .
 310                "user $user->nickname (user id: $user->id).");
 311
 312     $result = $flink->safeDelete();
 313
 314     if (empty($result)) {
 315         common_log(LOG_ERR, 'Could not remove Twitter bridge ' .
 316                    "Foreign_link for $user->nickname (user id: $user->id)!");
 317         common_log_db_error($flink, 'DELETE', __FILE__);
 318     }
 319
 320     // Notify the user that her Twitter bridge is down
 321
 322     if (isset($user->email)) {
 323
 324         $result = mail_twitter_bridge_removed($user);
 325
 326         if (!$result) {
 327
 328             $msg = 'Unable to send email to notify ' .
 329               "$user->nickname (user id: $user->id) " .
 330               'that their Twitter bridge link was ' .
 331               'removed!';
 332
 333             common_log(LOG_WARNING, $msg);
 334         }
 335     }
 336
 337 }
 338
 339 /**
 340  * Send a mail message to notify a user that her Twitter bridge link
 341  * has stopped working, and therefore has been removed.  This can
 342  * happen when the user changes her Twitter password, or otherwise
 343  * revokes access.
 344  *
 345  * @param User $user   user whose Twitter bridge link has been removed
 346  *
 347  * @return boolean success flag
 348  */
 349
 350 function mail_twitter_bridge_removed($user)
 351 {
 352     $profile = $user->getProfile();
 353
 354     common_switch_locale($user->language);
 355
 356     $subject = sprintf(_m('Your Twitter bridge has been disabled.'));
 357
 358     $site_name = common_config('site', 'name');
 359
 360     $body = sprintf(_m('Hi, %1$s. We\'re sorry to inform you that your ' .
 361         'link to Twitter has been disabled. We no longer seem to have ' .
 362     'permission to update your Twitter status. (Did you revoke ' .
 363     '%3$s\'s access?)' . "\n\n" .
 364     'You can re-enable your Twitter bridge by visiting your ' .
 365     "Twitter settings page:\n\n\t%2\$s\n\n" .
 366         "Regards,\n%3\$s\n"),
 367         $profile->getBestName(),
 368         common_local_url('twittersettings'),
 369         common_config('site', 'name'));
 370
 371     common_switch_locale();
 372     return mail_to_user($user, $subject, $body);
 373 }
 374