3 * Laconica, the distributed open-source microblogging tool
5 * Base class for doing OAuth calls as a consumer
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.
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.
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/>.
24 * @author Zach Copley <zach@controlyourself.ca>
25 * @copyright 2008 Control Yourself, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://laconi.ca/
30 if (!defined('LACONICA')) {
34 require_once 'OAuth.php';
37 * Exception wrapper for cURL errors
39 * @category Integration
41 * @author Zach Copley <zach@controlyourself.ca>
42 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
43 * @link http://laconi.ca/
46 class OAuthClientCurlException extends Exception
51 * Base class for doing OAuth calls as a consumer
53 * @category Integration
55 * @author Zach Copley <zach@controlyourself.ca>
56 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
57 * @link http://laconi.ca/
68 * Can be initialized with just consumer key and secret for requesting new
69 * tokens or with additional request token or access token
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
78 function __construct($consumer_key, $consumer_secret,
79 $oauth_token = null, $oauth_token_secret = null)
81 $this->sha1_method = new OAuthSignatureMethod_HMAC_SHA1();
82 $this->consumer = new OAuthConsumer($consumer_key, $consumer_secret);
85 if (isset($oauth_token) && isset($oauth_token_secret)) {
86 $this->token = new OAuthToken($oauth_token, $oauth_token_secret);
91 * Gets a request token from the given url
93 * @param string $url OAuth endpoint for grabbing request tokens
95 * @return OAuthToken $token the request token
97 function getRequestToken($url)
99 $response = $this->oAuthGet($url);
100 parse_str($response);
101 $token = new OAuthToken($oauth_token, $oauth_token_secret);
106 * Builds a link that can be redirected to in order to
107 * authorize a request token.
109 * @param string $url endpoint for authorizing request tokens
110 * @param OAuthToken $request_token the request token to be authorized
111 * @param string $oauth_callback optional callback url
113 * @return string $authorize_url the url to redirect to
115 function getAuthorizeLink($url, $request_token, $oauth_callback = null)
117 $authorize_url = $url . '?oauth_token=' .
120 if (isset($oauth_callback)) {
121 $authorize_url .= '&oauth_callback=' . urlencode($oauth_callback);
124 common_debug("$authorize_url");
126 return $authorize_url;
130 * Fetches an access token
132 * @param string $url OAuth endpoint for exchanging authorized request tokens
135 * @return OAuthToken $token the access token
137 function getAccessToken($url)
139 $response = $this->oAuthPost($url);
140 parse_str($response);
141 $token = new OAuthToken($oauth_token, $oauth_token_secret);
146 * Use HTTP GET to make a signed OAuth request
148 * @param string $url OAuth endpoint
150 * @return mixed the request
152 function oAuthGet($url)
154 $request = OAuthRequest::from_consumer_and_token($this->consumer,
155 $this->token, 'GET', $url, null);
156 $request->sign_request($this->sha1_method,
157 $this->consumer, $this->token);
159 return $this->httpRequest($request->to_url());
163 * Use HTTP POST to make a signed OAuth request
165 * @param string $url OAuth endpoint
166 * @param array $params additional post parameters
168 * @return mixed the request
170 function oAuthPost($url, $params = null)
172 $request = OAuthRequest::from_consumer_and_token($this->consumer,
173 $this->token, 'POST', $url, $params);
174 $request->sign_request($this->sha1_method,
175 $this->consumer, $this->token);
177 return $this->httpRequest($request->get_normalized_http_url(),
178 $request->to_postdata());
182 * Make a HTTP request using cURL.
184 * @param string $url Where to make the
185 * @param array $params post parameters
187 * @return mixed the request
189 function httpRequest($url, $params = null)
192 CURLOPT_RETURNTRANSFER => true,
193 CURLOPT_FAILONERROR => true,
194 CURLOPT_HEADER => false,
195 CURLOPT_FOLLOWLOCATION => true,
196 CURLOPT_USERAGENT => 'Laconica',
197 CURLOPT_CONNECTTIMEOUT => 120,
198 CURLOPT_TIMEOUT => 120,
199 CURLOPT_HTTPAUTH => CURLAUTH_ANY,
200 CURLOPT_SSL_VERIFYPEER => false,
202 // Twitter is strict about accepting invalid "Expect" headers
204 CURLOPT_HTTPHEADER => array('Expect:')
207 if (isset($params)) {
208 $options[CURLOPT_POST] = true;
209 $options[CURLOPT_POSTFIELDS] = $params;
212 $ch = curl_init($url);
213 curl_setopt_array($ch, $options);
214 $response = curl_exec($ch);
216 if ($response === false) {
217 $msg = curl_error($ch);
218 $code = curl_errno($ch);
219 throw new OAuthClientCurlException($msg, $code);