]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/TwitterBridge/twitter.php
Use static class method for looking up Twitter user
[quix0rs-gnu-social.git] / plugins / TwitterBridge / twitter.php
index 280cdb0a33d93d6fcfcdef2e8669f9cee55e383d..e5afde62ca728771af2432038681a42d0e0704ab 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, 2009, Control Yourself, Inc.
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2008, 2009, 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
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) {
+if (!defined('STATUSNET') && !defined('LACONICA')) {
     exit(1);
 }
 
 define('TWITTER_SERVICE', 1); // Twitter is foreign_service ID 1
 
-function update_twitter_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;
-}
+require_once INSTALLDIR . '/plugins/TwitterBridge/twitterbasicauthclient.php';
+require_once INSTALLDIR . '/plugins/TwitterBridge/twitteroauthclient.php';
 
 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;
+    $luser = Foreign_user::getForeignUser($twitter_id, TWITTER_SERVICE);
     $result = $luser->delete();
 
-    if (empty($result)) {
-        common_log(LOG_WARNING,
-            "Twitter bridge - removed invalid Twitter user squatting on uri: $new_uri");
+    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;
@@ -93,7 +54,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;
@@ -102,7 +64,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.
 
@@ -112,25 +73,20 @@ function save_twitter_user($twitter_id, $screen_name)
 
         $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 = update_twitter_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);
-
-    return true;
+    return add_twitter_user($twitter_id, $screen_name);
 }
 
 function is_twitter_bound($notice, $flink) {
@@ -154,80 +110,155 @@ function broadcast_twitter($notice)
                                        TWITTER_SERVICE);
 
     if (is_twitter_bound($notice, $flink)) {
+        if (TwitterOAuthClient::isPackedToken($flink->credentials)) {
+            return broadcast_oauth($notice, $flink);
+        } else {
+            return broadcast_basicauth($notice, $flink);
+        }
+    }
 
-        $user = $flink->getUser();
-
-        // XXX: Hack to get around PHP cURL's use of @ being a a meta character
-        $statustxt = preg_replace('/^@/', ' @', $notice->content);
+    return true;
+}
 
-        $token = TwitterOAuthClient::unpackToken($flink->credentials);
+function broadcast_oauth($notice, $flink) {
+    $user = $flink->getUser();
+    $statustxt = format_status($notice);
+    $token = TwitterOAuthClient::unpackToken($flink->credentials);
+    $client = new TwitterOAuthClient($token->key, $token->secret);
+    $status = null;
+
+    try {
+        $status = $client->statusesUpdate($statustxt);
+    } catch (OAuthClientException $e) {
+        return process_error($e, $flink, $notice);
+    }
 
-        $client = new TwitterOAuthClient($token->key, $token->secret);
+    if (empty($status)) {
 
-        $status = null;
+        // This could represent a failure posting,
+        // or the Twitter API might just be behaving flakey.
 
-        try {
-            $status = $client->statusesUpdate($statustxt);
-        } catch (OAuthClientCurlException $e) {
+        $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);
 
-            if ($e->getMessage() == 'The requested URL returned error: 401') {
+        common_log(LOG_WARNING, $errmsg);
 
-                $errmsg = sprintf('User %1$s (user id: %2$s) has an invalid ' .
-                                  'Twitter OAuth access token.',
-                                  $user->nickname, $user->id);
-                common_log(LOG_WARNING, $errmsg);
+        return false;
+    }
 
-                // Bad auth token! We need to delete the foreign_link
-                // to Twitter and inform the user.
+    // Notice crossed the great divide
 
-                remove_twitter_link($flink);
-                return true;
+    $msg = sprintf('Twitter bridge - posted notice %d to Twitter using ' .
+                   'OAuth for User %s (user id %d).',
+                   $notice->id,
+                   $user->nickname,
+                   $user->id);
 
-            } else {
+    common_log(LOG_INFO, $msg);
 
-                // Some other error happened, so we should probably
-                // try to send again later.
+    return true;
+}
 
-                $errmsg = sprintf('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());
-                common_log(LOG_WARNING, $errmsg);
+function broadcast_basicauth($notice, $flink)
+{
+    $user = $flink->getUser();
 
-                return false;
-            }
-        }
+    $statustxt = format_status($notice);
 
-        if (empty($status)) {
+    $client = new TwitterBasicAuthClient($flink);
+    $status = null;
 
-            // This could represent a failure posting,
-            // or the Twitter API might just be behaving flakey.
+    try {
+        $status = $client->statusesUpdate($statustxt);
+    } catch (BasicAuthException $e) {
+        return process_error($e, $flink, $notice);
+    }
 
-            $errmsg = sprint('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);
+    if (empty($status)) {
 
-            return false;
-        }
+        $errmsg = sprintf('Twitter bridge - No data returned by Twitter API when ' .
+                          'trying to post notice %d for %s (user id %d).',
+                          $notice->id,
+                          $user->nickname,
+                          $user->id);
 
-        // Notice crossed the great divide
+        common_log(LOG_WARNING, $errmsg);
 
-        $msg = sprintf('Twitter bridge posted notice %s to Twitter.',
-                       $notice->id);
-        common_log(LOG_INFO, $msg);
+        $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;
     }
 
+    $msg = sprintf('Twitter bridge - posted notice %d to Twitter using ' .
+                   'HTTP basic auth for User %s (user id %d).',
+                   $notice->id,
+                   $user->nickname,
+                   $user->id);
+
+    common_log(LOG_INFO, $msg);
+
     return true;
 }
 
+function process_error($e, $flink, $notice)
+{
+    $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 403:
+        // User has exceeder her rate limit -- toss the notice
+        return true;
+        break;
+     default:
+
+        // For every other case, it's probably some flakiness so try
+        // sending the notice again later (requeue).
+
+        return false;
+        break;
+    }
+}
+
+function format_status($notice)
+{
+    // XXX: Hack to get around PHP cURL's use of @ being a a meta character
+    $statustxt = preg_replace('/^@/', ' @', $notice->content);
+
+    // Convert !groups to #hashes
+    $statustxt = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/', "\\1#\\2", $statustxt);
+
+    return $statustxt;
+}
+
 function remove_twitter_link($flink)
 {
     $user = $flink->getUser();
 
     common_log(LOG_INFO, 'Removing Twitter bridge Foreign link for ' .
-        "user $user->nickname (user id: $user->id).");
+               "user $user->nickname (user id: $user->id).");
 
     $result = $flink->delete();
 
@@ -256,3 +287,39 @@ function remove_twitter_link($flink)
 
 }
 
+/**
+ * Send a mail message to notify a user that her Twitter bridge link
+ * has stopped working, and therefore has been removed.  This can
+ * happen when the user changes her Twitter password, or otherwise
+ * revokes access.
+ *
+ * @param User $user   user whose Twitter bridge link has been removed
+ *
+ * @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.'));
+
+    $site_name = common_config('site', 'name');
+
+    $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" .
+    '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"),
+        $profile->getBestName(),
+        common_local_url('twittersettings'),
+        common_config('site', 'name'));
+
+    common_init_locale();
+    return mail_to_user($user, $subject, $body);
+}
+