| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  | <?php | 
					
						
							|  |  |  | /** | 
					
						
							|  |  |  |  * StatusNet, the distributed open-source microblogging tool | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  * Class for doing OAuth calls against Twitter | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  * PHP version 5 | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  * LICENCE: This program is free software: you can redistribute it and/or modify | 
					
						
							|  |  |  |  * it under the terms of the GNU Affero General Public License as published by | 
					
						
							|  |  |  |  * the Free Software Foundation, either version 3 of the License, or | 
					
						
							|  |  |  |  * (at your option) any later version. | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  * This program is distributed in the hope that it will be useful, | 
					
						
							|  |  |  |  * but WITHOUT ANY WARRANTY; without even the implied warranty of | 
					
						
							|  |  |  |  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the | 
					
						
							|  |  |  |  * GNU Affero General Public License for more details. | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  * You should have received a copy of the GNU Affero General Public License | 
					
						
							|  |  |  |  * along with this program.  If not, see <http://www.gnu.org/licenses/>. | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  * @category  Integration | 
					
						
							|  |  |  |  * @package   StatusNet | 
					
						
							|  |  |  |  * @author    Zach Copley <zach@status.net> | 
					
						
							|  |  |  |  * @copyright 2009 StatusNet, Inc. | 
					
						
							|  |  |  |  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 | 
					
						
							|  |  |  |  * @link      http://status.net/ | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | if (!defined('STATUSNET') && !defined('LACONICA')) { | 
					
						
							|  |  |  |     exit(1); | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2009-12-14 07:33:29 +00:00
										 |  |  | /** | 
					
						
							|  |  |  |  * General Exception wrapper for HTTP basic auth errors | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  *  @category Integration | 
					
						
							|  |  |  |  *  @package  StatusNet | 
					
						
							|  |  |  |  *  @author   Zach Copley <zach@status.net> | 
					
						
							|  |  |  |  *  @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 | 
					
						
							|  |  |  |  *  @link     http://status.net/ | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | class BasicAuthException extends Exception | 
					
						
							|  |  |  | { | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  | /** | 
					
						
							|  |  |  |  * Class for talking to the Twitter API with HTTP Basic Auth. | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  * @category Integration | 
					
						
							|  |  |  |  * @package  StatusNet | 
					
						
							|  |  |  |  * @author   Zach Copley <zach@status.net> | 
					
						
							|  |  |  |  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 | 
					
						
							|  |  |  |  * @link     http://status.net/ | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | class TwitterBasicAuthClient | 
					
						
							|  |  |  | { | 
					
						
							|  |  |  |     var $screen_name = null; | 
					
						
							|  |  |  |     var $password    = null; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							|  |  |  |      * constructor | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @param Foreign_link $flink a Foreign_link storing the | 
					
						
							|  |  |  |      *                            Twitter user's password, etc. | 
					
						
							|  |  |  |      */ | 
					
						
							|  |  |  |     function __construct($flink) | 
					
						
							|  |  |  |     { | 
					
						
							|  |  |  |         $fuser             = $flink->getForeignUser(); | 
					
						
							|  |  |  |         $this->screen_name = $fuser->nickname; | 
					
						
							|  |  |  |         $this->password    = $flink->credentials; | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							| 
									
										
										
										
											2009-08-28 06:13:47 -07:00
										 |  |  |      * Calls Twitter's /statuses/update API method | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  |      * | 
					
						
							|  |  |  |      * @param string $status                text of the status | 
					
						
							|  |  |  |      * @param int    $in_reply_to_status_id optional id of the status it's | 
					
						
							|  |  |  |      *                                      a reply to | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @return mixed the status | 
					
						
							|  |  |  |      */ | 
					
						
							|  |  |  |     function statusesUpdate($status, $in_reply_to_status_id = null) | 
					
						
							|  |  |  |     { | 
					
						
							|  |  |  |         $url      = 'https://twitter.com/statuses/update.json'; | 
					
						
							|  |  |  |         $params   = array('status' => $status, | 
					
						
							|  |  |  |                           'source' => common_config('integration', 'source'), | 
					
						
							|  |  |  |                           'in_reply_to_status_id' => $in_reply_to_status_id); | 
					
						
							| 
									
										
										
										
											2009-08-28 07:02:27 +00:00
										 |  |  |         $response = $this->httpRequest($url, $params); | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  |         $status   = json_decode($response); | 
					
						
							|  |  |  |         return $status; | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							| 
									
										
										
										
											2009-08-28 06:13:47 -07:00
										 |  |  |      * Calls Twitter's /statuses/friends_timeline API method | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  |      * | 
					
						
							|  |  |  |      * @param int $since_id show statuses after this id | 
					
						
							|  |  |  |      * @param int $max_id   show statuses before this id | 
					
						
							|  |  |  |      * @param int $cnt      number of statuses to show | 
					
						
							|  |  |  |      * @param int $page     page number | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @return mixed an array of statuses | 
					
						
							|  |  |  |      */ | 
					
						
							|  |  |  |     function statusesFriendsTimeline($since_id = null, $max_id = null, | 
					
						
							|  |  |  |                                      $cnt = null, $page = null) | 
					
						
							|  |  |  |     { | 
					
						
							|  |  |  |         $url    = 'https://twitter.com/statuses/friends_timeline.json'; | 
					
						
							|  |  |  |         $params = array('since_id' => $since_id, | 
					
						
							|  |  |  |                         'max_id' => $max_id, | 
					
						
							|  |  |  |                         'count' => $cnt, | 
					
						
							|  |  |  |                         'page' => $page); | 
					
						
							|  |  |  |         $qry    = http_build_query($params); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         if (!empty($qry)) { | 
					
						
							|  |  |  |             $url .= "?$qry"; | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2009-08-28 07:02:27 +00:00
										 |  |  |         $response = $this->httpRequest($url); | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  |         $statuses = json_decode($response); | 
					
						
							|  |  |  |         return $statuses; | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							| 
									
										
										
										
											2009-08-28 06:13:47 -07:00
										 |  |  |      * Calls Twitter's /statuses/friends API method | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  |      * | 
					
						
							|  |  |  |      * @param int $id          id of the user whom you wish to see friends of | 
					
						
							|  |  |  |      * @param int $user_id     numerical user id | 
					
						
							|  |  |  |      * @param int $screen_name screen name | 
					
						
							|  |  |  |      * @param int $page        page number | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @return mixed an array of twitter users and their latest status | 
					
						
							|  |  |  |      */ | 
					
						
							|  |  |  |     function statusesFriends($id = null, $user_id = null, $screen_name = null, | 
					
						
							|  |  |  |                              $page = null) | 
					
						
							|  |  |  |     { | 
					
						
							|  |  |  |         $url = "https://twitter.com/statuses/friends.json"; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         $params = array('id' => $id, | 
					
						
							|  |  |  |                         'user_id' => $user_id, | 
					
						
							|  |  |  |                         'screen_name' => $screen_name, | 
					
						
							|  |  |  |                         'page' => $page); | 
					
						
							|  |  |  |         $qry    = http_build_query($params); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         if (!empty($qry)) { | 
					
						
							|  |  |  |             $url .= "?$qry"; | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         $response = $this->httpRequest($url); | 
					
						
							|  |  |  |         $friends  = json_decode($response); | 
					
						
							|  |  |  |         return $friends; | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							| 
									
										
										
										
											2009-08-28 06:13:47 -07:00
										 |  |  |      * Calls Twitter's /statuses/friends/ids API method | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  |      * | 
					
						
							|  |  |  |      * @param int $id          id of the user whom you wish to see friends of | 
					
						
							|  |  |  |      * @param int $user_id     numerical user id | 
					
						
							|  |  |  |      * @param int $screen_name screen name | 
					
						
							|  |  |  |      * @param int $page        page number | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @return mixed a list of ids, 100 per page | 
					
						
							|  |  |  |      */ | 
					
						
							|  |  |  |     function friendsIds($id = null, $user_id = null, $screen_name = null, | 
					
						
							| 
									
										
										
										
											2009-08-28 06:13:47 -07:00
										 |  |  |                         $page = null) | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  |     { | 
					
						
							|  |  |  |         $url = "https://twitter.com/friends/ids.json"; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         $params = array('id' => $id, | 
					
						
							|  |  |  |                         'user_id' => $user_id, | 
					
						
							|  |  |  |                         'screen_name' => $screen_name, | 
					
						
							|  |  |  |                         'page' => $page); | 
					
						
							|  |  |  |         $qry    = http_build_query($params); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         if (!empty($qry)) { | 
					
						
							|  |  |  |             $url .= "?$qry"; | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         $response = $this->httpRequest($url); | 
					
						
							|  |  |  |         $ids      = json_decode($response); | 
					
						
							|  |  |  |         return $ids; | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							| 
									
										
										
										
											2009-12-14 07:33:29 +00:00
										 |  |  |      * Make an HTTP request | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  |      * | 
					
						
							|  |  |  |      * @param string $url    Where to make the request | 
					
						
							|  |  |  |      * @param array  $params post parameters | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @return mixed the request | 
					
						
							| 
									
										
										
										
											2009-12-14 07:33:29 +00:00
										 |  |  |      * @throws BasicAuthException | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  |      */ | 
					
						
							| 
									
										
										
										
											2009-08-28 07:02:27 +00:00
										 |  |  |     function httpRequest($url, $params = null, $auth = true) | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  |     { | 
					
						
							| 
									
										
										
										
											2009-10-28 15:29:20 -04:00
										 |  |  |         $request = HTTPClient::start(); | 
					
						
							|  |  |  |         $request->setConfig(array( | 
					
						
							|  |  |  |             'follow_redirects' => true, | 
					
						
							|  |  |  |             'connect_timeout' => 120, | 
					
						
							|  |  |  |             'timeout' => 120, | 
					
						
							| 
									
										
										
										
											2009-11-24 19:11:34 +00:00
										 |  |  |             'ssl_verify_peer' => false, | 
					
						
							|  |  |  |             'ssl_verify_host' => false | 
					
						
							| 
									
										
										
										
											2009-10-28 15:29:20 -04:00
										 |  |  |         )); | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  |         if ($auth) { | 
					
						
							| 
									
										
										
										
											2009-10-28 15:29:20 -04:00
										 |  |  |             $request->setAuth($this->screen_name, $this->password); | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2009-10-28 15:29:20 -04:00
										 |  |  |         if (isset($params)) { | 
					
						
							|  |  |  |             // Twitter is strict about accepting invalid "Expect" headers
 | 
					
						
							|  |  |  |             $headers = array('Expect:'); | 
					
						
							|  |  |  |             $response = $request->post($url, $headers, $params); | 
					
						
							|  |  |  |         } else { | 
					
						
							|  |  |  |             $response = $request->get($url); | 
					
						
							| 
									
										
										
										
											2009-11-02 06:56:31 -08:00
										 |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2009-12-14 07:33:29 +00:00
										 |  |  |         $code = $response->getStatus(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         if ($code < 200 || $code >= 400) { | 
					
						
							|  |  |  |             throw new BasicAuthException($response->getBody(), $code); | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2009-10-28 15:29:20 -04:00
										 |  |  |         return $response->getBody(); | 
					
						
							| 
									
										
										
										
											2009-08-28 06:00:30 +00:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | } |