lib/oauthclient.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base class for doing OAuth calls as a consumer
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Action
  23  * @package   StatusNet
  24  * @author    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once 'OAuth.php';
  35
  36 /**
  37  * Exception wrapper for cURL errors
  38  *
  39  * @category Integration
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  *
  45  */
  46 class OAuthClientException extends Exception
  47 {
  48 }
  49
  50 /**
  51  * Base class for doing OAuth calls as a consumer
  52  *
  53  * @category Integration
  54  * @package  StatusNet
  55  * @author   Zach Copley <zach@status.net>
  56  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  57  * @link     http://status.net/
  58  *
  59  */
  60 class OAuthClient
  61 {
  62     var $consumer;
  63     var $token;
  64
  65     /**
  66      * Constructor
  67      *
  68      * Can be initialized with just consumer key and secret for requesting new
  69      * tokens or with additional request token or access token
  70      *
  71      * @param string $consumer_key       consumer key
  72      * @param string $consumer_secret    consumer secret
  73      * @param string $oauth_token        user's token
  74      * @param string $oauth_token_secret user's secret
  75      *
  76      * @return nothing
  77      */
  78     function __construct($consumer_key, $consumer_secret,
  79                          $oauth_token = null, $oauth_token_secret = null)
  80     {
  81         $this->sha1_method = new OAuthSignatureMethod_HMAC_SHA1();
  82         $this->consumer    = new OAuthConsumer($consumer_key, $consumer_secret);
  83         $this->token       = null;
  84
  85         if (isset($oauth_token) && isset($oauth_token_secret)) {
  86             $this->token = new OAuthToken($oauth_token, $oauth_token_secret);
  87         }
  88     }
  89
  90     /**
  91      * Gets a request token from the given url
  92      *
  93      * @param string $url OAuth endpoint for grabbing request tokens
  94      *
  95      * @return OAuthToken $token the request token
  96      */
  97     function getRequestToken($url)
  98     {
  99         $response = $this->oAuthGet($url);
 100         $arr = array();
 101         parse_str($response, $arr);
 102         if (isset($arr['oauth_token']) && isset($arr['oauth_token_secret'])) {
 103             $token = new OAuthToken($arr['oauth_token'], @$arr['oauth_token_secret']);
 104             return $token;
 105         } else {
 106             throw new OAuthClientException();
 107         }
 108     }
 109
 110     /**
 111      * Builds a link that can be redirected to in order to
 112      * authorize a request token.
 113      *
 114      * @param string     $url            endpoint for authorizing request tokens
 115      * @param OAuthToken $request_token  the request token to be authorized
 116      * @param string     $oauth_callback optional callback url
 117      *
 118      * @return string $authorize_url the url to redirect to
 119      */
 120     function getAuthorizeLink($url, $request_token, $oauth_callback = null)
 121     {
 122         $authorize_url = $url . '?oauth_token=' .
 123             $request_token->key;
 124
 125         if (isset($oauth_callback)) {
 126             $authorize_url .= '&oauth_callback=' . urlencode($oauth_callback);
 127         }
 128
 129         return $authorize_url;
 130     }
 131
 132     /**
 133      * Fetches an access token
 134      *
 135      * @param string $url OAuth endpoint for exchanging authorized request tokens
 136      *                     for access tokens
 137      *
 138      * @return OAuthToken $token the access token
 139      */
 140     function getAccessToken($url)
 141     {
 142         $response = $this->oAuthPost($url);
 143         parse_str($response);
 144         $token = new OAuthToken($oauth_token, $oauth_token_secret);
 145         return $token;
 146     }
 147
 148     /**
 149      * Use HTTP GET to make a signed OAuth request
 150      *
 151      * @param string $url OAuth endpoint
 152      *
 153      * @return mixed the request
 154      */
 155     function oAuthGet($url)
 156     {
 157         $request = OAuthRequest::from_consumer_and_token($this->consumer,
 158             $this->token, 'GET', $url, null);
 159         $request->sign_request($this->sha1_method,
 160             $this->consumer, $this->token);
 161
 162         return $this->httpRequest($request->to_url());
 163     }
 164
 165     /**
 166      * Use HTTP POST to make a signed OAuth request
 167      *
 168      * @param string $url    OAuth endpoint
 169      * @param array  $params additional post parameters
 170      *
 171      * @return mixed the request
 172      */
 173     function oAuthPost($url, $params = null)
 174     {
 175         $request = OAuthRequest::from_consumer_and_token($this->consumer,
 176             $this->token, 'POST', $url, $params);
 177         $request->sign_request($this->sha1_method,
 178             $this->consumer, $this->token);
 179
 180         return $this->httpRequest($request->get_normalized_http_url(),
 181             $request->to_postdata());
 182     }
 183
 184     /**
 185      * Make a HTTP request.
 186      *
 187      * @param string $url    Where to make the
 188      * @param array  $params post parameters
 189      *
 190      * @return mixed the request
 191      */
 192     function httpRequest($url, $params = null)
 193     {
 194         $request = new HTTPClient($url);
 195         $request->setConfig(array(
 196             'connect_timeout' => 120,
 197             'timeout' => 120,
 198             'follow_redirects' => true,
 199             'ssl_verify_peer' => false,
 200             'ssl_verify_host' => false
 201         ));
 202
 203         // Twitter is strict about accepting invalid "Expect" headers
 204         $request->setHeader('Expect', '');
 205
 206         if (isset($params)) {
 207             $request->setMethod(HTTP_Request2::METHOD_POST);
 208             $request->setBody($params);
 209         }
 210
 211         try {
 212             $response = $request->send();
 213             $code = $response->getStatus();
 214             if ($code < 200 || $code >= 400) {
 215                 throw new OAuthClientException($response->getBody(), $code);
 216             }
 217             return $response->getBody();
 218         } catch (Exception $e) {
 219             throw new OAuthClientException($e->getMessage(), $e->getCode());
 220         }
 221     }
 222
 223 }