]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/oauthclient.php
fix notices in dumpschema
[quix0rs-gnu-social.git] / 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      * @param string $callback authorized request token callback
95      *
96      * @return OAuthToken $token the request token
97      */
98     function getRequestToken($url, $callback = null)
99     {
100         $params = null;
101
102         if (!is_null($callback)) {
103             $params['oauth_callback'] = $callback;
104         }
105
106         $response = $this->oAuthGet($url, $params);
107
108         $arr = array();
109         parse_str($response, $arr);
110
111         $token   = $arr['oauth_token'];
112         $secret  = $arr['oauth_token_secret'];
113         $confirm = $arr['oauth_callback_confirmed'];
114
115         if (isset($token) && isset($secret)) {
116
117             $token = new OAuthToken($token, $secret);
118
119             if (isset($confirm)) {
120                 if ($confirm == 'true') {
121                     common_debug('Twitter bridge - callback confirmed.');
122                     return $token;
123                 } else {
124                     throw new OAuthClientException(
125                         'Callback was not confirmed by Twitter.'
126                     );
127                 }
128             }
129             return $token;
130         } else {
131             throw new OAuthClientException(
132                 'Could not get a request token from Twitter.'
133             );
134         }
135     }
136
137     /**
138      * Builds a link that can be redirected to in order to
139      * authorize a request token.
140      *
141      * @param string     $url            endpoint for authorizing request tokens
142      * @param OAuthToken $request_token  the request token to be authorized
143      *
144      * @return string $authorize_url the url to redirect to
145      */
146     function getAuthorizeLink($url, $request_token)
147     {
148         $authorize_url = $url . '?oauth_token=' .
149             $request_token->key;
150
151         return $authorize_url;
152     }
153
154     /**
155      * Fetches an access token
156      *
157      * @param string $url      OAuth endpoint for exchanging authorized request tokens
158      *                         for access tokens
159      * @param string $verifier 1.0a verifier
160      *
161      * @return OAuthToken $token the access token
162      */
163     function getAccessToken($url, $verifier = null)
164     {
165         $params = array();
166
167         if (!is_null($verifier)) {
168             $params['oauth_verifier'] = $verifier;
169         }
170
171         $response = $this->oAuthPost($url, $params);
172
173         $arr = array();
174         parse_str($response, $arr);
175
176         $token  = $arr['oauth_token'];
177         $secret = $arr['oauth_token_secret'];
178
179         if (isset($token) && isset($secret)) {
180             $token = new OAuthToken($token, $secret);
181             return $token;
182         } else {
183             throw new OAuthClientException(
184                 'Could not get a access token from Twitter.'
185             );
186         }
187     }
188
189     /**
190      * Use HTTP GET to make a signed OAuth requesta
191      *
192      * @param string $url    OAuth request token endpoint
193      * @param array  $params additional parameters
194      *
195      * @return mixed the request
196      */
197     function oAuthGet($url, $params = null)
198     {
199         $request = OAuthRequest::from_consumer_and_token($this->consumer,
200             $this->token, 'GET', $url, $params);
201         $request->sign_request($this->sha1_method,
202             $this->consumer, $this->token);
203
204         return $this->httpRequest($request->to_url());
205     }
206
207     /**
208      * Use HTTP POST to make a signed OAuth request
209      *
210      * @param string $url    OAuth endpoint
211      * @param array  $params additional post parameters
212      *
213      * @return mixed the request
214      */
215     function oAuthPost($url, $params = null)
216     {
217         $request = OAuthRequest::from_consumer_and_token($this->consumer,
218             $this->token, 'POST', $url, $params);
219         $request->sign_request($this->sha1_method,
220             $this->consumer, $this->token);
221
222         return $this->httpRequest($request->get_normalized_http_url(),
223             $request->to_postdata());
224     }
225
226     /**
227      * Make a HTTP request.
228      *
229      * @param string $url    Where to make the
230      * @param array  $params post parameters
231      *
232      * @return mixed the request
233      */
234     function httpRequest($url, $params = null)
235     {
236         $request = new HTTPClient($url);
237         $request->setConfig(array(
238             'connect_timeout' => 120,
239             'timeout' => 120,
240             'follow_redirects' => true,
241             'ssl_verify_peer' => false,
242             'ssl_verify_host' => false
243         ));
244
245         // Twitter is strict about accepting invalid "Expect" headers
246         $request->setHeader('Expect', '');
247
248         if (isset($params)) {
249             $request->setMethod(HTTP_Request2::METHOD_POST);
250             $request->setBody($params);
251         }
252
253         try {
254             $response = $request->send();
255             $code = $response->getStatus();
256             if ($code < 200 || $code >= 400) {
257                 throw new OAuthClientException($response->getBody(), $code);
258             }
259             return $response->getBody();
260         } catch (Exception $e) {
261             throw new OAuthClientException($e->getMessage(), $e->getCode());
262         }
263     }
264
265 }