diff options
| -rw-r--r-- | mod/twitterservice/graphics/sign_in_with_twitter.gif | bin | 0 -> 3028 bytes | |||
| -rw-r--r-- | mod/twitterservice/languages/en.php | 31 | ||||
| -rw-r--r-- | mod/twitterservice/manifest.xml | 14 | ||||
| -rw-r--r-- | mod/twitterservice/start.php | 134 | ||||
| -rw-r--r-- | mod/twitterservice/twitterservice_lib.php | 268 | ||||
| -rwxr-xr-x | mod/twitterservice/vendors/twitteroauth/LICENSE | 22 | ||||
| -rwxr-xr-x | mod/twitterservice/vendors/twitteroauth/OAuth.php | 517 | ||||
| -rwxr-xr-x | mod/twitterservice/vendors/twitteroauth/README | 7 | ||||
| -rwxr-xr-x | mod/twitterservice/vendors/twitteroauth/twitterOAuth.php | 245 | ||||
| -rw-r--r-- | mod/twitterservice/views/default/settings/twitterservice/edit.php | 40 | ||||
| -rw-r--r-- | mod/twitterservice/views/default/twitterservice/css.php | 12 | ||||
| -rw-r--r-- | mod/twitterservice/views/default/twitterservice/login.php | 16 | ||||
| -rw-r--r-- | mod/twitterservice/views/default/twitterservice/metatags.php | 21 | ||||
| -rw-r--r-- | mod/twitterservice/views/default/usersettings/twitterservice/edit.php | 21 |
14 files changed, 1348 insertions, 0 deletions
diff --git a/mod/twitterservice/graphics/sign_in_with_twitter.gif b/mod/twitterservice/graphics/sign_in_with_twitter.gif Binary files differnew file mode 100644 index 000000000..a686590fc --- /dev/null +++ b/mod/twitterservice/graphics/sign_in_with_twitter.gif diff --git a/mod/twitterservice/languages/en.php b/mod/twitterservice/languages/en.php new file mode 100644 index 000000000..39bb47741 --- /dev/null +++ b/mod/twitterservice/languages/en.php @@ -0,0 +1,31 @@ +<?php +/** + * An english language definition file + */ + +$english = array( + 'twitterservice' => 'Twitter Services', + + 'twitterservice:requires_oauth' => 'Twitter Services requires the OAuth Libraries plugin to be enabled.', + + 'twitterservice:consumer_key' => 'Consumer Key', + 'twitterservice:consumer_secret' => 'Consumer Secret', + + 'twitterservice:settings:instructions' => 'You must obtain a consumer key and secret from <a href="https://twitter.com/oauth_clients" target="_blank">Twitter</a>. Most of the fields are self explanatory, the one piece of data you will need is the callback url which takes the form http://[yoursite]/action/twitterlogin/return - [yoursite] is the url of your Elgg network.', + + 'twitterservice:usersettings:description' => "Link your {$CONFIG->site->name} account with Twitter.", + 'twitterservice:usersettings:request' => "You must first <a href=\"%s\">authorize</a> {$CONFIG->site->name} to access your Twitter account.", + 'twitterservice:authorize:error' => 'Unable to authorize Twitter.', + 'twitterservice:authorize:success' => 'Twitter access has been authorized.', + + 'twitterservice:usersettings:authorized' => "You have authorized {$CONFIG->site->name} to access your Twitter account: @%s.", + 'twitterservice:usersettings:revoke' => 'Click <a href="%s">here</a> to revoke access.', + 'twitterservice:revoke:success' => 'Twitter access has been revoked.', + + 'twitterservice:login' => 'Allow users to sign in with Twitter?', + 'twitterservice:login:success' => 'You have been logged in.', + 'twitterservice:login:error' => 'Unable to login with Twitter.', + 'twitterservice:login:email' => "You must enter a valid email address for your new {$CONFIG->site->name} account.", +); + +add_translation('en', $english);
\ No newline at end of file diff --git a/mod/twitterservice/manifest.xml b/mod/twitterservice/manifest.xml new file mode 100644 index 000000000..c5e0a1c56 --- /dev/null +++ b/mod/twitterservice/manifest.xml @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<plugin_manifest> + <field key="name" value="Twitter Services" /> + <field key="author" value="Curverider" /> + <field key="version" value="1.8" /> + <field key="description" value="Allows users to authenticate their Elgg account with Twitter." /> + <field key="category" value="service" /> + <field key="category" value="official" /> + <field key="website" value="http://www.elgg.org/" /> + <field key="copyright" value="(C) Curverider 2010" /> + <field key="licence" value="GNU Public License version 2" /> + <field key="elgg_version" value="2010040201" /> + <field key="depends" value="oauth_lib" /> +</plugin_manifest> diff --git a/mod/twitterservice/start.php b/mod/twitterservice/start.php new file mode 100644 index 000000000..83e98d618 --- /dev/null +++ b/mod/twitterservice/start.php @@ -0,0 +1,134 @@ +<?php +/** + * Elgg Twitter Service + * This service plugin allows users to authenticate their Elgg account with Twitter. + * + * @package TwitterService + * @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2 + * @copyright Curverider Ltd 2008-2010 + */ + +register_elgg_event_handler('init','system','twitterservice_init'); +function twitterservice_init() { + global $CONFIG; + $notice_id = 'twitter_services_disable'; + + if (!is_plugin_enabled('oauth_lib')) { + // disable the plugin + disable_plugin('twitterservice'); + + // alert the admin + if (!elgg_admin_notice_exists($notice_id)) { + elgg_add_admin_notice($notice_id, elgg_echo('twitterservice:requires_oauth')); + } + } else { + // cleanup notices + elgg_delete_admin_notice($notice_id); + + // require libraries + require_once "{$CONFIG->pluginspath}twitterservice/vendors/twitteroauth/twitterOAuth.php"; + require_once "{$CONFIG->pluginspath}twitterservice/twitterservice_lib.php"; + + // extend site views + elgg_extend_view('metatags', 'twitterservice/metatags'); + elgg_extend_view('css', 'twitterservice/css'); + + // sign on with twitter + if (twitterservice_allow_sign_on_with_twitter()) { + elgg_extend_view('login/extend', 'twitterservice/login'); + } + + // register page handler + register_page_handler('twitterservice', 'twitterservice_pagehandler'); + + // register Walled Garden public pages + register_plugin_hook('public_pages', 'walled_garden', 'twitterservice_public_pages'); + + // allow plugin authors to hook into this service + register_plugin_hook('tweet', 'twitter_service', 'twitterservice_tweet'); + } +} + +function twitterservice_pagehandler($page) { + if (!isset($page[0])) { + forward(); + } + + switch ($page[0]) { + case 'authorize': + twitterservice_authorize(); + break; + case 'revoke': + twitterservice_revoke(); + break; + case 'forward': + twitterservice_forward(); + break; + case 'login': + twitterservice_login(); + break; + default: + forward(); + break; + } +} + +function twitterservice_tweet($hook, $entity_type, $returnvalue, $params) { + static $plugins; + if (!$plugins) { + $plugins = trigger_plugin_hook('plugin_list', 'twitter_service', NULL, array()); + } + + // ensure valid plugin + if (!in_array($params['plugin'], $plugins)) { + return NULL; + } + + // check admin settings + $consumer_key = get_plugin_setting('consumer_key', 'twitterservice'); + $consumer_secret = get_plugin_setting('consumer_secret', 'twitterservice'); + if (!($consumer_key && $consumer_secret)) { + return NULL; + } + + // check user settings + $user_id = get_loggedin_userid(); + $access_key = get_plugin_usersetting('access_key', $user_id, 'twitterservice'); + $access_secret = get_plugin_usersetting('access_secret', $user_id, 'twitterservice'); + if (!($access_key && $access_secret)) { + return NULL; + } + + // send tweet + $api = new TwitterOAuth($consumer_key, $consumer_secret, $access_key, $access_secret); + $response = $api->post('statuses/update', array('status' => $params['message'])); + + return TRUE; +} + +function twitterservice_fetch_tweets($user_id, $options=array()) { + // check admin settings + $consumer_key = get_plugin_setting('consumer_key', 'twitterservice'); + $consumer_secret = get_plugin_setting('consumer_secret', 'twitterservice'); + if (!($consumer_key && $consumer_secret)) { + return FALSE; + } + + // check user settings + $access_key = get_plugin_usersetting('access_key', $user_id, 'twitterservice'); + $access_secret = get_plugin_usersetting('access_secret', $user_id, 'twitterservice'); + if (!($access_key && $access_secret)) { + return FALSE; + } + + // fetch tweets + $api = new TwitterOAuth($consumer_key, $consumer_secret, $access_key, $access_secret); + return $api->get('statuses/user_timeline', $options); +} + +function twitterservice_public_pages($hook, $type, $return_value, $params) { + $return_value[] = 'pg/twitterservice/forward'; + $return_value[] = 'pg/twitterservice/login'; + + return $return_value; +} diff --git a/mod/twitterservice/twitterservice_lib.php b/mod/twitterservice/twitterservice_lib.php new file mode 100644 index 000000000..5f8768949 --- /dev/null +++ b/mod/twitterservice/twitterservice_lib.php @@ -0,0 +1,268 @@ +<?php +/** + * Common library of functions used by Twitter Services. + * + * @package TwitterService + * @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2 + * @copyright Curverider Ltd 2008-2010 + */ + +/** + * Tests if the system admin has enabled Sign-On-With-Twitter + * + * @param void + * @return bool + */ +function twitterservice_allow_sign_on_with_twitter() { + if (!$consumer_key = get_plugin_setting('consumer_key', 'twitterservice')) { + return FALSE; + } + + if (!$consumer_secret = get_plugin_setting('consumer_secret', 'twitterservice')) { + return FALSE; + } + + return get_plugin_setting('sign_on', 'twitterservice') == 'yes'; +} + +function twitterservice_forward() { + global $CONFIG; + + // sanity check + if (!twitterservice_allow_sign_on_with_twitter()) { + forward(); + } + + $callback = "{$CONFIG->site->url}pg/twitterservice/login"; + $request_link = twitterservice_get_authorize_url($callback); + + forward($request_link); +} + +function twitterservice_login() { + global $CONFIG; + + // sanity check + if (!twitterservice_allow_sign_on_with_twitter()) { + forward(); + } + + $token = twitterservice_get_access_token(get_input('oauth_verifier')); + if (!isset($token['oauth_token']) or !isset($token['oauth_token_secret'])) { + register_error(elgg_echo('twitterservice:login:error')); + forward(); + } + + // attempt to find user + $values = array( + 'plugin:settings:twitterservice:access_key' => $token['oauth_token'], + 'plugin:settings:twitterservice:access_secret' => $token['oauth_token_secret'], + ); + + if (!$users = get_entities_from_private_setting_multi($values, 'user', '', 0, '', 0)) { + // need Twitter account credentials + $consumer_key = get_plugin_setting('consumer_key', 'twitterservice'); + $consumer_secret = get_plugin_setting('consumer_secret', 'twitterservice'); + $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 (!$CONFIG->allow_registration) { + register_error(elgg_echo('registerdisabled')); + forward(); + } + + // trigger a hook for plugin authors to intercept + if (!trigger_plugin_hook('new_twitter_user', 'twitter_service', array('account' => $twitter), TRUE)) { + // halt execution + register_error(elgg_echo('twitterservice:login:error')); + forward(); + } + + // Elgg-ify Twitter credentials + $username = "{$twitter->screen_name}_twitter"; + $display_name = $twitter->name; + $password = generate_random_cleartext_password(); + + // @hack Temporary, junk email account to allow user creation + $email = "$username@elgg.com"; + + try { + // create new account + if (!$user_id = register_user($username, $password, $display_name, $email)) { + register_error(elgg_echo('registerbad')); + forward(); + } + } catch (RegistrationException $r) { + register_error($r->getMessage()); + forward(); + } + + $user = new ElggUser($user_id); + + // @hack Remove temporary email and forward to user settings page + // @todo Consider using a view to force valid email + system_message(elgg_echo('twitterservice:login:email')); + $user->email = ''; + $user->save(); + + $forward = "pg/settings/user/{$user->username}"; + } + + // set twitter services tokens + set_plugin_usersetting('twitter_name', $token['screen_name'], $user->guid); + set_plugin_usersetting('access_key', $token['oauth_token'], $user->guid); + set_plugin_usersetting('access_secret', $token['oauth_token_secret'], $user->guid); + + // pull in Twitter icon + twitterservice_update_user_avatar($user, $twitter->profile_image_url); + + // login new user + if (login($user)) { + system_message(elgg_echo('twitterservice:login:success')); + } else { + system_message(elgg_echo('twitterservice:login:error')); + } + + forward($forward); + } elseif (count($users) == 1) { + if (login($users[0])) { + system_message(elgg_echo('twitterservice:login:success')); + } else { + system_message(elgg_echo('twitterservice:login:error')); + } + + forward(); + } + + // register login error + register_error(elgg_echo('twitterservice:login:error')); + forward(); +} + +function twitterservice_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->username$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 twitterservice_get_authorize_url} being called previously + * to establish session request tokens. + */ +function twitterservice_authorize() { + $token = twitterservice_get_access_token(); + if (!isset($token['oauth_token']) || !isset($token['oauth_token_secret'])) { + register_error(elgg_echo('twitterservice:authorize:error')); + forward('pg/settings/plugins'); + } + + // only one user per tokens + $values = array( + 'plugin:settings:twitterservice:access_key' => $token['oauth_token'], + 'plugin:settings:twitterservice:access_secret' => $token['oauth_token_secret'], + ); + + if ($users = get_entities_from_private_setting_multi($values, 'user', '', 0, '', 0)) { + foreach ($users as $user) { + // revoke access + clear_plugin_usersetting('twitter_name', $user->getGUID()); + clear_plugin_usersetting('access_key', $user->getGUID()); + clear_plugin_usersetting('access_secret', $user->getGUID()); + } + } + + // register user's access tokens + set_plugin_usersetting('twitter_name', $token['screen_name']); + set_plugin_usersetting('access_key', $token['oauth_token']); + set_plugin_usersetting('access_secret', $token['oauth_token_secret']); + + system_message(elgg_echo('twitterservice:authorize:success')); + forward('pg/settings/plugins'); +} + +function twitterservice_revoke() { + // unregister user's access tokens + clear_plugin_usersetting('twitter_name'); + clear_plugin_usersetting('access_key'); + clear_plugin_usersetting('access_secret'); + + system_message(elgg_echo('twitterservice:revoke:success')); + forward('pg/settings/plugins'); +} + +function twitterservice_get_authorize_url($callback=NULL) { + global $SESSION; + + $consumer_key = get_plugin_setting('consumer_key', 'twitterservice'); + $consumer_secret = get_plugin_setting('consumer_secret', 'twitterservice'); + + // request tokens from Twitter + $twitter = new TwitterOAuth($consumer_key, $consumer_secret); + $token = $twitter->getRequestToken($callback); + + // save token in session for use after authorization + $SESSION['twitterservice'] = array( + 'oauth_token' => $token['oauth_token'], + 'oauth_token_secret' => $token['oauth_token_secret'], + ); + + return $twitter->getAuthorizeURL($token['oauth_token']); +} + +function twitterservice_get_access_token($oauth_verifier=FALSE) { + global $SESSION; + + $consumer_key = get_plugin_setting('consumer_key', 'twitterservice'); + $consumer_secret = get_plugin_setting('consumer_secret', 'twitterservice'); + + // retrieve stored tokens + $oauth_token = $SESSION['twitterservice']['oauth_token']; + $oauth_token_secret = $SESSION['twitterservice']['oauth_token_secret']; + $SESSION->offsetUnset('twitterservice'); + + // fetch an access token + $api = new TwitterOAuth($consumer_key, $consumer_secret, $oauth_token, $oauth_token_secret); + return $api->getAccessToken($oauth_verifier); +} diff --git a/mod/twitterservice/vendors/twitteroauth/LICENSE b/mod/twitterservice/vendors/twitteroauth/LICENSE new file mode 100755 index 000000000..233854f16 --- /dev/null +++ b/mod/twitterservice/vendors/twitteroauth/LICENSE @@ -0,0 +1,22 @@ +Copyright (c) 2009 Abraham Williams - http://abrah.am - abraham@poseurte.ch + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. diff --git a/mod/twitterservice/vendors/twitteroauth/OAuth.php b/mod/twitterservice/vendors/twitteroauth/OAuth.php new file mode 100755 index 000000000..b0e3cfd5e --- /dev/null +++ b/mod/twitterservice/vendors/twitteroauth/OAuth.php @@ -0,0 +1,517 @@ +<?php +// vim: foldmethod=marker + +class OAuthConsumer { + public $key; + public $secret; + + function __construct($key, $secret, $callback_url=NULL) { + $this->key = $key; + $this->secret = $secret; + $this->callback_url = $callback_url; + } + + function __toString() { + return "OAuthConsumer[key=$this->key,secret=$this->secret]"; + } +} + +class OAuthToken { + // access tokens and request tokens + public $key; + public $secret; + + /** + * key = the token + * secret = the token secret + */ + function __construct($key, $secret) { + $this->key = $key; + $this->secret = $secret; + } + + /** + * generates the basic string serialization of a token that a server + * would respond to request_token and access_token calls with + */ + function to_string() { + return "oauth_token=" . + OAuthUtil::urlencode_rfc3986($this->key) . + "&oauth_token_secret=" . + OAuthUtil::urlencode_rfc3986($this->secret); + } + + function __toString() { + return $this->to_string(); + } +} + +class twitterOAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod_HMAC_SHA1 {/*{{{*/ + function get_name() {/*{{{*/ + return "HMAC-SHA1"; + }/*}}}*/ + + public function build_signature($request, $consumer, $token) {/*{{{*/ + $base_string = $request->get_signature_base_string(); + $request->base_string = $base_string; + + $key_parts = array( + $consumer->secret, + ($token) ? $token->secret : "" + ); + + $key_parts = OAuthUtil::urlencode_rfc3986($key_parts); + $key = implode('&', $key_parts); + + return base64_encode( hash_hmac('sha1', $base_string, $key, true)); + }/*}}}*/ + + public function check_signature(&$request, $consumer, $token, $signature) { + $built = $this->build_signature($request, $consumer, $token); + return $built == $signature; + } +}/*}}}*/ + +class twitterOAuthRequest extends OAuthRequest { + private $parameters; + private $http_method; + private $http_url; + // for debug purposes + public $base_string; + public static $POST_INPUT = 'php://input'; + + function __construct($http_method, $http_url, $parameters=NULL) { + @$parameters or $parameters = array(); + $parameters = array_merge( OAuthUtil::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $parameters); + $this->parameters = $parameters; + $this->http_method = $http_method; + $this->http_url = $http_url; + } + + + /** + * attempt to build up a request from what was passed to the server + */ + public static function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) { + $scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on") + ? 'http' + : 'https'; + @$http_url or $http_url = $scheme . + '://' . $_SERVER['HTTP_HOST'] . + ':' . + $_SERVER['SERVER_PORT'] . + $_SERVER['REQUEST_URI']; + @$http_method or $http_method = $_SERVER['REQUEST_METHOD']; + + // We weren't handed any parameters, so let's find the ones relevant to + // this request. + // If you run XML-RPC or similar you should use this to provide your own + // parsed parameter-list + if (!$parameters) { + // Find request headers + $request_headers = OAuthUtil::get_headers(); + + // Parse the query-string to find GET parameters + $parameters = OAuthUtil::parse_parameters($_SERVER['QUERY_STRING']); + + // It's a POST request of the proper content-type, so parse POST + // parameters and add those overriding any duplicates from GET + if ($http_method == "POST" + && @strstr($request_headers["Content-Type"], + "application/x-www-form-urlencoded") + ) { + $post_data = OAuthUtil::parse_parameters( + file_get_contents(self::$POST_INPUT) + ); + $parameters = array_merge($parameters, $post_data); + } + + // We have a Authorization-header with OAuth data. Parse the header + // and add those overriding any duplicates from GET or POST + if (@substr($request_headers['Authorization'], 0, 6) == "OAuth ") { + $header_parameters = OAuthUtil::split_header( + $request_headers['Authorization'] + ); + $parameters = array_merge($parameters, $header_parameters); + } + + } + + return new twitterOAuthRequest($http_method, $http_url, $parameters); + } + + /** + * pretty much a helper function to set up the request + */ + public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=NULL) { + @$parameters or $parameters = array(); + $defaults = array("oauth_version" => '1.0', + "oauth_nonce" => twitterOAuthRequest::generate_nonce(), + "oauth_timestamp" => twitterOAuthRequest::generate_timestamp(), + "oauth_consumer_key" => $consumer->key); + if ($token) + $defaults['oauth_token'] = $token->key; + + $parameters = array_merge($defaults, $parameters); + + return new twitterOAuthRequest($http_method, $http_url, $parameters); + } + + public function set_parameter($name, $value, $allow_duplicates = true) { + if ($allow_duplicates && isset($this->parameters[$name])) { + // We have already added parameter(s) with this name, so add to the list + if (is_scalar($this->parameters[$name])) { + // This is the first duplicate, so transform scalar (string) + // into an array so we can add the duplicates + $this->parameters[$name] = array($this->parameters[$name]); + } + + $this->parameters[$name][] = $value; + } else { + $this->parameters[$name] = $value; + } + } + + public function get_parameter($name) { + return isset($this->parameters[$name]) ? $this->parameters[$name] : null; + } + + public function get_parameters() { + return $this->parameters; + } + + public function unset_parameter($name) { + unset($this->parameters[$name]); + } + + /** + * The request parameters, sorted and concatenated into a normalized string. + * @return string + */ + public function get_signable_parameters() { + // Grab all parameters + $params = $this->parameters; + + // Remove oauth_signature if present + // Ref: Spec: 9.1.1 ("The oauth_signature parameter MUST be excluded.") + if (isset($params['oauth_signature'])) { + unset($params['oauth_signature']); + } + + return OAuthUtil::build_http_query($params); + } + + /** + * Returns the base string of this request + * + * The base string defined as the method, the url + * and the parameters (normalized), each urlencoded + * and the concated with &. + */ + public function get_signature_base_string() { + $parts = array( + $this->get_normalized_http_method(), + $this->get_normalized_http_url(), + $this->get_signable_parameters() + ); + + $parts = OAuthUtil::urlencode_rfc3986($parts); + + return implode('&', $parts); + } + + /** + * just uppercases the http method + */ + public function get_normalized_http_method() { + return strtoupper($this->http_method); + } + + /** + * parses the url and rebuilds it to be + * scheme://host/path + */ + public function get_normalized_http_url() { + $parts = parse_url($this->http_url); + + $port = @$parts['port']; + $scheme = $parts['scheme']; + $host = $parts['host']; + $path = @$parts['path']; + + $port or $port = ($scheme == 'https') ? '443' : '80'; + + if (($scheme == 'https' && $port != '443') + || ($scheme == 'http' && $port != '80')) { + $host = "$host:$port"; + } + return "$scheme://$host$path"; + } + + /** + * builds a url usable for a GET request + */ + public function to_url() { + $post_data = $this->to_postdata(); + $out = $this->get_normalized_http_url(); + if ($post_data) { + $out .= '?'.$post_data; + } + return $out; + } + + /** + * builds the data one would send in a POST request + */ + public function to_postdata() { + return OAuthUtil::build_http_query($this->parameters); + } + + /** + * builds the Authorization: header + */ + public function to_header($realm=null) { + $first = true; + if($realm) { + $out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"'; + $first = false; + } else + $out = 'Authorization: OAuth'; + + $total = array(); + foreach ($this->parameters as $k => $v) { + if (substr($k, 0, 5) != "oauth") continue; + if (is_array($v)) { + throw new OAuthException('Arrays not supported in headers'); + } + $out .= ($first) ? ' ' : ','; + $out .= OAuthUtil::urlencode_rfc3986($k) . + '="' . + OAuthUtil::urlencode_rfc3986($v) . + '"'; + $first = false; + } + return $out; + } + + public function __toString() { + return $this->to_url(); + } + + + public function sign_request($signature_method, $consumer, $token) { + $this->set_parameter( + "oauth_signature_method", + $signature_method->get_name(), + false + ); + $signature = $this->build_signature($signature_method, $consumer, $token); + $this->set_parameter("oauth_signature", $signature, false); + } + + public function build_signature($signature_method, $consumer, $token) { + $signature = $signature_method->build_signature($this, $consumer, $token); + return $signature; + } + + /** + * util function: current timestamp + */ + private static function generate_timestamp() { + return time(); + } + + /** + * util function: current nonce + */ + private static function generate_nonce() { + $mt = microtime(); + $rand = mt_rand(); + + return md5($mt . $rand); // md5s look nicer than numbers + } +} + +class OAuthDataStore { + function lookup_consumer($consumer_key) { + // implement me + } + + function lookup_token($consumer, $token_type, $token) { + // implement me + } + + function lookup_nonce($consumer, $token, $nonce, $timestamp) { + // implement me + } + + function new_request_token($consumer, $callback = null) { + // return a new token attached to this consumer + } + + function new_access_token($token, $consumer, $verifier = null) { + // return a new access token attached to this consumer + // for the user associated with this token if the request token + // is authorized + // should also invalidate the request token + } + +} + +class OAuthUtil { + public static function urlencode_rfc3986($input) { + if (is_array($input)) { + return array_map(array('OAuthUtil', 'urlencode_rfc3986'), $input); + } else if (is_scalar($input)) { + return str_replace( + '+', + ' ', + str_replace('%7E', '~', rawurlencode($input)) + ); + } else { + return ''; + } +} + + + // This decode function isn't taking into consideration the above + // modifications to the encoding process. However, this method doesn't + // seem to be used anywhere so leaving it as is. + public static function urldecode_rfc3986($string) { + return urldecode($string); + } + + // Utility function for turning the Authorization: header into + // parameters, has to do some unescaping + // Can filter out any non-oauth parameters if needed (default behaviour) + public static function split_header($header, $only_allow_oauth_parameters = true) { + $pattern = '/(([-_a-z]*)=("([^"]*)"|([^,]*)),?)/'; + $offset = 0; + $params = array(); + while (preg_match($pattern, $header, $matches, PREG_OFFSET_CAPTURE, $offset) > 0) { + $match = $matches[0]; + $header_name = $matches[2][0]; + $header_content = (isset($matches[5])) ? $matches[5][0] : $matches[4][0]; + if (preg_match('/^oauth_/', $header_name) || !$only_allow_oauth_parameters) { + $params[$header_name] = OAuthUtil::urldecode_rfc3986($header_content); + } + $offset = $match[1] + strlen($match[0]); + } + + if (isset($params['realm'])) { + unset($params['realm']); + } + + return $params; + } + + // helper to try to sort out headers for people who aren't running apache + public static function get_headers() { + if (function_exists('apache_request_headers')) { + // we need this to get the actual Authorization: header + // because apache tends to tell us it doesn't exist + $headers = apache_request_headers(); + + // sanitize the output of apache_request_headers because + // we always want the keys to be Cased-Like-This and arh() + // returns the headers in the same case as they are in the + // request + $out = array(); + foreach( $headers AS $key => $value ) { + $key = str_replace( + " ", + "-", + ucwords(strtolower(str_replace("-", " ", $key))) + ); + $out[$key] = $value; + } + } else { + // otherwise we don't have apache and are just going to have to hope + // that $_SERVER actually contains what we need + $out = array(); + if( isset($_SERVER['CONTENT_TYPE']) ) + $out['Content-Type'] = $_SERVER['CONTENT_TYPE']; + if( isset($_ENV['CONTENT_TYPE']) ) + $out['Content-Type'] = $_ENV['CONTENT_TYPE']; + + foreach ($_SERVER as $key => $value) { + if (substr($key, 0, 5) == "HTTP_") { + // this is chaos, basically it is just there to capitalize the first + // letter of every word that is not an initial HTTP and strip HTTP + // code from przemek + $key = str_replace( + " ", + "-", + ucwords(strtolower(str_replace("_", " ", substr($key, 5)))) + ); + $out[$key] = $value; + } + } + } + return $out; + } + + // This function takes a input like a=b&a=c&d=e and returns the parsed + // parameters like this + // array('a' => array('b','c'), 'd' => 'e') + public static function parse_parameters( $input ) { + if (!isset($input) || !$input) return array(); + + $pairs = explode('&', $input); + + $parsed_parameters = array(); + foreach ($pairs as $pair) { + $split = explode('=', $pair, 2); + $parameter = OAuthUtil::urldecode_rfc3986($split[0]); + $value = isset($split[1]) ? OAuthUtil::urldecode_rfc3986($split[1]) : ''; + + if (isset($parsed_parameters[$parameter])) { + // We have already recieved parameter(s) with this name, so add to the list + // of parameters with this name + + if (is_scalar($parsed_parameters[$parameter])) { + // This is the first duplicate, so transform scalar (string) into an array + // so we can add the duplicates + $parsed_parameters[$parameter] = array($parsed_parameters[$parameter]); + } + + $parsed_parameters[$parameter][] = $value; + } else { + $parsed_parameters[$parameter] = $value; + } + } + return $parsed_parameters; + } + + public static function build_http_query($params) { + if (!$params) return ''; + + // Urlencode both keys and values + $keys = OAuthUtil::urlencode_rfc3986(array_keys($params)); + $values = OAuthUtil::urlencode_rfc3986(array_values($params)); + $params = array_combine($keys, $values); + + // Parameters are sorted by name, using lexicographical byte value ordering. + // Ref: Spec: 9.1.1 (1) + uksort($params, 'strcmp'); + + $pairs = array(); + foreach ($params as $parameter => $value) { + if (is_array($value)) { + // If two or more parameters share the same name, they are sorted by their value + // Ref: Spec: 9.1.1 (1) + natsort($value); + foreach ($value as $duplicate_value) { + $pairs[] = $parameter . '=' . $duplicate_value; + } + } else { + $pairs[] = $parameter . '=' . $value; + } + } + // For each parameter, the name is separated from the corresponding value by an '=' character (ASCII code 61) + // Each name-value pair is separated by an '&' character (ASCII code 38) + return implode('&', $pairs); + } +} + +?> diff --git a/mod/twitterservice/vendors/twitteroauth/README b/mod/twitterservice/vendors/twitteroauth/README new file mode 100755 index 000000000..33cb91f21 --- /dev/null +++ b/mod/twitterservice/vendors/twitteroauth/README @@ -0,0 +1,7 @@ +Abraham Williams | abraham@poseurte.ch | http://abrah.am | @abraham + +The first PHP library for working with Twitter's OAuth API. + +Documentation: http://wiki.github.com/abraham/twitteroauth/documentation +Source: http://github.com/abraham/twitteroauth +Twitter: http://apiwiki.twitter.com diff --git a/mod/twitterservice/vendors/twitteroauth/twitterOAuth.php b/mod/twitterservice/vendors/twitteroauth/twitterOAuth.php new file mode 100755 index 000000000..a1021ce6f --- /dev/null +++ b/mod/twitterservice/vendors/twitteroauth/twitterOAuth.php @@ -0,0 +1,245 @@ +<?php + +/* + * Abraham Williams (abraham@abrah.am) http://abrah.am + * + * The first PHP Library to support OAuth for Twitter's REST API. + */ + +/* Load OAuth lib. You can find it at http://oauth.net */ +require_once('OAuth.php'); + +/** + * Twitter OAuth class + */ +class TwitterOAuth { + /* Contains the last HTTP status code returned. */ + public $http_code; + /* Contains the last API call. */ + public $url; + /* Set up the API root URL. */ + public $host = "https://api.twitter.com/1/"; + /* Set timeout default. */ + public $timeout = 30; + /* Set connect timeout. */ + public $connecttimeout = 30; + /* Verify SSL Cert. */ + public $ssl_verifypeer = FALSE; + /* Respons format. */ + public $format = 'json'; + /* Decode returned json data. */ + public $decode_json = TRUE; + /* Contains the last HTTP headers returned. */ + public $http_info; + /* Set the useragnet. */ + public $useragent = 'TwitterOAuth v0.2.0-beta2'; + /* Immediately retry the API call if the response was not successful. */ + //public $retry = TRUE; + + + + + /** + * Set API URLS + */ + function accessTokenURL() { return 'https://api.twitter.com/oauth/access_token'; } + function authenticateURL() { return 'https://twitter.com/oauth/authenticate'; } + function authorizeURL() { return 'https://twitter.com/oauth/authorize'; } + function requestTokenURL() { return 'https://api.twitter.com/oauth/request_token'; } + + /** + * Debug helpers + */ + function lastStatusCode() { return $this->http_status; } + function lastAPICall() { return $this->last_api_call; } + + /** + * construct TwitterOAuth object + */ + function __construct($consumer_key, $consumer_secret, $oauth_token = NULL, $oauth_token_secret = NULL) { + $this->sha1_method = new twitterOAuthSignatureMethod_HMAC_SHA1(); + $this->consumer = new OAuthConsumer($consumer_key, $consumer_secret); + if (!empty($oauth_token) && !empty($oauth_token_secret)) { + $this->token = new OAuthConsumer($oauth_token, $oauth_token_secret); + } else { + $this->token = NULL; + } + } + + + /** + * Get a request_token from Twitter + * + * @returns a key/value array containing oauth_token and oauth_token_secret + */ + function getRequestToken($oauth_callback = NULL) { + $parameters = array(); + if (!empty($oauth_callback)) { + $parameters['oauth_callback'] = $oauth_callback; + } + $request = $this->oAuthRequest($this->requestTokenURL(), 'GET', $parameters); + $token = OAuthUtil::parse_parameters($request); + $this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']); + return $token; + } + + /** + * Get the authorize URL + * + * @returns a string + */ + function getAuthorizeURL($token, $sign_in_with_twitter = TRUE) { + if (is_array($token)) { + $token = $token['oauth_token']; + } + if (empty($sign_in_with_twitter)) { + return $this->authorizeURL() . "?oauth_token={$token}"; + } else { + return $this->authenticateURL() . "?oauth_token={$token}"; + } + } + + /** + * Exchange request token and secret for an access token and + * secret, to sign API calls. + * + * @returns array("oauth_token" => "the-access-token", + * "oauth_token_secret" => "the-access-secret", + * "user_id" => "9436992", + * "screen_name" => "abraham") + */ + function getAccessToken($oauth_verifier = FALSE) { + $parameters = array(); + if (!empty($oauth_verifier)) { + $parameters['oauth_verifier'] = $oauth_verifier; + } + $request = $this->oAuthRequest($this->accessTokenURL(), 'GET', $parameters); + $token = OAuthUtil::parse_parameters($request); + $this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']); + return $token; + } + + /** + * One time exchange of username and password for access token and secret. + * + * @returns array("oauth_token" => "the-access-token", + * "oauth_token_secret" => "the-access-secret", + * "user_id" => "9436992", + * "screen_name" => "abraham", + * "x_auth_expires" => "0") + */ + function getXAuthToken($username, $password) { + $parameters = array(); + $parameters['x_auth_username'] = $username; + $parameters['x_auth_password'] = $password; + $parameters['x_auth_mode'] = 'client_auth'; + $request = $this->oAuthRequest($this->accessTokenURL(), 'POST', $parameters); + $token = OAuthUtil::parse_parameters($request); + $this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']); + return $token; + } + + /** + * GET wrapper for oAuthRequest. + */ + function get($url, $parameters = array()) { + $response = $this->oAuthRequest($url, 'GET', $parameters); + if ($this->format === 'json' && $this->decode_json) { + return json_decode($response); + } + return $response; + } + + /** + * POST wrapper for oAuthRequest. + */ + function post($url, $parameters = array()) { + $response = $this->oAuthRequest($url, 'POST', $parameters); + if ($this->format === 'json' && $this->decode_json) { + return json_decode($response); + } + return $response; + } + + /** + * DELETE wrapper for oAuthReqeust. + */ + function delete($url, $parameters = array()) { + $response = $this->oAuthRequest($url, 'DELETE', $parameters); + if ($this->format === 'json' && $this->decode_json) { + return json_decode($response); + } + return $response; + } + + /** + * Format and sign an OAuth / API request + */ + function oAuthRequest($url, $method, $parameters) { + if (strrpos($url, 'https://') !== 0 && strrpos($url, 'http://') !== 0) { + $url = "{$this->host}{$url}.{$this->format}"; + } + $request = twitterOAuthRequest::from_consumer_and_token($this->consumer, $this->token, $method, $url, $parameters); + $request->sign_request($this->sha1_method, $this->consumer, $this->token); + switch ($method) { + case 'GET': + return $this->http($request->to_url(), 'GET'); + default: + return $this->http($request->get_normalized_http_url(), $method, $request->to_postdata()); + } + } + + /** + * Make an HTTP request + * + * @return API results + */ + function http($url, $method, $postfields = NULL) { + $this->http_info = array(); + $ci = curl_init(); + /* Curl settings */ + curl_setopt($ci, CURLOPT_USERAGENT, $this->useragent); + curl_setopt($ci, CURLOPT_CONNECTTIMEOUT, $this->connecttimeout); + curl_setopt($ci, CURLOPT_TIMEOUT, $this->timeout); + curl_setopt($ci, CURLOPT_RETURNTRANSFER, TRUE); + curl_setopt($ci, CURLOPT_HTTPHEADER, array('Expect:')); + curl_setopt($ci, CURLOPT_SSL_VERIFYPEER, $this->ssl_verifypeer); + curl_setopt($ci, CURLOPT_HEADERFUNCTION, array($this, 'getHeader')); + curl_setopt($ci, CURLOPT_HEADER, FALSE); + + switch ($method) { + case 'POST': + curl_setopt($ci, CURLOPT_POST, TRUE); + if (!empty($postfields)) { + curl_setopt($ci, CURLOPT_POSTFIELDS, $postfields); + } + break; + case 'DELETE': + curl_setopt($ci, CURLOPT_CUSTOMREQUEST, 'DELETE'); + if (!empty($postfields)) { + $url = "{$url}?{$postfields}"; + } + } + + curl_setopt($ci, CURLOPT_URL, $url); + $response = curl_exec($ci); + $this->http_code = curl_getinfo($ci, CURLINFO_HTTP_CODE); + $this->http_info = array_merge($this->http_info, curl_getinfo($ci)); + $this->url = $url; + curl_close ($ci); + return $response; + } + + /** + * Get the header info to store. + */ + function getHeader($ch, $header) { + $i = strpos($header, ':'); + if (!empty($i)) { + $key = str_replace('-', '_', strtolower(substr($header, 0, $i))); + $value = trim(substr($header, $i + 2)); + $this->http_header[$key] = $value; + } + return strlen($header); + } +} diff --git a/mod/twitterservice/views/default/settings/twitterservice/edit.php b/mod/twitterservice/views/default/settings/twitterservice/edit.php new file mode 100644 index 000000000..01897db23 --- /dev/null +++ b/mod/twitterservice/views/default/settings/twitterservice/edit.php @@ -0,0 +1,40 @@ +<?php +/** + * + */ +$insert_view = elgg_view('twittersettings/extend'); + +$consumer_key_string = elgg_echo('twitterservice:consumer_key'); +$consumer_key_view = elgg_view('input/text', array( + 'internalname' => 'params[consumer_key]', + 'value' => $vars['entity']->consumer_key, + 'class' => 'text_input', +)); + +$consumer_secret_string = elgg_echo('twitterservice:consumer_secret'); +$consumer_secret_view = elgg_view('input/text', array( + 'internalname' => 'params[consumer_secret]', + 'value' => $vars['entity']->consumer_secret, + 'class' => 'text_input', +)); + +$sign_on_with_twitter_string = elgg_echo('twitterservice:login'); +$sign_on_with_twitter_view = elgg_view('input/pulldown', array( + 'internalname' => 'params[sign_on]', + 'options_values' => array( + 'yes' => elgg_echo('option:yes'), + 'no' => elgg_echo('option:no'), + ), + 'value' => $vars['entity']->sign_on ? $vars['entity']->sign_on : 'no', +)); + +$settings = <<<__HTML +<div id="twitterservice_site_settings"> + <div>$insert_view</div> + <div>$consumer_key_string $consumer_key_view</div> + <div>$consumer_secret_string $consumer_secret_view</div> + <div>$sign_on_with_twitter_string $sign_on_with_twitter_view</div> +</div> +__HTML; + +echo $settings; diff --git a/mod/twitterservice/views/default/twitterservice/css.php b/mod/twitterservice/views/default/twitterservice/css.php new file mode 100644 index 000000000..572144067 --- /dev/null +++ b/mod/twitterservice/views/default/twitterservice/css.php @@ -0,0 +1,12 @@ +<?php +/** + * Elgg TwitterService CSS + */ +?> + +#twitterservice_site_settings .text_input { + width: 350px; +} +#login_with_twitter { + padding: 10px 0 0 0; +} diff --git a/mod/twitterservice/views/default/twitterservice/login.php b/mod/twitterservice/views/default/twitterservice/login.php new file mode 100644 index 000000000..8db63af36 --- /dev/null +++ b/mod/twitterservice/views/default/twitterservice/login.php @@ -0,0 +1,16 @@ +<?php +/** + * + */ + +$url = "{$vars['url']}pg/twitterservice/forward"; + +$login = <<<__HTML +<div id="login_with_twitter"> + <a href="$url"> + <img src="{$vars['url']}mod/twitterservice/graphics/sign_in_with_twitter.gif" alt="Twitter" /> + </a> +</div> +__HTML; + +echo $login; diff --git a/mod/twitterservice/views/default/twitterservice/metatags.php b/mod/twitterservice/views/default/twitterservice/metatags.php new file mode 100644 index 000000000..1335cd759 --- /dev/null +++ b/mod/twitterservice/views/default/twitterservice/metatags.php @@ -0,0 +1,21 @@ +<?php +/** + * Adds required HTML head tags for Twitter Services. + * + * @package TwitterService + * @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2 + * @copyright Curverider Ltd 2010 + */ + +if ($api_key = get_plugin_setting('consumer_key', 'twitterservice')) { + $tags = <<<__HTML +<script src="http://platform.twitter.com/anywhere.js?id=$api_key&v=1" type="text/javascript"></script> +<script type="text/javascript"> + twttr.anywhere(function (T) { + T(".twitter_anywhere").hovercards(); + }); +</script> +__HTML; + + echo $tags; +} diff --git a/mod/twitterservice/views/default/usersettings/twitterservice/edit.php b/mod/twitterservice/views/default/usersettings/twitterservice/edit.php new file mode 100644 index 000000000..95a2a2fd6 --- /dev/null +++ b/mod/twitterservice/views/default/usersettings/twitterservice/edit.php @@ -0,0 +1,21 @@ +<?php +/** + * + */ + +$user_id = get_loggedin_userid(); +$twitter_name = get_plugin_usersetting('twitter_name', $user_id, 'twitterservice'); +$access_key = get_plugin_usersetting('access_key', $user_id, 'twitterservice'); +$access_secret = get_plugin_usersetting('access_secret', $user_id, 'twitterservice'); + +echo '<p>' . elgg_echo('twitterservice:usersettings:description') . '</p>'; + +if (!$access_key || !$access_secret) { + // send user off to validate account + $request_link = twitterservice_get_authorize_url(); + echo '<p>' . sprintf(elgg_echo('twitterservice:usersettings:request'), $request_link) . '</p>'; +} else { + $url = "{$CONFIG->site->url}pg/twitterservice/revoke"; + echo '<p class="twitter_anywhere">' . sprintf(elgg_echo('twitterservice:usersettings:authorized'), $twitter_name) . '</p>'; + echo '<p>' . sprintf(elgg_echo('twitterservice:usersettings:revoke'), $url) . '</p>'; +} |
