3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008-2010 StatusNet, Inc.
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.
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.
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/>.
20 if (!defined('STATUSNET') && !defined('LACONICA')) {
24 define('TWITTER_SERVICE', 1); // Twitter is foreign_service ID 1
26 require_once INSTALLDIR . '/plugins/TwitterBridge/twitteroauthclient.php';
28 function add_twitter_user($twitter_id, $screen_name)
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.
34 $luser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
37 $result = $luser->delete();
38 if ($result != false) {
41 "Twitter bridge - removed old Twitter user: $screen_name ($twitter_id)."
46 $fuser = new Foreign_user();
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();
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__);
61 "Twitter bridge - Added new Twitter user: $screen_name ($twitter_id).");
67 // Creates or Updates a Twitter user
68 function save_twitter_user($twitter_id, $screen_name)
70 // Check to see whether the Twitter user is already in the system,
71 // and update its screen name and uri if so.
73 $fuser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
77 // Delete old record if Twitter user changed screen name
79 if ($fuser->nickname != $screen_name) {
80 $oldname = $fuser->nickname;
82 common_log(LOG_INFO, sprintf('Twitter bridge - Updated nickname (and URI) ' .
83 'for Twitter user %1$d - %2$s, was %3$s.',
91 // Kill any old, invalid records for this screen name
93 $fuser = Foreign_user::getByNickname($screen_name, TWITTER_SERVICE);
100 'Twitter bridge - deteted old record for Twitter ' .
101 'screen name "%s" belonging to Twitter ID %d.',
109 return add_twitter_user($twitter_id, $screen_name);
112 function is_twitter_bound($notice, $flink) {
114 // Check to see if notice should go to Twitter
115 if (!empty($flink) && ($flink->noticesync & FOREIGN_NOTICE_SEND)) {
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
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)) {
130 function is_twitter_notice($id)
132 $n2s = Notice_to_status::staticGet('notice_id', $id);
134 return (!empty($n2s));
137 function broadcast_twitter($notice)
139 $flink = Foreign_link::getByUserID($notice->profile_id,
142 // Don't bother with basic auth, since it's no longer allowed
144 if (!empty($flink) && TwitterOAuthClient::isPackedToken($flink->credentials)) {
145 if (!empty($notice->repeat_of) && is_twitter_notice($notice->repeat_of)) {
146 $retweet = retweet_notice($flink, Notice::staticGet('id', $notice->repeat_of));
147 if (!empty($retweet)) {
148 Notice_to_status::saveNew($notice->id, $retweet->id);
150 } else if (is_twitter_bound($notice, $flink)) {
151 return broadcast_oauth($notice, $flink);
158 function retweet_notice($flink, $notice)
160 $token = TwitterOAuthClient::unpackToken($flink->credentials);
161 $client = new TwitterOAuthClient($token->key, $token->secret);
163 $id = twitter_status_id($notice);
166 common_log(LOG_WARNING, "Trying to retweet notice {$notice->id} with no known status id.");
171 $status = $client->statusesRetweet($id);
173 } catch (OAuthClientException $e) {
174 return process_error($e, $flink, $notice);
178 function twitter_status_id($notice)
180 $n2s = Notice_to_status::staticGet('notice_id', $notice->id);
184 return $n2s->status_id;
189 * Pull any extra information from a notice that we should transfer over
190 * to Twitter beyond the notice text itself.
192 * @param Notice $notice
193 * @return array of key-value pairs for Twitter update submission
196 function twitter_update_params($notice)
199 if ($notice->lat || $notice->lon) {
200 $params['lat'] = $notice->lat;
201 $params['long'] = $notice->lon;
203 if (!empty($notice->reply_to) && is_twitter_notice($notice->reply_to)) {
204 $reply = Notice::staticGet('id', $notice->reply_to);
205 $params['in_reply_to_status_id'] = twitter_status_id($reply);
210 function broadcast_oauth($notice, $flink) {
211 $user = $flink->getUser();
212 $statustxt = format_status($notice);
213 $params = twitter_update_params($notice);
215 $token = TwitterOAuthClient::unpackToken($flink->credentials);
216 $client = new TwitterOAuthClient($token->key, $token->secret);
220 $status = $client->statusesUpdate($statustxt, $params);
221 if (!empty($status)) {
222 Notice_to_status::saveNew($notice->id, $status->id);
224 } catch (OAuthClientException $e) {
225 return process_error($e, $flink, $notice);
228 if (empty($status)) {
230 // This could represent a failure posting,
231 // or the Twitter API might just be behaving flakey.
233 $errmsg = sprintf('Twitter bridge - No data returned by Twitter API when ' .
234 'trying to post notice %d for User %s (user id %d).',
239 common_log(LOG_WARNING, $errmsg);
244 // Notice crossed the great divide
246 $msg = sprintf('Twitter bridge - posted notice %d to Twitter using ' .
247 'OAuth for User %s (user id %d).',
252 common_log(LOG_INFO, $msg);
257 function process_error($e, $flink, $notice)
259 $user = $flink->getUser();
260 $code = $e->getCode();
262 $logmsg = sprintf('Twitter bridge - %d posting notice %d for ' .
263 'User %s (user id: %d): %s.',
270 common_log(LOG_WARNING, $logmsg);
274 // Probably a revoked or otherwise bad access token - nuke!
275 remove_twitter_link($flink);
279 // User has exceeder her rate limit -- toss the notice
284 // For every other case, it's probably some flakiness so try
285 // sending the notice again later (requeue).
292 function format_status($notice)
294 // XXX: Hack to get around PHP cURL's use of @ being a a meta character
295 $statustxt = preg_replace('/^@/', ' @', $notice->content);
297 // Convert !groups to #hashes
299 // XXX: Make this an optional setting?
301 $statustxt = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/', "\\1#\\2", $statustxt);
303 if (mb_strlen($statustxt) > 140) {
304 $noticeUrl = common_shorten_url($notice->uri);
305 $urlLen = mb_strlen($noticeUrl);
306 $statustxt = mb_substr($statustxt, 0, 140 - ($urlLen + 3)) . ' … ' . $noticeUrl;
312 function remove_twitter_link($flink)
314 $user = $flink->getUser();
316 common_log(LOG_INFO, 'Removing Twitter bridge Foreign link for ' .
317 "user $user->nickname (user id: $user->id).");
319 $result = $flink->safeDelete();
321 if (empty($result)) {
322 common_log(LOG_ERR, 'Could not remove Twitter bridge ' .
323 "Foreign_link for $user->nickname (user id: $user->id)!");
324 common_log_db_error($flink, 'DELETE', __FILE__);
327 // Notify the user that her Twitter bridge is down
329 if (isset($user->email)) {
331 $result = mail_twitter_bridge_removed($user);
335 $msg = 'Unable to send email to notify ' .
336 "$user->nickname (user id: $user->id) " .
337 'that their Twitter bridge link was ' .
340 common_log(LOG_WARNING, $msg);
347 * Send a mail message to notify a user that her Twitter bridge link
348 * has stopped working, and therefore has been removed. This can
349 * happen when the user changes her Twitter password, or otherwise
352 * @param User $user user whose Twitter bridge link has been removed
354 * @return boolean success flag
357 function mail_twitter_bridge_removed($user)
359 $profile = $user->getProfile();
361 common_switch_locale($user->language);
363 $subject = sprintf(_m('Your Twitter bridge has been disabled.'));
365 $site_name = common_config('site', 'name');
367 $body = sprintf(_m('Hi, %1$s. We\'re sorry to inform you that your ' .
368 'link to Twitter has been disabled. We no longer seem to have ' .
369 'permission to update your Twitter status. (Did you revoke ' .
370 '%3$s\'s access?)' . "\n\n" .
371 'You can re-enable your Twitter bridge by visiting your ' .
372 "Twitter settings page:\n\n\t%2\$s\n\n" .
373 "Regards,\n%3\$s\n"),
374 $profile->getBestName(),
375 common_local_url('twittersettings'),
376 common_config('site', 'name'));
378 common_switch_locale();
379 return mail_to_user($user, $subject, $body);