/trunk/lib/twitter/EpiOAuth.php
PHP | 258 lines | 213 code | 40 blank | 5 comment | 18 complexity | 7eae007c282fbe300c4d101c1b5e25bf MD5 | raw file
Possible License(s): LGPL-2.1
- <?php
- class EpiOAuth
- {
- public $version = '1.0';
- protected $requestTokenUrl;
- protected $accessTokenUrl;
- protected $authenticateUrl;
- protected $authorizeUrl;
- protected $consumerKey;
- protected $consumerSecret;
- protected $token;
- protected $tokenSecret;
- protected $signatureMethod;
- public function getAccessToken()
- {
- $resp = $this->httpRequest('GET', $this->accessTokenUrl);
- return new EpiOAuthResponse($resp);
- }
- public function getAuthenticateUrl()
- {
- $token = $this->getRequestToken();
- return $this->authenticateUrl . '?oauth_token=' . $token->oauth_token;
- }
- public function getAuthorizationUrl()
- {
- $token = $this->getRequestToken();
- return $this->authorizeUrl . '?oauth_token=' . $token->oauth_token;
- }
- public function getRequestToken()
- {
- $resp = $this->httpRequest('GET', $this->requestTokenUrl);
- return new EpiOAuthResponse($resp);
- }
- public function httpRequest($method = null, $url = null, $params = null)
- {
- if(empty($method) || empty($url))
- return false;
- if(empty($params['oauth_signature']))
- $params = $this->prepareParameters($method, $url, $params);
- switch($method)
- {
- case 'GET':
- return $this->httpGet($url, $params);
- break;
- case 'POST':
- return $this->httpPost($url, $params);
- break;
- }
- }
- public function setToken($token = null, $secret = null)
- {
- $params = func_get_args();
- $this->token = $token;
- $this->tokenSecret = $secret;
- }
- protected function encode_rfc3986($string)
- {
- return str_replace('+', ' ', str_replace('%7E', '~', rawurlencode(($string))));
- }
- protected function addOAuthHeaders(&$ch, $url, $oauthHeaders)
- {
- $_h = array('Expect:');
- $urlParts = parse_url($url);
- $oauth = 'Authorization: OAuth realm="' . $urlParts['path'] . '",';
- foreach($oauthHeaders as $name => $value)
- {
- $oauth .= "{$name}=\"{$value}\",";
- }
- $_h[] = substr($oauth, 0, -1);
-
- curl_setopt($ch, CURLOPT_HTTPHEADER, $_h);
- }
- protected function generateNonce()
- {
- if(isset($this->nonce)) // for unit testing
- return $this->nonce;
- return md5(uniqid(rand(), true));
- }
- protected function generateSignature($method = null, $url = null, $params = null)
- {
- if(empty($method) || empty($url))
- return false;
- // concatenating
- $concatenatedParams = '';
- foreach($params as $k => $v)
- {
- $v = $this->encode_rfc3986($v);
- $concatenatedParams .= "{$k}={$v}&";
- }
- $concatenatedParams = $this->encode_rfc3986(substr($concatenatedParams, 0, -1));
- // normalize url
- $normalizedUrl = $this->encode_rfc3986($this->normalizeUrl($url));
- $method = $this->encode_rfc3986($method); // don't need this but why not?
- $signatureBaseString = "{$method}&{$normalizedUrl}&{$concatenatedParams}";
- return $this->signString($signatureBaseString);
- }
- protected function httpGet($url, $params = null)
- {
- if(count($params['request']) > 0)
- {
- $url .= '?';
- foreach($params['request'] as $k => $v)
- {
- $url .= "{$k}={$v}&";
- }
- $url = substr($url, 0, -1);
- }
- $ch = curl_init($url);
- $this->addOAuthHeaders($ch, $url, $params['oauth']);
- curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
- $resp = $this->curl->addCurl($ch);
- return $resp;
- }
- protected function httpPost($url, $params = null)
- {
- $ch = curl_init($url);
- $this->addOAuthHeaders($ch, $url, $params['oauth']);
- curl_setopt($ch, CURLOPT_POST, 1);
- curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params['request']));
- curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
- $resp = $this->curl->addCurl($ch);
- return $resp;
- }
- protected function normalizeUrl($url = null)
- {
- $urlParts = parse_url($url);
- $scheme = strtolower($urlParts['scheme']);
- $host = strtolower($urlParts['host']);
- $port = isset( $urlParts['port'] ) ? intval($urlParts['port']) : 80;
- $retval = "{$scheme}://{$host}";
- if($port > 0 && ($scheme === 'http' && $port !== 80) || ($scheme === 'https' && $port !== 443))
- {
- $retval .= ":{$port}";
- }
- $retval .= $urlParts['path'];
- if(!empty($urlParts['query']))
- {
- $retval .= "?{$urlParts['query']}";
- }
- return $retval;
- }
- protected function prepareParameters($method = null, $url = null, $params = null)
- {
- if(empty($method) || empty($url))
- return false;
- $oauth['oauth_consumer_key'] = $this->consumerKey;
- $oauth['oauth_token'] = $this->token;
- $oauth['oauth_nonce'] = $this->generateNonce();
- $oauth['oauth_timestamp'] = !isset($this->timestamp) ? time() : $this->timestamp; // for unit test
- $oauth['oauth_signature_method'] = $this->signatureMethod;
- $oauth['oauth_version'] = $this->version;
- // encoding
- array_walk($oauth, array($this, 'encode_rfc3986'));
- if(is_array($params))
- array_walk($params, array($this, 'encode_rfc3986'));
- $encodedParams = array_merge($oauth, (array)$params);
- // sorting
- ksort($encodedParams);
- // signing
- $oauth['oauth_signature'] = $this->encode_rfc3986($this->generateSignature($method, $url, $encodedParams));
- return array('request' => $params, 'oauth' => $oauth);
- }
- protected function signString($string = null)
- {
- $retval = false;
- switch($this->signatureMethod)
- {
- case 'HMAC-SHA1':
- $key = $this->encode_rfc3986($this->consumerSecret) . '&' . $this->encode_rfc3986($this->tokenSecret);
- $retval = base64_encode(hash_hmac('sha1', $string, $key, true));
- break;
- }
- return $retval;
- }
- public function __construct($consumerKey, $consumerSecret, $signatureMethod='HMAC-SHA1')
- {
- $this->consumerKey = $consumerKey;
- $this->consumerSecret = $consumerSecret;
- $this->signatureMethod = $signatureMethod;
- $this->curl = EpiCurl::getInstance();
- }
- }
- class EpiOAuthResponse
- {
- private $__resp;
- public function __construct($resp)
- {
- $this->__resp = $resp;
- }
- public function __get($name)
- {
- if($this->__resp->code != 200)
- EpiOAuthException::raise($this->__resp->data, $this->__resp->code);
- $result = null;
- parse_str($this->__resp->data, $result);
- foreach($result as $k => $v)
- {
- $this->$k = $v;
- }
- return $result[$name];
- }
- }
- class EpiOAuthException extends Exception
- {
- public static function raise($message, $code)
- {
- switch($code)
- {
- case 400:
- throw new EpiOAuthBadRequestException($message, $code);
- case 401:
- throw new EpiOAuthUnauthorizedException($message, $code);
- default:
- throw new EpiOAuthException($message, $code);
- }
- }
- }
- class EpiOAuthBadRequestException extends EpiOAuthException{}
- class EpiOAuthUnauthorizedException extends EpiOAuthException{}