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