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/twitterbasicauthclient.php';
27 require_once INSTALLDIR . '/plugins/TwitterBridge/twitteroauthclient.php';
29 function add_twitter_user($twitter_id, $screen_name)
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.
35 $luser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
38 $result = $luser->delete();
39 if ($result != false) {
42 "Twitter bridge - removed old Twitter user: $screen_name ($twitter_id)."
47 $fuser = new Foreign_user();
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();
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__);
62 "Twitter bridge - Added new Twitter user: $screen_name ($twitter_id).");
68 // Creates or Updates a Twitter user
69 function save_twitter_user($twitter_id, $screen_name)
71 // Check to see whether the Twitter user is already in the system,
72 // and update its screen name and uri if so.
74 $fuser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
78 // Delete old record if Twitter user changed screen name
80 if ($fuser->nickname != $screen_name) {
81 $oldname = $fuser->nickname;
83 common_log(LOG_INFO, sprintf('Twitter bridge - Updated nickname (and URI) ' .
84 'for Twitter user %1$d - %2$s, was %3$s.',
92 // Kill any old, invalid records for this screen name
94 $fuser = Foreign_user::getByNickname($screen_name, TWITTER_SERVICE);
101 'Twitter bridge - deteted old record for Twitter ' .
102 'screen name "%s" belonging to Twitter ID %d.',
110 return add_twitter_user($twitter_id, $screen_name);
113 function is_twitter_bound($notice, $flink) {
115 // Check to see if notice should go to Twitter
116 if (!empty($flink) && ($flink->noticesync & FOREIGN_NOTICE_SEND)) {
118 // If it's not a Twitter-style reply, or if the user WANTS to send replies.
119 if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
120 ($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY)) {
128 function broadcast_twitter($notice)
130 $flink = Foreign_link::getByUserID($notice->profile_id,
133 if (is_twitter_bound($notice, $flink)) {
134 if (TwitterOAuthClient::isPackedToken($flink->credentials)) {
135 return broadcast_oauth($notice, $flink);
137 return broadcast_basicauth($notice, $flink);
145 * Pull any extra information from a notice that we should transfer over
146 * to Twitter beyond the notice text itself.
148 * @param Notice $notice
149 * @return array of key-value pairs for Twitter update submission
152 function twitter_update_params($notice)
155 if ($notice->lat || $notice->lon) {
156 $params['lat'] = $notice->lat;
157 $params['long'] = $notice->lon;
163 function broadcast_oauth($notice, $flink) {
164 $user = $flink->getUser();
165 $statustxt = format_status($notice);
166 $params = twitter_update_params($notice);
168 $token = TwitterOAuthClient::unpackToken($flink->credentials);
169 $client = new TwitterOAuthClient($token->key, $token->secret);
173 $status = $client->statusesUpdate($statustxt, $params);
174 } catch (OAuthClientException $e) {
175 return process_error($e, $flink, $notice);
178 if (empty($status)) {
180 // This could represent a failure posting,
181 // or the Twitter API might just be behaving flakey.
183 $errmsg = sprintf('Twitter bridge - No data returned by Twitter API when ' .
184 'trying to post notice %d for User %s (user id %d).',
189 common_log(LOG_WARNING, $errmsg);
194 // Notice crossed the great divide
196 $msg = sprintf('Twitter bridge - posted notice %d to Twitter using ' .
197 'OAuth for User %s (user id %d).',
202 common_log(LOG_INFO, $msg);
207 function broadcast_basicauth($notice, $flink)
209 $user = $flink->getUser();
211 $statustxt = format_status($notice);
212 $params = twitter_update_params($notice);
214 $client = new TwitterBasicAuthClient($flink);
218 $status = $client->statusesUpdate($statustxt, $params);
219 } catch (BasicAuthException $e) {
220 return process_error($e, $flink, $notice);
223 if (empty($status)) {
225 $errmsg = sprintf('Twitter bridge - No data returned by Twitter API when ' .
226 'trying to post notice %d for %s (user id %d).',
231 common_log(LOG_WARNING, $errmsg);
233 $errmsg = sprintf('No data returned by Twitter API when ' .
234 'trying to post notice %d for %s (user id %d).',
238 common_log(LOG_WARNING, $errmsg);
242 $msg = sprintf('Twitter bridge - posted notice %d to Twitter using ' .
243 'HTTP basic auth for User %s (user id %d).',
248 common_log(LOG_INFO, $msg);
253 function process_error($e, $flink, $notice)
255 $user = $flink->getUser();
256 $code = $e->getCode();
258 $logmsg = sprintf('Twitter bridge - %d posting notice %d for ' .
259 'User %s (user id: %d): %s.',
266 common_log(LOG_WARNING, $logmsg);
270 // Probably a revoked or otherwise bad access token - nuke!
271 remove_twitter_link($flink);
275 // User has exceeder her rate limit -- toss the notice
280 // For every other case, it's probably some flakiness so try
281 // sending the notice again later (requeue).
288 function format_status($notice)
290 // XXX: Hack to get around PHP cURL's use of @ being a a meta character
291 $statustxt = preg_replace('/^@/', ' @', $notice->content);
293 // Convert !groups to #hashes
295 // XXX: Make this an optional setting?
297 $statustxt = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/', "\\1#\\2", $statustxt);
299 if (mb_strlen($statustxt) > 140) {
300 $noticeUrl = common_shorten_url($notice->uri);
301 $urlLen = mb_strlen($noticeUrl);
302 $statustxt = mb_substr($statustxt, 0, 140 - ($urlLen + 3)) . ' … ' . $noticeUrl;
308 function remove_twitter_link($flink)
310 $user = $flink->getUser();
312 common_log(LOG_INFO, 'Removing Twitter bridge Foreign link for ' .
313 "user $user->nickname (user id: $user->id).");
315 $result = $flink->safeDelete();
317 if (empty($result)) {
318 common_log(LOG_ERR, 'Could not remove Twitter bridge ' .
319 "Foreign_link for $user->nickname (user id: $user->id)!");
320 common_log_db_error($flink, 'DELETE', __FILE__);
323 // Notify the user that her Twitter bridge is down
325 if (isset($user->email)) {
327 $result = mail_twitter_bridge_removed($user);
331 $msg = 'Unable to send email to notify ' .
332 "$user->nickname (user id: $user->id) " .
333 'that their Twitter bridge link was ' .
336 common_log(LOG_WARNING, $msg);
343 * Send a mail message to notify a user that her Twitter bridge link
344 * has stopped working, and therefore has been removed. This can
345 * happen when the user changes her Twitter password, or otherwise
348 * @param User $user user whose Twitter bridge link has been removed
350 * @return boolean success flag
353 function mail_twitter_bridge_removed($user)
355 $profile = $user->getProfile();
357 common_switch_locale($user->language);
359 $subject = sprintf(_m('Your Twitter bridge has been disabled.'));
361 $site_name = common_config('site', 'name');
363 $body = sprintf(_m('Hi, %1$s. We\'re sorry to inform you that your ' .
364 'link to Twitter has been disabled. We no longer seem to have ' .
365 'permission to update your Twitter status. (Did you revoke ' .
366 '%3$s\'s access?)' . "\n\n" .
367 'You can re-enable your Twitter bridge by visiting your ' .
368 "Twitter settings page:\n\n\t%2\$s\n\n" .
369 "Regards,\n%3\$s\n"),
370 $profile->getBestName(),
371 common_local_url('twittersettings'),
372 common_config('site', 'name'));
374 common_switch_locale();
375 return mail_to_user($user, $subject, $body);