<?php
/*
* StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2008-2010 StatusNet, Inc.
+ * Copyright (C) 2008-2011 StatusNet, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
define('TWITTER_SERVICE', 1); // Twitter is foreign_service ID 1
-require_once INSTALLDIR . '/plugins/TwitterBridge/twitterbasicauthclient.php';
-require_once INSTALLDIR . '/plugins/TwitterBridge/twitteroauthclient.php';
-
function add_twitter_user($twitter_id, $screen_name)
{
// Clear out any bad old foreign_users with the new user's legit URL
// This can happen when users move around or fakester accounts get
// repoed, and things like that.
-
$luser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
if (!empty($luser)) {
{
// Check to see whether the Twitter user is already in the system,
// and update its screen name and uri if so.
-
$fuser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
if (!empty($fuser)) {
-
- $result = true;
-
// Delete old record if Twitter user changed screen name
if ($fuser->nickname != $screen_name) {
$screen_name,
$oldname));
}
+ } else {
+ // Kill any old, invalid records for this screen name
+ $fuser = Foreign_user::getByNickname($screen_name, TWITTER_SERVICE);
+
+ if (!empty($fuser)) {
+ $fuser->delete();
+ common_log(
+ LOG_INFO,
+ sprintf(
+ 'Twitter bridge - deteted old record for Twitter ' .
+ 'screen name "%s" belonging to Twitter ID %d.',
+ $screen_name,
+ $fuser->id
+ )
+ );
+ }
}
return add_twitter_user($twitter_id, $screen_name);
function is_twitter_bound($notice, $flink) {
- // Check to see if notice should go to Twitter
- if (!empty($flink) && ($flink->noticesync & FOREIGN_NOTICE_SEND)) {
+ // Don't send activity activities (at least for now)
+ if ($notice->object_type == ActivityObject::ACTIVITY) {
+ return false;
+ }
+
+ $allowedVerbs = array(ActivityVerb::POST, ActivityVerb::SHARE);
- // If it's not a Twitter-style reply, or if the user WANTS to send replies.
- if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
- ($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY)) {
+ // Don't send things that aren't posts or repeats (at least for now)
+ if (!in_array($notice->verb, $allowedVerbs)) {
+ return false;
+ }
+
+ // Check to see if notice should go to Twitter
+ if (!empty($flink) && (($flink->noticesync & FOREIGN_NOTICE_SEND) == FOREIGN_NOTICE_SEND)) {
+
+ // If it's not a Twitter-style reply, or if the user WANTS to send replies,
+ // or if it's in reply to a twitter notice
+ if ( (($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) == FOREIGN_NOTICE_SEND_REPLY) ||
+ ((is_twitter_notice($notice->reply_to) || is_twitter_notice($notice->repeat_of))
+ && (($flink->noticesync & FOREIGN_NOTICE_RECV) == FOREIGN_NOTICE_RECV)) ||
+ (empty($notice->reply_to) && !preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content)) ){
return true;
}
}
return false;
}
+function is_twitter_notice($id)
+{
+ $n2s = Notice_to_status::getKV('notice_id', $id);
+
+ return (!empty($n2s));
+}
+
+/**
+ * Pull the formatted status ID number from a Twitter status object
+ * returned via JSON from Twitter API.
+ *
+ * Encapsulates checking for the id_str attribute, which is required
+ * to read 64-bit "Snowflake" ID numbers on a 32-bit system -- the
+ * integer id attribute gets corrupted into a double-precision float,
+ * losing a few digits of precision.
+ *
+ * Warning: avoid performing arithmetic or direct comparisons with
+ * this number, as it may get coerced back to a double on 32-bit.
+ *
+ * @param object $status
+ * @param string $field base field name if not 'id'
+ * @return mixed id number as int or string
+ */
+function twitter_id($status, $field='id')
+{
+ $field_str = "{$field}_str";
+ if (isset($status->$field_str)) {
+ // String version of the id -- required on 32-bit systems
+ // since the 64-bit numbers get corrupted as ints.
+ return $status->$field_str;
+ } else {
+ return $status->$field;
+ }
+}
+
+/**
+ * Check if we need to broadcast a notice over the Twitter bridge, and
+ * do so if necessary. Will determine whether to do a straight post or
+ * a repeat/retweet
+ *
+ * This function is meant to be called directly from TwitterQueueHandler.
+ *
+ * @param Notice $notice
+ * @return boolean true if complete or successful, false if we should retry
+ */
function broadcast_twitter($notice)
{
$flink = Foreign_link::getByUserID($notice->profile_id,
TWITTER_SERVICE);
- if (is_twitter_bound($notice, $flink)) {
- if (TwitterOAuthClient::isPackedToken($flink->credentials)) {
- return broadcast_oauth($notice, $flink);
- } else {
- return broadcast_basicauth($notice, $flink);
+ // Don't bother with basic auth, since it's no longer allowed
+ if (!empty($flink) && TwitterOAuthClient::isPackedToken($flink->credentials)) {
+ if (is_twitter_bound($notice, $flink)) {
+ if (!empty($notice->repeat_of) && is_twitter_notice($notice->repeat_of)) {
+ $retweet = retweet_notice($flink, Notice::getKV('id', $notice->repeat_of));
+ if (is_object($retweet)) {
+ Notice_to_status::saveNew($notice->id, twitter_id($retweet));
+ return true;
+ } else {
+ // Our error processing will have decided if we need to requeue
+ // this or can discard safely.
+ return $retweet;
+ }
+ } else {
+ return broadcast_oauth($notice, $flink);
+ }
}
}
return true;
}
-function broadcast_oauth($notice, $flink) {
- $user = $flink->getUser();
- $statustxt = format_status($notice);
+/**
+ * Send a retweet to Twitter for a notice that has been previously bridged
+ * in or out.
+ *
+ * Warning: the return value is not guaranteed to be an object; some error
+ * conditions will return a 'true' which should be passed on to a calling
+ * queue handler.
+ *
+ * No local information about the resulting retweet is saved: it's up to
+ * caller to save new mappings etc if appropriate.
+ *
+ * @param Foreign_link $flink
+ * @param Notice $notice
+ * @return mixed object with resulting Twitter status data on success, or true/false/null on error conditions.
+ */
+function retweet_notice($flink, $notice)
+{
$token = TwitterOAuthClient::unpackToken($flink->credentials);
$client = new TwitterOAuthClient($token->key, $token->secret);
- $status = null;
+
+ $id = twitter_status_id($notice);
+
+ if (empty($id)) {
+ common_log(LOG_WARNING, "Trying to retweet notice {$notice->id} with no known status id.");
+ return null;
+ }
try {
- $status = $client->statusesUpdate($statustxt);
+ $status = $client->statusesRetweet($id);
+ return $status;
} catch (OAuthClientException $e) {
return process_error($e, $flink, $notice);
}
+}
- if (empty($status)) {
-
- // This could represent a failure posting,
- // or the Twitter API might just be behaving flakey.
-
- $errmsg = sprintf('Twitter bridge - No data returned by Twitter API when ' .
- 'trying to post notice %d for User %s (user id %d).',
- $notice->id,
- $user->nickname,
- $user->id);
-
- common_log(LOG_WARNING, $errmsg);
-
- return false;
+function twitter_status_id($notice)
+{
+ $n2s = Notice_to_status::getKV('notice_id', $notice->id);
+ if (empty($n2s)) {
+ return null;
+ } else {
+ return $n2s->status_id;
}
-
- // Notice crossed the great divide
-
- $msg = sprintf('Twitter bridge - posted notice %d to Twitter using ' .
- 'OAuth for User %s (user id %d).',
- $notice->id,
- $user->nickname,
- $user->id);
-
- common_log(LOG_INFO, $msg);
-
- return true;
}
-function broadcast_basicauth($notice, $flink)
+/**
+ * Pull any extra information from a notice that we should transfer over
+ * to Twitter beyond the notice text itself.
+ *
+ * @param Notice $notice
+ * @return array of key-value pairs for Twitter update submission
+ * @access private
+ */
+function twitter_update_params($notice)
{
- $user = $flink->getUser();
+ $params = array();
+ if ($notice->lat || $notice->lon) {
+ $params['lat'] = $notice->lat;
+ $params['long'] = $notice->lon;
+ }
+ if (!empty($notice->reply_to) && is_twitter_notice($notice->reply_to)) {
+ $reply = Notice::getKV('id', $notice->reply_to);
+ $params['in_reply_to_status_id'] = twitter_status_id($reply);
+ }
+ return $params;
+}
+function broadcast_oauth($notice, $flink) {
+ $user = $flink->getUser();
$statustxt = format_status($notice);
+ $params = twitter_update_params($notice);
- $client = new TwitterBasicAuthClient($flink);
+ $token = TwitterOAuthClient::unpackToken($flink->credentials);
+ $client = new TwitterOAuthClient($token->key, $token->secret);
$status = null;
try {
- $status = $client->statusesUpdate($statustxt);
- } catch (BasicAuthException $e) {
+ $status = $client->statusesUpdate($statustxt, $params);
+ if (!empty($status)) {
+ Notice_to_status::saveNew($notice->id, twitter_id($status));
+ }
+ } catch (OAuthClientException $e) {
return process_error($e, $flink, $notice);
}
if (empty($status)) {
-
+ // This could represent a failure posting,
+ // or the Twitter API might just be behaving flakey.
$errmsg = sprintf('Twitter bridge - No data returned by Twitter API when ' .
- 'trying to post notice %d for %s (user id %d).',
+ 'trying to post notice %d for User %s (user id %d).',
$notice->id,
$user->nickname,
$user->id);
common_log(LOG_WARNING, $errmsg);
- $errmsg = sprintf('No data returned by Twitter API when ' .
- 'trying to post notice %d for %s (user id %d).',
- $notice->id,
- $user->nickname,
- $user->id);
- common_log(LOG_WARNING, $errmsg);
return false;
}
+ // Notice crossed the great divide
$msg = sprintf('Twitter bridge - posted notice %d to Twitter using ' .
- 'HTTP basic auth for User %s (user id %d).',
+ 'OAuth for User %s (user id %d).',
$notice->id,
$user->nickname,
$user->id);
common_log(LOG_WARNING, $logmsg);
+ // http://dev.twitter.com/pages/responses_errors
switch($code) {
+ case 400:
+ // Probably invalid data (bad Unicode chars or coords) that
+ // cannot be resolved by just sending again.
+ //
+ // It could also be rate limiting, but retrying immediately
+ // won't help much with that, so we'll discard for now.
+ // If a facility for retrying things later comes up in future,
+ // we can detect the rate-limiting headers and use that.
+ //
+ // Discard the message permanently.
+ return true;
+ break;
case 401:
// Probably a revoked or otherwise bad access token - nuke!
remove_twitter_link($flink);
// User has exceeder her rate limit -- toss the notice
return true;
break;
+ case 404:
+ // Resource not found. Shouldn't happen much on posting,
+ // but just in case!
+ //
+ // Consider it a matter for tossing the notice.
+ return true;
+ break;
default:
// For every other case, it's probably some flakiness so try
function format_status($notice)
{
- // XXX: Hack to get around PHP cURL's use of @ being a a meta character
- $statustxt = preg_replace('/^@/', ' @', $notice->content);
+ // Start with the plaintext source of this notice...
+ $statustxt = $notice->content;
// Convert !groups to #hashes
-
// XXX: Make this an optional setting?
-
$statustxt = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/', "\\1#\\2", $statustxt);
+ // Twitter still has a 140-char hardcoded max.
if (mb_strlen($statustxt) > 140) {
- $noticeUrl = common_shorten_url($notice->uri);
+ $noticeUrl = common_shorten_url($notice->getUrl());
$urlLen = mb_strlen($noticeUrl);
$statustxt = mb_substr($statustxt, 0, 140 - ($urlLen + 3)) . ' … ' . $noticeUrl;
}
// Notify the user that her Twitter bridge is down
if (isset($user->email)) {
-
$result = mail_twitter_bridge_removed($user);
if (!$result) {
-
$msg = 'Unable to send email to notify ' .
"$user->nickname (user id: $user->id) " .
'that their Twitter bridge link was ' .
common_log(LOG_WARNING, $msg);
}
}
-
}
/**
*
* @return boolean success flag
*/
-
function mail_twitter_bridge_removed($user)
{
- common_init_locale($user->language);
-
$profile = $user->getProfile();
- $subject = sprintf(_m('Your Twitter bridge has been disabled.'));
+ common_switch_locale($user->language);
+
+ // TRANS: Mail subject after forwarding notices to Twitter has stopped working.
+ $subject = sprintf(_m('Your Twitter bridge has been disabled'));
$site_name = common_config('site', 'name');
+ // TRANS: Mail body after forwarding notices to Twitter has stopped working.
+ // TRANS: %1$ is the name of the user the mail is sent to, %2$s is a URL to the
+ // TRANS: Twitter settings, %3$s is the StatusNet sitename.
$body = sprintf(_m('Hi, %1$s. We\'re sorry to inform you that your ' .
'link to Twitter has been disabled. We no longer seem to have ' .
- 'permission to update your Twitter status. (Did you revoke ' .
- '%3$s\'s access?)' . "\n\n" .
+ 'permission to update your Twitter status. Did you maybe revoke ' .
+ '%3$s\'s access?' . "\n\n" .
'You can re-enable your Twitter bridge by visiting your ' .
"Twitter settings page:\n\n\t%2\$s\n\n" .
- "Regards,\n%3\$s\n"),
+ "Regards,\n%3\$s"),
$profile->getBestName(),
common_local_url('twittersettings'),
common_config('site', 'name'));
- common_init_locale();
+ common_switch_locale();
return mail_to_user($user, $subject, $body);
}
-
projects / quix0rs-gnu-social.git / blobdiff