3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008-2011 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 function add_twitter_user($twitter_id, $screen_name)
28 // Clear out any bad old foreign_users with the new user's legit URL
29 // This can happen when users move around or fakester accounts get
30 // repoed, and things like that.
31 $luser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
34 $result = $luser->delete();
35 if ($result != false) {
38 "Twitter bridge - removed old Twitter user: $screen_name ($twitter_id)."
43 $fuser = new Foreign_user();
45 $fuser->nickname = $screen_name;
46 $fuser->uri = 'http://twitter.com/' . $screen_name;
47 $fuser->id = $twitter_id;
48 $fuser->service = TWITTER_SERVICE;
49 $fuser->created = common_sql_now();
50 $result = $fuser->insert();
53 common_log(LOG_WARNING,
54 "Twitter bridge - failed to add new Twitter user: $twitter_id - $screen_name.");
55 common_log_db_error($fuser, 'INSERT', __FILE__);
58 "Twitter bridge - Added new Twitter user: $screen_name ($twitter_id).");
64 // Creates or Updates a Twitter user
65 function save_twitter_user($twitter_id, $screen_name)
67 // Check to see whether the Twitter user is already in the system,
68 // and update its screen name and uri if so.
69 $fuser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
72 // Delete old record if Twitter user changed screen name
74 if ($fuser->nickname != $screen_name) {
75 $oldname = $fuser->nickname;
77 common_log(LOG_INFO, sprintf('Twitter bridge - Updated nickname (and URI) ' .
78 'for Twitter user %1$d - %2$s, was %3$s.',
84 // Kill any old, invalid records for this screen name
85 $fuser = Foreign_user::getByNickname($screen_name, TWITTER_SERVICE);
92 'Twitter bridge - deteted old record for Twitter ' .
93 'screen name "%s" belonging to Twitter ID %d.',
101 return add_twitter_user($twitter_id, $screen_name);
104 function is_twitter_bound($notice, $flink) {
106 // Don't send activity activities (at least for now)
107 if ($notice->object_type == ActivityObject::ACTIVITY) {
111 $allowedVerbs = array(ActivityVerb::POST, ActivityVerb::SHARE);
113 // Don't send things that aren't posts or repeats (at least for now)
114 if (!in_array($notice->verb, $allowedVerbs)) {
118 // Check to see if notice should go to Twitter
119 if (!empty($flink) && ($flink->noticesync & FOREIGN_NOTICE_SEND == FOREIGN_NOTICE_SEND)) {
121 // If it's not a Twitter-style reply, or if the user WANTS to send replies,
122 // or if it's in reply to a twitter notice
123 if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
124 ($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY == FOREIGN_NOTICE_SEND_REPLY) ||
125 is_twitter_notice($notice->reply_to)) {
133 function is_twitter_notice($id)
135 $n2s = Notice_to_status::staticGet('notice_id', $id);
137 return (!empty($n2s));
141 * Pull the formatted status ID number from a Twitter status object
142 * returned via JSON from Twitter API.
144 * Encapsulates checking for the id_str attribute, which is required
145 * to read 64-bit "Snowflake" ID numbers on a 32-bit system -- the
146 * integer id attribute gets corrupted into a double-precision float,
147 * losing a few digits of precision.
149 * Warning: avoid performing arithmetic or direct comparisons with
150 * this number, as it may get coerced back to a double on 32-bit.
152 * @param object $status
153 * @param string $field base field name if not 'id'
154 * @return mixed id number as int or string
156 function twitter_id($status, $field='id')
158 $field_str = "{$field}_str";
159 if (isset($status->$field_str)) {
160 // String version of the id -- required on 32-bit systems
161 // since the 64-bit numbers get corrupted as ints.
162 return $status->$field_str;
164 return $status->$field;
169 * Check if we need to broadcast a notice over the Twitter bridge, and
170 * do so if necessary. Will determine whether to do a straight post or
173 * This function is meant to be called directly from TwitterQueueHandler.
175 * @param Notice $notice
176 * @return boolean true if complete or successful, false if we should retry
178 function broadcast_twitter($notice)
180 $flink = Foreign_link::getByUserID($notice->profile_id,
183 // Don't bother with basic auth, since it's no longer allowed
184 if (!empty($flink) && TwitterOAuthClient::isPackedToken($flink->credentials)) {
185 if (is_twitter_bound($notice, $flink)) {
186 if (!empty($notice->repeat_of) && is_twitter_notice($notice->repeat_of)) {
187 $retweet = retweet_notice($flink, Notice::staticGet('id', $notice->repeat_of));
188 if (is_object($retweet)) {
189 Notice_to_status::saveNew($notice->id, twitter_id($retweet));
192 // Our error processing will have decided if we need to requeue
193 // this or can discard safely.
197 return broadcast_oauth($notice, $flink);
206 * Send a retweet to Twitter for a notice that has been previously bridged
209 * Warning: the return value is not guaranteed to be an object; some error
210 * conditions will return a 'true' which should be passed on to a calling
213 * No local information about the resulting retweet is saved: it's up to
214 * caller to save new mappings etc if appropriate.
216 * @param Foreign_link $flink
217 * @param Notice $notice
218 * @return mixed object with resulting Twitter status data on success, or true/false/null on error conditions.
220 function retweet_notice($flink, $notice)
222 $token = TwitterOAuthClient::unpackToken($flink->credentials);
223 $client = new TwitterOAuthClient($token->key, $token->secret);
225 $id = twitter_status_id($notice);
228 common_log(LOG_WARNING, "Trying to retweet notice {$notice->id} with no known status id.");
233 $status = $client->statusesRetweet($id);
235 } catch (OAuthClientException $e) {
236 return process_error($e, $flink, $notice);
240 function twitter_status_id($notice)
242 $n2s = Notice_to_status::staticGet('notice_id', $notice->id);
246 return $n2s->status_id;
251 * Pull any extra information from a notice that we should transfer over
252 * to Twitter beyond the notice text itself.
254 * @param Notice $notice
255 * @return array of key-value pairs for Twitter update submission
258 function twitter_update_params($notice)
261 if ($notice->lat || $notice->lon) {
262 $params['lat'] = $notice->lat;
263 $params['long'] = $notice->lon;
265 if (!empty($notice->reply_to) && is_twitter_notice($notice->reply_to)) {
266 $reply = Notice::staticGet('id', $notice->reply_to);
267 $params['in_reply_to_status_id'] = twitter_status_id($reply);
272 function broadcast_oauth($notice, $flink) {
273 $user = $flink->getUser();
274 $statustxt = format_status($notice);
275 $params = twitter_update_params($notice);
277 $token = TwitterOAuthClient::unpackToken($flink->credentials);
278 $client = new TwitterOAuthClient($token->key, $token->secret);
282 $status = $client->statusesUpdate($statustxt, $params);
283 if (!empty($status)) {
284 Notice_to_status::saveNew($notice->id, twitter_id($status));
286 } catch (OAuthClientException $e) {
287 return process_error($e, $flink, $notice);
290 if (empty($status)) {
291 // This could represent a failure posting,
292 // or the Twitter API might just be behaving flakey.
293 $errmsg = sprintf('Twitter bridge - No data returned by Twitter API when ' .
294 'trying to post notice %d for User %s (user id %d).',
299 common_log(LOG_WARNING, $errmsg);
304 // Notice crossed the great divide
305 $msg = sprintf('Twitter bridge - posted notice %d to Twitter using ' .
306 'OAuth for User %s (user id %d).',
311 common_log(LOG_INFO, $msg);
316 function process_error($e, $flink, $notice)
318 $user = $flink->getUser();
319 $code = $e->getCode();
321 $logmsg = sprintf('Twitter bridge - %d posting notice %d for ' .
322 'User %s (user id: %d): %s.',
329 common_log(LOG_WARNING, $logmsg);
331 // http://dev.twitter.com/pages/responses_errors
334 // Probably invalid data (bad Unicode chars or coords) that
335 // cannot be resolved by just sending again.
337 // It could also be rate limiting, but retrying immediately
338 // won't help much with that, so we'll discard for now.
339 // If a facility for retrying things later comes up in future,
340 // we can detect the rate-limiting headers and use that.
342 // Discard the message permanently.
346 // Probably a revoked or otherwise bad access token - nuke!
347 remove_twitter_link($flink);
351 // User has exceeder her rate limit -- toss the notice
355 // Resource not found. Shouldn't happen much on posting,
358 // Consider it a matter for tossing the notice.
363 // For every other case, it's probably some flakiness so try
364 // sending the notice again later (requeue).
371 function format_status($notice)
373 // Start with the plaintext source of this notice...
374 $statustxt = $notice->content;
376 // Convert !groups to #hashes
377 // XXX: Make this an optional setting?
378 $statustxt = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/', "\\1#\\2", $statustxt);
380 // Twitter still has a 140-char hardcoded max.
381 if (mb_strlen($statustxt) > 140) {
382 $noticeUrl = common_shorten_url($notice->uri);
383 $urlLen = mb_strlen($noticeUrl);
384 $statustxt = mb_substr($statustxt, 0, 140 - ($urlLen + 3)) . ' … ' . $noticeUrl;
390 function remove_twitter_link($flink)
392 $user = $flink->getUser();
394 common_log(LOG_INFO, 'Removing Twitter bridge Foreign link for ' .
395 "user $user->nickname (user id: $user->id).");
397 $result = $flink->safeDelete();
399 if (empty($result)) {
400 common_log(LOG_ERR, 'Could not remove Twitter bridge ' .
401 "Foreign_link for $user->nickname (user id: $user->id)!");
402 common_log_db_error($flink, 'DELETE', __FILE__);
405 // Notify the user that her Twitter bridge is down
407 if (isset($user->email)) {
408 $result = mail_twitter_bridge_removed($user);
411 $msg = 'Unable to send email to notify ' .
412 "$user->nickname (user id: $user->id) " .
413 'that their Twitter bridge link was ' .
416 common_log(LOG_WARNING, $msg);
422 * Send a mail message to notify a user that her Twitter bridge link
423 * has stopped working, and therefore has been removed. This can
424 * happen when the user changes her Twitter password, or otherwise
427 * @param User $user user whose Twitter bridge link has been removed
429 * @return boolean success flag
431 function mail_twitter_bridge_removed($user)
433 $profile = $user->getProfile();
435 common_switch_locale($user->language);
437 // TRANS: Mail subject after forwarding notices to Twitter has stopped working.
438 $subject = sprintf(_m('Your Twitter bridge has been disabled'));
440 $site_name = common_config('site', 'name');
442 // TRANS: Mail body after forwarding notices to Twitter has stopped working.
443 // TRANS: %1$ is the name of the user the mail is sent to, %2$s is a URL to the
444 // TRANS: Twitter settings, %3$s is the StatusNet sitename.
445 $body = sprintf(_m('Hi, %1$s. We\'re sorry to inform you that your ' .
446 'link to Twitter has been disabled. We no longer seem to have ' .
447 'permission to update your Twitter status. Did you maybe revoke ' .
448 '%3$s\'s access?' . "\n\n" .
449 'You can re-enable your Twitter bridge by visiting your ' .
450 "Twitter settings page:\n\n\t%2\$s\n\n" .
452 $profile->getBestName(),
453 common_local_url('twittersettings'),
454 common_config('site', 'name'));
456 common_switch_locale();
457 return mail_to_user($user, $subject, $body);