]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/TwitterBridge/twitter.php
remove require_once for disappeared TwitterBasicAuthClient
[quix0rs-gnu-social.git] / plugins / TwitterBridge / twitter.php
index 3c6803e49aa8d6985e591f03f873e3850782176d..b8e5457402b46018b001b9834ac610b3f81f815a 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
  * StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2008, 2009, StatusNet, Inc.
+ * Copyright (C) 2008-2010 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
@@ -23,65 +23,26 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
 
 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 updateTwitter_user($twitter_id, $screen_name)
-{
-    $uri = 'http://twitter.com/' . $screen_name;
-    $fuser = new Foreign_user();
-
-    $fuser->query('BEGIN');
-
-    // Dropping down to SQL because regular DB_DataObject udpate stuff doesn't seem
-    // to work so good with tables that have multiple column primary keys
-
-    // Any time we update the uri for a forein user we have to make sure there
-    // are no dupe entries first -- unique constraint on the uri column
-
-    $qry = 'UPDATE foreign_user set uri = \'\' WHERE uri = ';
-    $qry .= '\'' . $uri . '\'' . ' AND service = ' . TWITTER_SERVICE;
-
-    $fuser->query($qry);
-
-    // Update the user
-
-    $qry = 'UPDATE foreign_user SET nickname = ';
-    $qry .= '\'' . $screen_name . '\'' . ', uri = \'' . $uri . '\' ';
-    $qry .= 'WHERE id = ' . $twitter_id . ' AND service = ' . TWITTER_SERVICE;
-
-    $fuser->query('COMMIT');
-
-    $fuser->free();
-    unset($fuser);
-
-    return true;
-}
-
 function add_twitter_user($twitter_id, $screen_name)
 {
-
-    $new_uri = 'http://twitter.com/' . $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 = new Foreign_user();
-    $luser->uri = $new_uri;
-    $luser->service = TWITTER_SERVICE;
-    $result = $luser->delete();
+    $luser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
 
-    if (empty($result)) {
-        common_log(LOG_WARNING,
-            "Twitter bridge - removed invalid Twitter user squatting on uri: $new_uri");
+    if (!empty($luser)) {
+        $result = $luser->delete();
+        if ($result != false) {
+            common_log(
+                LOG_INFO,
+                "Twitter bridge - removed old Twitter user: $screen_name ($twitter_id)."
+            );
+        }
     }
 
-    $luser->free();
-    unset($luser);
-
-    // Otherwise, create a new Twitter user
-
     $fuser = new Foreign_user();
 
     $fuser->nickname = $screen_name;
@@ -96,7 +57,8 @@ function add_twitter_user($twitter_id, $screen_name)
             "Twitter bridge - failed to add new Twitter user: $twitter_id - $screen_name.");
         common_log_db_error($fuser, 'INSERT', __FILE__);
     } else {
-        common_debug("Twitter bridge - Added new Twitter user: $screen_name ($twitter_id).");
+        common_log(LOG_INFO,
+                   "Twitter bridge - Added new Twitter user: $screen_name ($twitter_id).");
     }
 
     return $result;
@@ -105,7 +67,6 @@ function add_twitter_user($twitter_id, $screen_name)
 // Creates or Updates a Twitter user
 function save_twitter_user($twitter_id, $screen_name)
 {
-
     // Check to see whether the Twitter user is already in the system,
     // and update its screen name and uri if so.
 
@@ -113,27 +74,39 @@ function save_twitter_user($twitter_id, $screen_name)
 
     if (!empty($fuser)) {
 
-        $result = true;
-
-        // Only update if Twitter screen name has changed
+        // Delete old record if Twitter user changed screen name
 
         if ($fuser->nickname != $screen_name) {
-            $result = updateTwitter_user($twitter_id, $screen_name);
-
-            common_debug('Twitter bridge - Updated nickname (and URI) for Twitter user ' .
-                "$fuser->id to $screen_name, was $fuser->nickname");
+            $oldname = $fuser->nickname;
+            $fuser->delete();
+            common_log(LOG_INFO, sprintf('Twitter bridge - Updated nickname (and URI) ' .
+                                         'for Twitter user %1$d - %2$s, was %3$s.',
+                                         $fuser->id,
+                                         $screen_name,
+                                         $oldname));
         }
 
-        return $result;
-
     } else {
-        return add_twitter_user($twitter_id, $screen_name);
-    }
 
-    $fuser->free();
-    unset($fuser);
+        // 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 true;
+    return add_twitter_user($twitter_id, $screen_name);
 }
 
 function is_twitter_bound($notice, $flink) {
@@ -141,9 +114,12 @@ function is_twitter_bound($notice, $flink) {
     // Check to see if notice should go to Twitter
     if (!empty($flink) && ($flink->noticesync & FOREIGN_NOTICE_SEND)) {
 
-        // If it's not a Twitter-style reply, or if the user WANTS to send replies.
+        // 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 (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
-            ($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY)) {
+            ($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) ||
+            is_twitter_notice($notice->reply_to)) {
             return true;
         }
     }
@@ -151,132 +127,175 @@ function is_twitter_bound($notice, $flink) {
     return false;
 }
 
+function is_twitter_notice($id)
+{
+    $notice = Notice::staticGet('id', $id);
+
+    if (empty($notice)) {
+        // it's not any kind of notice, so it's definitely not a Twitter notice.
+        return false;
+    }
+
+    return ($notice->source == 'twitter');
+}
+
 function broadcast_twitter($notice)
 {
     $flink = Foreign_link::getByUserID($notice->profile_id,
                                        TWITTER_SERVICE);
 
-    if (is_twitter_bound($notice, $flink)) {
-        if (TwitterOAuthClient::isPackedToken($flink->credentials)) {
+    // Don't bother with basic auth, since it's no longer allowed
+
+    if (!empty($flink) && TwitterOAuthClient::isPackedToken($flink->credentials)) {
+        if (!empty($notice->repeat_of) && is_twitter_notice($notice->repeat_of)) {
+            return retweet_notice($flink, Notice::staticGet('id', $notice->repeat_of));
+        } else if (is_twitter_bound($notice, $flink)) {
             return broadcast_oauth($notice, $flink);
-        } else {
-            return broadcast_basicauth($notice, $flink);
         }
     }
 
     return true;
 }
 
-function broadcast_oauth($notice, $flink) {
-    $user = $flink->getUser();
-    $statustxt = format_status($notice);
-    // Convert !groups to #hashes
-    $statustxt = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/', "\\1#\\2", $statustxt);
+function retweet_notice($flink, $notice)
+{
     $token = TwitterOAuthClient::unpackToken($flink->credentials);
     $client = new TwitterOAuthClient($token->key, $token->secret);
-    $status = null;
+
+    $id = twitter_status_id($notice);
 
     try {
-        $status = $client->statusesUpdate($statustxt);
-    } catch (OAuthClientCurlException $e) {
-        return process_error($e, $flink);
+        $status = $client->statusesRetweet($id);
+    } 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 send update for %1$s (user id %2$s).',
-                          $user->nickname, $user->id);
-        common_log(LOG_WARNING, $errmsg);
-
-        return false;
+function twitter_status_id($notice)
+{
+    if ($notice->source == 'twitter' &&
+        preg_match('#^http://twitter.com/[\w_.]+/status/(\d+)$#', $notice->uri, $match)) {
+        return $match[1];
     }
 
-    // Notice crossed the great divide
-
-    $msg = sprintf('Twitter bridge - posted notice %s to Twitter using OAuth.',
-                   $notice->id);
-    common_log(LOG_INFO, $msg);
-
-    return true;
+    return null;
 }
 
-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;
+    }
+    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 (HTTP_Request2_Exception $e) {
-        return process_error($e, $flink);
+        $status = $client->statusesUpdate($statustxt, $params);
+    } 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 send update for %1$s (user id %2$s).',
-                          $user->nickname, $user->id);
+                          '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 send update for %1$s (user id %2$s).',
-                             $user->nickname, $user->id);
-            common_log(LOG_WARNING, $errmsg);
         return false;
     }
 
-    $msg = sprintf('Twitter bridge - posted notice %s to Twitter using basic auth.',
-                   $notice->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 process_error($e, $flink)
+function process_error($e, $flink, $notice)
 {
-    $user        = $flink->getUser();
-    $errmsg      = $e->getMessage();
-    $delivered   = false;
-
-    switch($errmsg) {
-     case 'The requested URL returned error: 401':
-        $logmsg = sprintf('Twiter bridge - User %1$s (user id: %2$s) has an invalid ' .
-                          'Twitter screen_name/password combo or an invalid acesss token.',
-                          $user->nickname, $user->id);
-        $delivered = true;
+    $user = $flink->getUser();
+    $code = $e->getCode();
+
+    $logmsg = sprintf('Twitter bridge - %d posting notice %d for ' .
+                      'User %s (user id: %d): %s.',
+                      $code,
+                      $notice->id,
+                      $user->nickname,
+                      $user->id,
+                      $e->getMessage());
+
+    common_log(LOG_WARNING, $logmsg);
+
+    switch($code) {
+     case 401:
+        // Probably a revoked or otherwise bad access token - nuke!
         remove_twitter_link($flink);
+        return true;
         break;
-     case 'The requested URL returned error: 403':
-        $logmsg = sprintf('Twitter bridge - User %1$s (user id: %2$s) has exceeded ' .
-                          'his/her Twitter request limit.',
-                          $user->nickname, $user->id);
+     case 403:
+        // User has exceeder her rate limit -- toss the notice
+        return true;
         break;
      default:
-        $logmsg = sprintf('Twitter bridge - cURL error trying to send notice to Twitter ' .
-                          'for user %1$s (user id: %2$s) - ' .
-                          'code: %3$s message: %4$s.',
-                          $user->nickname, $user->id,
-                          $e->getCode(), $e->getMessage());
-        break;
-    }
 
-    common_log(LOG_WARNING, $logmsg);
+        // For every other case, it's probably some flakiness so try
+        // sending the notice again later (requeue).
 
-    return $delivered;
+        return false;
+        break;
+    }
 }
 
 function format_status($notice)
 {
     // XXX: Hack to get around PHP cURL's use of @ being a a meta character
-    return preg_replace('/^@/', ' @', $notice->content);
+    $statustxt = preg_replace('/^@/', ' @', $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);
+
+    if (mb_strlen($statustxt) > 140) {
+        $noticeUrl = common_shorten_url($notice->uri);
+        $urlLen = mb_strlen($noticeUrl);
+        $statustxt = mb_substr($statustxt, 0, 140 - ($urlLen + 3)) . ' … ' . $noticeUrl;
+    }
+
+    return $statustxt;
 }
 
 function remove_twitter_link($flink)
@@ -286,7 +305,7 @@ function remove_twitter_link($flink)
     common_log(LOG_INFO, 'Removing Twitter bridge Foreign link for ' .
                "user $user->nickname (user id: $user->id).");
 
-    $result = $flink->delete();
+    $result = $flink->safeDelete();
 
     if (empty($result)) {
         common_log(LOG_ERR, 'Could not remove Twitter bridge ' .
@@ -326,15 +345,15 @@ function remove_twitter_link($flink)
 
 function mail_twitter_bridge_removed($user)
 {
-    common_init_locale($user->language);
-
     $profile = $user->getProfile();
 
-    $subject = sprintf(_('Your Twitter bridge has been disabled.'));
+    common_switch_locale($user->language);
+
+    $subject = sprintf(_m('Your Twitter bridge has been disabled.'));
 
     $site_name = common_config('site', 'name');
 
-    $body = sprintf(_('Hi, %1$s. We\'re sorry to inform you that your ' .
+    $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" .
@@ -345,7 +364,7 @@ function mail_twitter_bridge_removed($user)
         common_local_url('twittersettings'),
         common_config('site', 'name'));
 
-    common_init_locale();
+    common_switch_locale();
     return mail_to_user($user, $subject, $body);
 }