From 444611b49a56b2b282d0f9b9290d17aecd9ae321 Mon Sep 17 00:00:00 2001 From: brettp Date: Mon, 14 Mar 2011 02:06:04 +0000 Subject: Refs #3115. Migrated twitterservice to twitter_api. Added upgrade to migrate plugin and user settings. git-svn-id: http://code.elgg.org/elgg/trunk@8699 36083f99-b078-4883-b0ff-0f9b5a30f544 --- mod/twitter_api/lib/twitter_api.php | 333 ++++++++++++++++++++++++++++++++++++ 1 file changed, 333 insertions(+) create mode 100644 mod/twitter_api/lib/twitter_api.php (limited to 'mod/twitter_api/lib/twitter_api.php') diff --git a/mod/twitter_api/lib/twitter_api.php b/mod/twitter_api/lib/twitter_api.php new file mode 100644 index 000000000..c7c31c76d --- /dev/null +++ b/mod/twitter_api/lib/twitter_api.php @@ -0,0 +1,333 @@ + 'user', + 'plugin_user_setting_name_value_pairs' => array( + 'access_key' => $token['oauth_token'], + 'access_secret' => $token['oauth_token_secret'], + ), + 'limit' => 0 + ); + + $users = elgg_get_entities_from_plugin_user_settings($options); + + if ($users) { + if (count($users) == 1 && login($users[0])) { + system_message(elgg_echo('twitter_api:login:success')); + + // trigger login hook + elgg_trigger_plugin_hook('login', 'twitter_api', array('user' => $users[0])); + } else { + system_message(elgg_echo('twitter_api:login:error')); + } + + forward(); + } else { + // need Twitter account credentials + elgg_load_library('twitter_oauth'); + + $consumer_key = elgg_get_plugin_setting('consumer_key', 'twitter_api'); + $consumer_secret = elgg_get_plugin_setting('consumer_secret', 'twitter_api'); + $api = new TwitterOAuth($consumer_key, $consumer_secret, $token['oauth_token'], $token['oauth_token_secret']); + $twitter = $api->get('account/verify_credentials'); + + // backward compatibility for stalled-development Twitter Login plugin + $user = FALSE; + if ($twitter_user = get_user_by_username($token['screen_name'])) { + if (($screen_name = $twitter_user->twitter_screen_name) && ($screen_name == $token['screen_name'])) { + // convert existing account + $user = $twitter_user; + $forward = ''; + } + } + + // create new user + if (!$user) { + // check new registration allowed + if (!twitter_api_allow_new_users_with_twitter()) { + register_error(elgg_echo('registerdisabled')); + forward(); + } + + // trigger a hook for plugin authors to intercept + if (!elgg_trigger_plugin_hook('new_twitter_user', 'twitter_service', array('account' => $twitter), TRUE)) { + // halt execution + register_error(elgg_echo('twitter_api:login:error')); + forward(); + } + + // Elgg-ify Twitter credentials + $username = $twitter->screen_name; + while (get_user_by_username($username)) { + $username = $twitter->screen_name . '_' . rand(1000, 9999); + } + + $password = generate_random_cleartext_password(); + $name = $twitter->name; + + $user = new ElggUser(); + $user->username = $username; + $user->name = $name; + $user->access_id = ACCESS_PUBLIC; + $user->salt = generate_random_cleartext_password(); + $user->password = generate_user_password($user, $password); + $user->owner_guid = 0; + $user->container_guid = 0; + + if (!$user->save()) { + register_error(elgg_echo('registerbad')); + forward(); + } + + // @todo require email address? + + $site_name = elgg_get_site_entity()->name; + system_message(elgg_echo('twitter_api:login:email', array($site_name))); + + $forward = "settings/user/{$user->username}"; + } + + // set twitter services tokens + elgg_set_plugin_user_setting('twitter_name', $token['screen_name'], $user->guid); + elgg_set_plugin_user_setting('access_key', $token['oauth_token'], $user->guid); + elgg_set_plugin_user_setting('access_secret', $token['oauth_token_secret'], $user->guid); + + // pull in Twitter icon + twitter_api_update_user_avatar($user, $twitter->profile_image_url); + + // login new user + if (login($user)) { + system_message(elgg_echo('twitter_api:login:success')); + + // trigger login hook for new user + elgg_trigger_plugin_hook('first_login', 'twitter_api', array('user' => $user)); + } else { + system_message(elgg_echo('twitter_api:login:error')); + } + + forward($forward, 'twitter_api'); + } + + // register login error + register_error(elgg_echo('twitter_api:login:error')); + forward(); +} + +/** + * Pull in the latest avatar from twitter. + * + * @param unknown_type $user + * @param unknown_type $file_location + */ +function twitter_api_update_user_avatar($user, $file_location) { + $sizes = array( + 'topbar' => array(16, 16, TRUE), + 'tiny' => array(25, 25, TRUE), + 'small' => array(40, 40, TRUE), + 'medium' => array(100, 100, TRUE), + 'large' => array(200, 200, FALSE), + 'master' => array(550, 550, FALSE), + ); + + $filehandler = new ElggFile(); + $filehandler->owner_guid = $user->getGUID(); + foreach ($sizes as $size => $dimensions) { + $image = get_resized_image_from_existing_file( + $file_location, + $dimensions[0], + $dimensions[1], + $dimensions[2] + ); + + $filehandler->setFilename("profile/$user->guid$size.jpg"); + $filehandler->open('write'); + $filehandler->write($image); + $filehandler->close(); + } + + return TRUE; +} + +/** + * User-initiated Twitter authorization + * + * Callback action from Twitter registration. Registers a single Elgg user with + * the authorization tokens. Will revoke access from previous users when a + * conflict exists. + * + * Depends upon {@link twitter_api_get_authorize_url} being called previously + * to establish session request tokens. + */ +function twitter_api_authorize() { + $token = twitter_api_get_access_token(); + if (!isset($token['oauth_token']) || !isset($token['oauth_token_secret'])) { + register_error(elgg_echo('twitter_api:authorize:error')); + forward('settings/plugins', 'twitter_api'); + } + + // make sure no other users are registered to this twitter account. + $options = array( + 'type' => 'user', + 'plugin_user_setting_name_value_pairs' => array( + 'access_key' => $token['oauth_token'], + 'access_secret' => $token['oauth_token_secret'], + ), + 'limit' => 0 + ); + + $users = elgg_get_entities_from_plugin_user_settings($options); + + if ($users) { + foreach ($users as $user) { + // revoke access + elgg_unset_plugin_user_setting('twitter_name', $user->getGUID()); + elgg_unset_plugin_user_setting('access_key', $user->getGUID()); + elgg_unset_plugin_user_setting('access_secret', $user->getGUID()); + } + } + + // register user's access tokens + elgg_set_plugin_user_setting('twitter_name', $token['screen_name']); + elgg_set_plugin_user_setting('access_key', $token['oauth_token']); + elgg_set_plugin_user_setting('access_secret', $token['oauth_token_secret']); + + // trigger authorization hook + elgg_trigger_plugin_hook('authorize', 'twitter_api', array('token' => $token)); + + system_message(elgg_echo('twitter_api:authorize:success')); + forward('settings/plugins', 'twitter_api'); +} + +/** + * Remove twitter access for the currently logged in user. + */ +function twitter_api_revoke() { + // unregister user's access tokens + elgg_unset_plugin_user_setting('twitter_name'); + elgg_unset_plugin_user_setting('access_key'); + elgg_unset_plugin_user_setting('access_secret'); + + system_message(elgg_echo('twitter_api:revoke:success')); + forward('settings/plugins', 'twitter_api'); +} + +/** + * Returns the url to authorize a user. + * + * @param string $callback The callback URL? + */ +function twitter_api_get_authorize_url($callback = NULL) { + global $SESSION; + elgg_load_library('twitter_oauth'); + + $consumer_key = elgg_get_plugin_setting('consumer_key', 'twitter_api'); + $consumer_secret = elgg_get_plugin_setting('consumer_secret', 'twitter_api'); + + // request tokens from Twitter + $twitter = new TwitterOAuth($consumer_key, $consumer_secret); + $token = $twitter->getRequestToken($callback); + + // save token in session for use after authorization + $SESSION['twitter_api'] = array( + 'oauth_token' => $token['oauth_token'], + 'oauth_token_secret' => $token['oauth_token_secret'], + ); + + return $twitter->getAuthorizeURL($token['oauth_token']); +} + +/** + * Returns the access token to use in twitter calls. + * + * @param unknown_type $oauth_verifier + */ +function twitter_api_get_access_token($oauth_verifier = FALSE) { + global $SESSION; + elgg_load_library('twitter_oauth'); + + $consumer_key = elgg_get_plugin_setting('consumer_key', 'twitter_api'); + $consumer_secret = elgg_get_plugin_setting('consumer_secret', 'twitter_api'); + + // retrieve stored tokens + $oauth_token = $SESSION['twitter_api']['oauth_token']; + $oauth_token_secret = $SESSION['twitter_api']['oauth_token_secret']; + $SESSION->offsetUnset('twitter_api'); + + // fetch an access token + $api = new TwitterOAuth($consumer_key, $consumer_secret, $oauth_token, $oauth_token_secret); + return $api->getAccessToken($oauth_verifier); +} + +/** + * Checks if this site is accepting new users. + * Admins can disable manual registration, but some might want to allow + * twitter-only logins. + */ +function twitter_api_allow_new_users_with_twitter() { + $site_reg = elgg_get_config('allow_registration'); + $twitter_reg = elgg_get_plugin_setting('new_users'); + + if ($site_reg || (!$site_reg && $twitter_reg == 'yes')) { + return true; + } + + return false; +} -- cgit v1.2.3