]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/TwitterBridge/twitterauthorization.php
Add Julien C to author comments
[quix0rs-gnu-social.git] / plugins / TwitterBridge / twitterauthorization.php
index 2a93ff13e20fc306a963951da7eb0fb8ceae3b0a..b2657ff61fb0bbd220e71105139b8cc1c51fd96d 100644 (file)
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
- * @category  TwitterauthorizationAction
+ * @category  Plugin
  * @package   StatusNet
- * @author    Zach Copely <zach@status.net>
- * @copyright 2009 StatusNet, Inc.
+ * @author    Zach Copley <zach@status.net>
+ * @author    Julien C <chaumond@gmail.com>
+ * @copyright 2009-2010 StatusNet, Inc.
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link      http://status.net/
  */
@@ -41,15 +42,21 @@ require_once INSTALLDIR . '/plugins/TwitterBridge/twitter.php';
  * (Foreign_link) between the StatusNet user and Twitter user and stores the
  * access token and secret in the link.
  *
- * @category Twitter
+ * @category Plugin
  * @package  StatusNet
  * @author   Zach Copley <zach@status.net>
+ * @author   Julien C <chaumond@gmail.com>
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link     http://laconi.ca/
  *
  */
 class TwitterauthorizationAction extends Action
 {
+    var $twuid        = null;
+    var $tw_fields    = null;
+    var $access_token = null;
+    var $signin       = null;
+
     /**
      * Initialize class members. Looks for 'oauth_token' parameter.
      *
@@ -61,6 +68,7 @@ class TwitterauthorizationAction extends Action
     {
         parent::prepare($args);
 
+        $this->signin      = $this->boolean('signin');
         $this->oauth_token = $this->arg('oauth_token');
 
         return true;
@@ -77,28 +85,61 @@ class TwitterauthorizationAction extends Action
     {
         parent::handle($args);
 
-        if (!common_logged_in()) {
-            $this->clientError(_('Not logged in.'), 403);
+        if (common_logged_in()) {
+            $user  = common_current_user();
+            $flink = Foreign_link::getByUserID($user->id, TWITTER_SERVICE);
+
+            // If there's already a foreign link record, it means we already
+            // have an access token, and this is unecessary. So go back.
+
+            if (isset($flink)) {
+                common_redirect(common_local_url('twittersettings'));
+            }
         }
 
-        $user  = common_current_user();
-        $flink = Foreign_link::getByUserID($user->id, TWITTER_SERVICE);
+        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
 
-        // If there's already a foreign link record, it means we already
-        // have an access token, and this is unecessary. So go back.
+            // User was not logged in to StatusNet before
 
-        if (isset($flink)) {
-            common_redirect(common_local_url('twittersettings'));
-        }
+            $this->twuid = $this->trimmed('twuid');
+
+            $this->tw_fields = array('screen_name' => $this->trimmed('tw_fields_screen_name'),
+                                     'fullname' => $this->trimmed('tw_fields_fullname'));
+
+            $this->access_token = new OAuthToken($this->trimmed('access_token_key'), $this->trimmed('access_token_secret'));
+
+            $token = $this->trimmed('token');
 
-        // $this->oauth_token is only populated once Twitter authorizes our
-        // request token. If it's empty we're at the beginning of the auth
-        // process
+            if (!$token || $token != common_session_token()) {
+                $this->showForm(_('There was a problem with your session token. Try again, please.'));
+                return;
+            }
 
-        if (empty($this->oauth_token)) {
-            $this->authorizeRequestToken();
+            if ($this->arg('create')) {
+                if (!$this->boolean('license')) {
+                    $this->showForm(_('You can\'t register if you don\'t agree to the license.'),
+                                    $this->trimmed('newname'));
+                    return;
+                }
+                $this->createNewUser();
+            } else if ($this->arg('connect')) {
+                $this->connectNewUser();
+            } else {
+                common_debug('Twitter Connect Plugin - ' .
+                             print_r($this->args, true));
+                $this->showForm(_('Something weird happened.'),
+                                $this->trimmed('newname'));
+            }
         } else {
-            $this->saveAccessToken();
+            // $this->oauth_token is only populated once Twitter authorizes our
+            // request token. If it's empty we're at the beginning of the auth
+            // process
+
+            if (empty($this->oauth_token)) {
+                $this->authorizeRequestToken();
+            } else {
+                $this->saveAccessToken();
+            }
         }
     }
 
@@ -123,12 +164,12 @@ class TwitterauthorizationAction extends Action
             $_SESSION['twitter_request_token']        = $req_tok->key;
             $_SESSION['twitter_request_token_secret'] = $req_tok->secret;
 
-            $auth_link = $client->getAuthorizeLink($req_tok);
+            $auth_link = $client->getAuthorizeLink($req_tok, $this->signin);
 
-        } catch (TwitterOAuthClientException $e) {
+        } catch (OAuthClientException $e) {
             $msg = sprintf('OAuth client cURL error - code: %1s, msg: %2s',
                            $e->getCode(), $e->getMessage());
-            $this->serverError(_('Couldn\'t link your Twitter account.'));
+            $this->serverError(_m('Couldn\'t link your Twitter account.'));
         }
 
         common_redirect($auth_link);
@@ -147,9 +188,11 @@ class TwitterauthorizationAction extends Action
         // token we sent them
 
         if ($_SESSION['twitter_request_token'] != $this->oauth_token) {
-            $this->serverError(_('Couldn\'t link your Twitter account.'));
+            $this->serverError(_m('Couldn\'t link your Twitter account.'));
         }
 
+        $twitter_user = null;
+
         try {
 
             $client = new TwitterOAuthClient($_SESSION['twitter_request_token'],
@@ -165,40 +208,54 @@ class TwitterauthorizationAction extends Action
             $twitter_user = $client->verifyCredentials();
 
         } catch (OAuthClientException $e) {
-            $msg = sprintf('OAuth client cURL error - code: %1$s, msg: %2$s',
+            $msg = sprintf('OAuth client error - code: %1$s, msg: %2$s',
                            $e->getCode(), $e->getMessage());
-            $this->serverError(_('Couldn\'t link your Twitter account.'));
+            $this->serverError(_m('Couldn\'t link your Twitter account.'));
         }
 
-        // Save the access token and Twitter user info
+        if (common_logged_in()) {
+
+            // Save the access token and Twitter user info
+
+            $user = common_current_user();
+            $this->saveForeignLink($user->id, $twitter_user->id, $atok);
+            save_twitter_user($twitter_user->id, $twitter_user->name);
 
-        $this->saveForeignLink($atok, $twitter_user);
+        } else {
+
+            $this->twuid = $twitter_user->id;
+            $this->tw_fields = array("screen_name" => $twitter_user->screen_name,
+                                     "name" => $twitter_user->name);
+            $this->access_token = $atok;
+            $this->tryLogin();
+        }
 
         // Clean up the the mess we made in the session
 
         unset($_SESSION['twitter_request_token']);
         unset($_SESSION['twitter_request_token_secret']);
 
-        common_redirect(common_local_url('twittersettings'));
+        if (common_logged_in()) {
+            common_redirect(common_local_url('twittersettings'));
+        }
     }
 
     /**
      * Saves a Foreign_link between Twitter user and local user,
      * which includes the access token and secret.
      *
-     * @param OAuthToken $access_token the access token to save
-     * @param mixed      $twitter_user twitter API user object
+     * @param int        $user_id StatusNet user ID
+     * @param int        $twuid   Twitter user ID
+     * @param OAuthToken $token   the access token to save
      *
      * @return nothing
      */
-    function saveForeignLink($access_token, $twitter_user)
+    function saveForeignLink($user_id, $twuid, $access_token)
     {
-        $user = common_current_user();
-
         $flink = new Foreign_link();
 
-        $flink->user_id     = $user->id;
-        $flink->foreign_id  = $twitter_user->id;
+        $flink->user_id     = $user_id;
+        $flink->foreign_id  = $twuid;
         $flink->service     = TWITTER_SERVICE;
 
         $creds = TwitterOAuthClient::packToken($access_token);
@@ -217,7 +274,322 @@ class TwitterauthorizationAction extends Action
                 $this->serverError(_('Couldn\'t link your Twitter account.'));
         }
 
-        save_twitter_user($twitter_user->id, $twitter_user->screen_name);
+        return $flink_id;
+    }
+
+    function showPageNotice()
+    {
+        if ($this->error) {
+            $this->element('div', array('class' => 'error'), $this->error);
+        } else {
+            $this->element('div', 'instructions',
+                           sprintf(_('This is the first time you\'ve logged into %s so we must connect your Twitter account to a local account. You can either create a new account, or connect with your existing account, if you have one.'), common_config('site', 'name')));
+        }
+    }
+
+    function title()
+    {
+        return _('Twitter Account Setup');
+    }
+
+    function showForm($error=null, $username=null)
+    {
+        $this->error = $error;
+        $this->username = $username;
+
+        $this->showPage();
+    }
+
+    function showPage()
+    {
+        parent::showPage();
+    }
+
+    function showContent()
+    {
+        if (!empty($this->message_text)) {
+            $this->element('p', null, $this->message);
+            return;
+        }
+
+        $this->elementStart('form', array('method' => 'post',
+                                          'id' => 'form_settings_twitter_connect',
+                                          'class' => 'form_settings',
+                                          'action' => common_local_url('twitterauthorization')));
+        $this->elementStart('fieldset', array('id' => 'settings_twitter_connect_options'));
+        $this->element('legend', null, _('Connection options'));
+        $this->elementStart('ul', 'form_data');
+        $this->elementStart('li');
+        $this->element('input', array('type' => 'checkbox',
+                                      'id' => 'license',
+                                      'class' => 'checkbox',
+                                      'name' => 'license',
+                                      'value' => 'true'));
+        $this->elementStart('label', array('class' => 'checkbox', 'for' => 'license'));
+        $this->text(_('My text and files are available under '));
+        $this->element('a', array('href' => common_config('license', 'url')),
+                       common_config('license', 'title'));
+        $this->text(_(' except this private data: password, email address, IM address, phone number.'));
+        $this->elementEnd('label');
+        $this->elementEnd('li');
+        $this->elementEnd('ul');
+        $this->hidden('access_token_key', $this->access_token->key);
+        $this->hidden('access_token_secret', $this->access_token->secret);
+        $this->hidden('twuid', $this->twuid);
+        $this->hidden('tw_fields_screen_name', $this->tw_fields['screen_name']);
+        $this->hidden('tw_fields_name', $this->tw_fields['name']);
+
+        $this->elementStart('fieldset');
+        $this->hidden('token', common_session_token());
+        $this->element('legend', null,
+                       _('Create new account'));
+        $this->element('p', null,
+                       _('Create a new user with this nickname.'));
+        $this->elementStart('ul', 'form_data');
+        $this->elementStart('li');
+        $this->input('newname', _('New nickname'),
+                     ($this->username) ? $this->username : '',
+                     _('1-64 lowercase letters or numbers, no punctuation or spaces'));
+        $this->elementEnd('li');
+        $this->elementEnd('ul');
+        $this->submit('create', _('Create'));
+        $this->elementEnd('fieldset');
+
+        $this->elementStart('fieldset');
+        $this->element('legend', null,
+                       _('Connect existing account'));
+        $this->element('p', null,
+                       _('If you already have an account, login with your username and password to connect it to your Twitter account.'));
+        $this->elementStart('ul', 'form_data');
+        $this->elementStart('li');
+        $this->input('nickname', _('Existing nickname'));
+        $this->elementEnd('li');
+        $this->elementStart('li');
+        $this->password('password', _('Password'));
+        $this->elementEnd('li');
+        $this->elementEnd('ul');
+        $this->submit('connect', _('Connect'));
+        $this->elementEnd('fieldset');
+
+        $this->elementEnd('fieldset');
+        $this->elementEnd('form');
+    }
+
+    function message($msg)
+    {
+        $this->message_text = $msg;
+        $this->showPage();
+    }
+
+    function createNewUser()
+    {
+        if (common_config('site', 'closed')) {
+            $this->clientError(_('Registration not allowed.'));
+            return;
+        }
+
+        $invite = null;
+
+        if (common_config('site', 'inviteonly')) {
+            $code = $_SESSION['invitecode'];
+            if (empty($code)) {
+                $this->clientError(_('Registration not allowed.'));
+                return;
+            }
+
+            $invite = Invitation::staticGet($code);
+
+            if (empty($invite)) {
+                $this->clientError(_('Not a valid invitation code.'));
+                return;
+            }
+        }
+
+        $nickname = $this->trimmed('newname');
+
+        if (!Validate::string($nickname, array('min_length' => 1,
+                                               'max_length' => 64,
+                                               'format' => NICKNAME_FMT))) {
+            $this->showForm(_('Nickname must have only lowercase letters and numbers and no spaces.'));
+            return;
+        }
+
+        if (!User::allowed_nickname($nickname)) {
+            $this->showForm(_('Nickname not allowed.'));
+            return;
+        }
+
+        if (User::staticGet('nickname', $nickname)) {
+            $this->showForm(_('Nickname already in use. Try another one.'));
+            return;
+        }
+
+        $fullname = trim($this->tw_fields['name']);
+
+        $args = array('nickname' => $nickname, 'fullname' => $fullname);
+
+        if (!empty($invite)) {
+            $args['code'] = $invite->code;
+        }
+
+        $user = User::register($args);
+
+        $result = $this->saveForeignLink($user->id,
+                                         $this->twuid,
+                                         $this->access_token);
+
+        save_twitter_user($this->twuid, $this->tw_fields['screen_name']);
+
+        if (!$result) {
+            $this->serverError(_('Error connecting user to Twitter.'));
+            return;
+        }
+
+        common_set_user($user);
+        common_real_login(true);
+
+        common_debug('TwitterBridge Plugin - ' .
+                     "Registered new user $user->id from Twitter user $this->twuid");
+
+        common_redirect(common_local_url('showstream', array('nickname' => $user->nickname)),
+                        303);
+    }
+
+    function connectNewUser()
+    {
+        $nickname = $this->trimmed('nickname');
+        $password = $this->trimmed('password');
+
+        if (!common_check_user($nickname, $password)) {
+            $this->showForm(_('Invalid username or password.'));
+            return;
+        }
+
+        $user = User::staticGet('nickname', $nickname);
+
+        if (!empty($user)) {
+            common_debug('TwitterBridge Plugin - ' .
+                         "Legit user to connect to Twitter: $nickname");
+        }
+
+        $result = $this->saveForeignLink($user->id,
+                                         $this->twuid,
+                                         $this->access_token);
+
+        save_twitter_user($this->twuid, $this->tw_fields['screen_name']);
+
+        if (!$result) {
+            $this->serverError(_('Error connecting user to Twitter.'));
+            return;
+        }
+
+        common_debug('TwitterBridge Plugin - ' .
+                     "Connected Twitter user $this->twuid to local user $user->id");
+
+        common_set_user($user);
+        common_real_login(true);
+
+        $this->goHome($user->nickname);
+    }
+
+    function connectUser()
+    {
+        $user = common_current_user();
+
+        $result = $this->flinkUser($user->id, $this->twuid);
+
+        if (empty($result)) {
+            $this->serverError(_('Error connecting user to Twitter.'));
+            return;
+        }
+
+        common_debug('TwitterBridge Plugin - ' .
+                     "Connected Twitter user $this->twuid to local user $user->id");
+
+        // Return to Twitter connection settings tab
+        common_redirect(common_local_url('twittersettings'), 303);
+    }
+
+    function tryLogin()
+    {
+        common_debug('TwitterBridge Plugin - ' .
+                     "Trying login for Twitter user $this->twuid.");
+
+        $flink = Foreign_link::getByForeignID($this->twuid,
+                                              TWITTER_SERVICE);
+
+        if (!empty($flink)) {
+            $user = $flink->getUser();
+
+            if (!empty($user)) {
+
+                common_debug('TwitterBridge Plugin - ' .
+                             "Logged in Twitter user $flink->foreign_id as user $user->id ($user->nickname)");
+
+                common_set_user($user);
+                common_real_login(true);
+                $this->goHome($user->nickname);
+            }
+
+        } else {
+
+            common_debug('TwitterBridge Plugin - ' .
+                         "No flink found for twuid: $this->twuid - new user");
+
+            $this->showForm(null, $this->bestNewNickname());
+        }
+    }
+
+    function goHome($nickname)
+    {
+        $url = common_get_returnto();
+        if ($url) {
+            // We don't have to return to it again
+            common_set_returnto(null);
+        } else {
+            $url = common_local_url('all',
+                                    array('nickname' =>
+                                          $nickname));
+        }
+
+        common_redirect($url, 303);
+    }
+
+    function bestNewNickname()
+    {
+        if (!empty($this->tw_fields['name'])) {
+            $nickname = $this->nicknamize($this->tw_fields['name']);
+            if ($this->isNewNickname($nickname)) {
+                return $nickname;
+            }
+        }
+
+        return null;
+    }
+
+     // Given a string, try to make it work as a nickname
+
+     function nicknamize($str)
+     {
+         $str = preg_replace('/\W/', '', $str);
+         $str = str_replace(array('-', '_'), '', $str);
+         return strtolower($str);
+     }
+
+    function isNewNickname($str)
+    {
+        if (!Validate::string($str, array('min_length' => 1,
+                                          'max_length' => 64,
+                                          'format' => NICKNAME_FMT))) {
+            return false;
+        }
+        if (!User::allowed_nickname($str)) {
+            return false;
+        }
+        if (User::staticGet('nickname', $str)) {
+            return false;
+        }
+        return true;
     }
 
 }