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