]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/TwitterBridge/twitteroauthclient.php
Merge branch '1.0.x' into limitdist
[quix0rs-gnu-social.git] / plugins / TwitterBridge / twitteroauthclient.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Class for doing OAuth calls against Twitter
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  Integration
23  * @package   StatusNet
24  * @author    Zach Copley <zach@status.net>
25  * @copyright 2009-2010 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 /**
35  * Class for talking to the Twitter API with OAuth.
36  *
37  * @category Integration
38  * @package  StatusNet
39  * @author   Zach Copley <zach@status.net>
40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
41  * @link     http://status.net/
42  *
43  */
44 class TwitterOAuthClient extends OAuthClient
45 {
46     public static $requestTokenURL = 'https://api.twitter.com/oauth/request_token';
47     public static $authorizeURL    = 'https://api.twitter.com/oauth/authorize';
48     public static $signinUrl       = 'https://api.twitter.com/oauth/authenticate';
49     public static $accessTokenURL  = 'https://api.twitter.com/oauth/access_token';
50
51     /**
52      * Constructor
53      *
54      * @param string $oauth_token        the user's token
55      * @param string $oauth_token_secret the user's token secret
56      *
57      * @return nothing
58      */
59     function __construct($oauth_token = null, $oauth_token_secret = null)
60     {
61         $consumer_key    = common_config('twitter', 'consumer_key');
62         $consumer_secret = common_config('twitter', 'consumer_secret');
63
64         if (empty($consumer_key) && empty($consumer_secret)) {
65             $consumer_key = common_config(
66                 'twitter',
67                 'global_consumer_key'
68             );
69             $consumer_secret = common_config(
70                 'twitter',
71                 'global_consumer_secret'
72             );
73         }
74
75         parent::__construct(
76             $consumer_key,
77             $consumer_secret,
78             $oauth_token,
79             $oauth_token_secret
80         );
81     }
82
83     // XXX: the following two functions are to support the horrible hack
84     // of using the credentils field in Foreign_link to store both
85     // the access token and token secret.  This hack should go away with
86     // 0.9, in which we can make DB changes and add a new column for the
87     // token itself.
88
89     static function packToken($token)
90     {
91         return implode(chr(0), array($token->key, $token->secret));
92     }
93
94     static function unpackToken($str)
95     {
96         $vals = explode(chr(0), $str);
97         return new OAuthToken($vals[0], $vals[1]);
98     }
99
100     static function isPackedToken($str)
101     {
102         if (strpos($str, chr(0)) === false) {
103             return false;
104         } else {
105             return true;
106         }
107     }
108
109     /**
110      * Gets a request token from Twitter
111      *
112      * @return OAuthToken $token the request token
113      */
114     function getRequestToken()
115     {
116         return parent::getRequestToken(
117             self::$requestTokenURL,
118             common_local_url('twitterauthorization')
119         );
120     }
121
122     /**
123      * Builds a link to Twitter's endpoint for authorizing a request token
124      *
125      * @param OAuthToken $request_token token to authorize
126      *
127      * @return the link
128      */
129     function getAuthorizeLink($request_token, $signin = false)
130     {
131         $url = ($signin) ? self::$signinUrl : self::$authorizeURL;
132
133         return parent::getAuthorizeLink($url,
134                                         $request_token,
135                                         common_local_url('twitterauthorization'));
136     }
137
138     /**
139      * Fetches an access token from Twitter
140      *
141      * @param string $verifier 1.0a verifier
142      *
143      * @return OAuthToken $token the access token
144      */
145     function getAccessToken($verifier = null)
146     {
147         return parent::getAccessToken(
148             self::$accessTokenURL,
149             $verifier
150         );
151     }
152
153     /**
154      * Calls Twitter's /account/verify_credentials API method
155      *
156      * @return mixed the Twitter user
157      */
158     function verifyCredentials()
159     {
160         $url          = 'https://api.twitter.com/1/account/verify_credentials.json';
161         $response     = $this->oAuthGet($url);
162         $twitter_user = json_decode($response);
163         return $twitter_user;
164     }
165
166     /**
167      * Calls Twitter's /statuses/update API method
168      *
169      * @param string $status  text of the status
170      * @param mixed  $params  optional other parameters to pass to Twitter,
171      *                        as defined. For back-compatibility, if an int
172      *                        is passed we'll consider it a reply-to ID.
173      *
174      * @return mixed the status
175      */
176     function statusesUpdate($status, $params=array())
177     {
178         $url      = 'https://api.twitter.com/1/statuses/update.json';
179         if (is_numeric($params)) {
180             $params = array('in_reply_to_status_id' => intval($params));
181         }
182         $params['status'] = $status;
183         // We don't have to pass 'source' as the oauth key is tied to an app.
184
185         $response = $this->oAuthPost($url, $params);
186         $status   = json_decode($response);
187         return $status;
188     }
189
190     /**
191      * Calls Twitter's /statuses/home_timeline API method
192      *
193      * @param int $since_id show statuses after this id
194      * @param int $max_id   show statuses before this id
195      * @param int $cnt      number of statuses to show
196      * @param int $page     page number
197      *
198      * @return mixed an array of statuses
199      */
200     function statusesHomeTimeline($since_id = null, $max_id = null,
201                                   $cnt = null, $page = null)
202     {
203         $url    = 'https://api.twitter.com/1/statuses/home_timeline.json';
204
205         $params = array('include_entities' => 'true');
206
207         if (!empty($since_id)) {
208             $params['since_id'] = $since_id;
209         }
210         if (!empty($max_id)) {
211             $params['max_id'] = $max_id;
212         }
213         if (!empty($cnt)) {
214             $params['count'] = $cnt;
215         }
216         if (!empty($page)) {
217             $params['page'] = $page;
218         }
219
220         $response = $this->oAuthGet($url, $params);
221         $statuses = json_decode($response);
222         return $statuses;
223     }
224
225     /**
226      * Calls Twitter's /statuses/friends API method
227      *
228      * @param int $id          id of the user whom you wish to see friends of
229      * @param int $user_id     numerical user id
230      * @param int $screen_name screen name
231      * @param int $page        page number
232      *
233      * @return mixed an array of twitter users and their latest status
234      */
235     function statusesFriends($id = null, $user_id = null, $screen_name = null,
236                              $page = null)
237     {
238         $url = "https://api.twitter.com/1/statuses/friends.json";
239
240         $params = array();
241
242         if (!empty($id)) {
243             $params['id'] = $id;
244         }
245
246         if (!empty($user_id)) {
247             $params['user_id'] = $user_id;
248         }
249
250         if (!empty($screen_name)) {
251             $params['screen_name'] = $screen_name;
252         }
253
254         if (!empty($page)) {
255             $params['page'] = $page;
256         }
257
258         $response = $this->oAuthGet($url, $params);
259         $friends  = json_decode($response);
260         return $friends;
261     }
262
263     /**
264      * Calls Twitter's /statuses/friends/ids API method
265      *
266      * @param int $id          id of the user whom you wish to see friends of
267      * @param int $user_id     numerical user id
268      * @param int $screen_name screen name
269      * @param int $page        page number
270      *
271      * @return mixed a list of ids, 100 per page
272      */
273     function friendsIds($id = null, $user_id = null, $screen_name = null,
274                          $page = null)
275     {
276         $url = "https://api.twitter.com/1/friends/ids.json";
277
278         $params = array();
279
280         if (!empty($id)) {
281             $params['id'] = $id;
282         }
283
284         if (!empty($user_id)) {
285             $params['user_id'] = $user_id;
286         }
287
288         if (!empty($screen_name)) {
289             $params['screen_name'] = $screen_name;
290         }
291
292         if (!empty($page)) {
293             $params['page'] = $page;
294         }
295
296         $response = $this->oAuthGet($url, $params);
297         $ids      = json_decode($response);
298         return $ids;
299     }
300
301     /**
302      * Calls Twitter's /statuses/retweet/id.json API method
303      *
304      * @param int $id id of the notice to retweet
305      *
306      * @return retweeted status
307      */
308
309     function statusesRetweet($id)
310     {
311         $url = "http://api.twitter.com/1/statuses/retweet/$id.json";
312         $response = $this->oAuthPost($url);
313         $status = json_decode($response);
314         return $status;
315     }
316
317     /**
318      * Calls Twitter's /favorites/create API method
319      *
320      * @param int $id ID of the status to favorite
321      *
322      * @return object faved status
323      */
324
325     function favoritesCreate($id)
326     {
327         $url = "http://api.twitter.com/1/favorites/create/$id.json";
328         $response = $this->oAuthPost($url);
329         $status = json_decode($response);
330         return $status;
331     }
332
333     /**
334      * Calls Twitter's /favorites/destroy API method
335      *
336      * @param int $id ID of the status to unfavorite
337      *
338      * @return object unfaved status
339      */
340
341     function favoritesDestroy($id)
342     {
343         $url = "http://api.twitter.com/1/favorites/destroy/$id.json";
344         $response = $this->oAuthPost($url);
345         $status = json_decode($response);
346         return $status;
347     }
348
349     /**
350      * Calls Twitter's /statuses/destroy API method
351      *
352      * @param int $id ID of the status to destroy
353      *
354      * @return object destroyed
355      */
356
357     function statusesDestroy($id)
358     {
359         $url = "http://api.twitter.com/1/statuses/destroy/$id.json";
360         $response = $this->oAuthPost($url);
361         $status = json_decode($response);
362         return $status;
363     }
364 }