Version Description
Download this release
Release Info
Developer | Planet Interactive |
Plugin | Simple Twitter Tweets |
Version | 1.0 |
Comparing to | |
See all releases |
Version 1.0
- trunk/README.txt +124 -0
- trunk/simple-twitter-tweets.php +259 -0
- trunk/twitteroauth/OAuth.php +874 -0
- trunk/twitteroauth/twitteroauth.php +241 -0
trunk/README.txt
ADDED
@@ -0,0 +1,124 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
=== Plugin Name ===
|
2 |
+
Contributors: Planet Interactive
|
3 |
+
Donate: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A9437VN7R36VN
|
4 |
+
Tags: Twitter, Stream, Tweets, Twitter OAuth
|
5 |
+
Requires at least: 3.0 or Higher
|
6 |
+
Tested up to: 3.5.1
|
7 |
+
Stable tag: 1.0
|
8 |
+
License: GPLv2 or later
|
9 |
+
License URI: http://www.gnu.org/licenses/gpl-2.0.html
|
10 |
+
|
11 |
+
Simple Twitter Tweets - Display your Tweets on your Wordpress site using the new Twitter OAuth API v1.1. Because it works!
|
12 |
+
|
13 |
+
== Description ==
|
14 |
+
|
15 |
+
A Simple Twitter Tweets display widget, using Twitter OAth and API v1.1
|
16 |
+
|
17 |
+
**Why?**
|
18 |
+
|
19 |
+
Our clients, especially on shared hosting were having issues with the Twitter API not displaying their tweets, too many connections from the same source (host). We solved that issue, then lo and behold Twitter changed their API so displaying your own Tweets required OAuth authentication and finally we buckled and decided to roll our own so it would be simple for them, for us and for you.
|
20 |
+
|
21 |
+
Twitter changed their API again. Removing version 1.0 of the API altogether and by forcing version 1.1 of the API and use of the OAuth authentication requirement. We wrote this plugin so everyone could have it at a click of a button.
|
22 |
+
|
23 |
+
There are a few Twitter plugins out their, but we couldn't find one simple enough, or that worked (to be honest) and so the Simple Twitter Tweets plugin was born.
|
24 |
+
|
25 |
+
Twitter users who want to display their Tweets on their website (or within an application) have to create a Twitter Application to get access to the required "Keys" and "Tokens" Twitter provides for Authentication. The instructions for this are provided below so you can be up and running with Tweets on your site in less time than it takes to make a cup of Tea.
|
26 |
+
|
27 |
+
= Features =
|
28 |
+
|
29 |
+
* Simple setup
|
30 |
+
* Twitter API v1.1 compliant (OAuth Ready)
|
31 |
+
* No passwords required or used
|
32 |
+
* Works even when Twitters down, over capacity or not connecting
|
33 |
+
* Tweets stored in the database with each call, so if your call to the Twitter API fails for whatever reason there won't be a blank space or Oops message on your site, you'll just see the last set of Tweets the system stored - sweet huh.
|
34 |
+
* Tweeted when? - In Human Time using minutes, hours and days (i.e. 5 hours ago)
|
35 |
+
* Did we say it was simple and works...
|
36 |
+
|
37 |
+
== Installation ==
|
38 |
+
|
39 |
+
Installation is as simple as 1,2,3 or maybe 4 because of Twitter :)
|
40 |
+
|
41 |
+
1. Upload `simple-twitter-tweets` to the `/wp-content/plugins/` directory
|
42 |
+
2. Activate the plugin through the 'Plugins' menu in WordPress
|
43 |
+
3. Add the Widget to your page (e.g. Sidebar) and update the required details
|
44 |
+
4. Note: You will need to create a Twitter Application - See below. Oh, it's really easy.
|
45 |
+
|
46 |
+
= Creating a Twitter Application =
|
47 |
+
|
48 |
+
The Twitter Widget will never ask for your password, as it gets all your required data from the Open Authentication keys and secrets you will get by creating your application at Twitter. It also means that if you change your password, you won’t need to update any of the details of your Widget.
|
49 |
+
|
50 |
+
To find these details, go to https://dev.twitter.com/ and sign in.
|
51 |
+
|
52 |
+
Once you have logged in successfully, hover over your name in the top right corner, and click "My Applications," then "Create a New Application."
|
53 |
+
|
54 |
+
Enter a unique name (anything you want), a description (again this is just for you), and your site's URL. You can leave the Callback URL empty as it is not used for this implementation.
|
55 |
+
|
56 |
+
Yay, success - OK! You will be taken to a new screen, there's one more step then you can copy all the details into correct fields of the Widget and be on your way.
|
57 |
+
|
58 |
+
OK, click the "Create my Access Token" button. This is a shortcut to authenticate your own account with your application (so you never need use your password).
|
59 |
+
|
60 |
+
Good. Now click the Details Tab as all the information you need is presented hereso you can just copy the required information into the exact corresponding inputs fields of the Widget.
|
61 |
+
|
62 |
+
Full details and screenshots of this process can seen on the [Simple Twitter Tweets page](http://www.planet-interactive.co.uk/simple-twitter-tweets "Simple Twitter Tweets page by Planet Interactive")
|
63 |
+
|
64 |
+
= The Widget Options =
|
65 |
+
|
66 |
+
Fill in your details, copy and past the Twitter Application details (as described below).
|
67 |
+
|
68 |
+
* You can select the Title of the Widget as you like.
|
69 |
+
* Enter your Twitter username (without the @) just the name.
|
70 |
+
* How many Tweets to display
|
71 |
+
* The time in minutes between updates (per the API requirement) this should be 5 but if the API changes you can alter it here.
|
72 |
+
* Consumer Key: Under the *OAuth settings* heading
|
73 |
+
* Consumer Secret: Under the *OAuth settings* heading
|
74 |
+
* Access Token: Under the *Your access token* heading
|
75 |
+
* Access Token Secret: Under the *Your access token* heading
|
76 |
+
* Choose if you want the @replies included or not
|
77 |
+
* Click Save
|
78 |
+
|
79 |
+
Enjoy!
|
80 |
+
|
81 |
+
== Frequently Asked Questions ==
|
82 |
+
|
83 |
+
= Can I change the look and feel of the Tweets =
|
84 |
+
|
85 |
+
Of course you can. It's really simple too.
|
86 |
+
|
87 |
+
The Tweets are in a widget as with all widgets, and are a simple unordered list.
|
88 |
+
|
89 |
+
* To make styling easier the <ul> has a class of Tweets - <ul class="tweets">
|
90 |
+
* Each Tweet is a list item <li>
|
91 |
+
* Each Time reference is an emphasised link <em><a>
|
92 |
+
* Done.
|
93 |
+
|
94 |
+
= Where can I get help =
|
95 |
+
|
96 |
+
If you're really stuck check out the [support portal](http://planetinteractive.freshdesk.com/support/login "Support by Planet Interactive")
|
97 |
+
|
98 |
+
= More FAQs =
|
99 |
+
As far as we know it just works! Phew, but if you have an issue or you want to propose some functionality then submit you ideas at the [support portal](http://planetinteractive.freshdesk.com/support/login "Support by Planet Interactive") and we'll update these FAQs and get onto it when we can.
|
100 |
+
|
101 |
+
== Screenshots ==
|
102 |
+
|
103 |
+
Setup your Twitter Application
|
104 |
+
1. Go to https://dev.twitter.com and Sign In
|
105 |
+
2. Top right, hover your name/icon, go to My Application
|
106 |
+
3. Create a new Application
|
107 |
+
4. Fill a name for your App, a description (this is for you) and your website address (URL)
|
108 |
+
5. Click "Create my access token"
|
109 |
+
6. If you've already installed in the "Simple Twitter Tweets" plugin go to Appearance->Widgets (otherwise install it first then go here)
|
110 |
+
7. Drag the "Simple Twitter Tweets" widget your widget area of choice
|
111 |
+
8. Fill in the widget options and correlating Twitter Application OAuth requirements, just copy and paste
|
112 |
+
9. Style how you like, "Your Tweets your way"
|
113 |
+
|
114 |
+
See here [Simple Twitter Tweets](http://www.planet-interactive.co.uk/simple-twitter-tweets "Simple Twitter Tweets by Planet Interactive")
|
115 |
+
|
116 |
+
== Changelog ==
|
117 |
+
|
118 |
+
= 1.0 =
|
119 |
+
* Initial release
|
120 |
+
|
121 |
+
== Upgrade Notice ==
|
122 |
+
|
123 |
+
= 1.0 =
|
124 |
+
This is the initial release using the new Twitter OAuth requirement to pull Tweets
|
trunk/simple-twitter-tweets.php
ADDED
@@ -0,0 +1,259 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
<?php
|
2 |
+
/*
|
3 |
+
Plugin Name: Simple Twitter Tweets
|
4 |
+
Plugin URI: http://www.planet-interactive.co.uk/simple-twitter-tweets
|
5 |
+
Description: Display last x number tweets from Twitter API stream, store locally in dataabse to present past tweets when failure to access Twitters restrictive API occurs
|
6 |
+
Author: Ashley Sheinwald
|
7 |
+
Version: 1.0
|
8 |
+
Author URI: http://www.planet-interactive.co.uk/
|
9 |
+
*/
|
10 |
+
|
11 |
+
/* Copyright 2013 Ashley Sheinwald (email : ashley@planet-interactive.co.uk)
|
12 |
+
|
13 |
+
This program is free software; you can redistribute it and/or modify
|
14 |
+
it under the terms of the GNU General Public License, version 2, as
|
15 |
+
published by the Free Software Foundation.
|
16 |
+
|
17 |
+
This program is distributed in the hope that it will be useful,
|
18 |
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
19 |
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
20 |
+
GNU General Public License for more details.
|
21 |
+
|
22 |
+
You should have received a copy of the GNU General Public License
|
23 |
+
along with this program; if not, write to the Free Software
|
24 |
+
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
25 |
+
*/
|
26 |
+
|
27 |
+
// USED FOR DEBUG
|
28 |
+
// include 'console.php';
|
29 |
+
|
30 |
+
class PI_SimpleTwitterTweets extends WP_Widget{
|
31 |
+
|
32 |
+
function PI_SimpleTwitterTweets() {
|
33 |
+
$widget_ops = array('classname' => 'PI_SimpleTwitterTweets', 'description' => 'Displays the most recent tweets from your Twitter Stream' );
|
34 |
+
//$control_ops = array( 'width' => 300, 'height' => 350, 'id_base' => 'Not-required-this-time' );
|
35 |
+
$this->WP_Widget('PI_SimpleTwitterTweets', 'Simple Twitter Tweets', $widget_ops);
|
36 |
+
}
|
37 |
+
|
38 |
+
function form($instance){
|
39 |
+
|
40 |
+
//Set up some default widget settings.
|
41 |
+
$defaults = array(
|
42 |
+
'title' => __('Recent Tweets', 'pi-tweet')
|
43 |
+
, 'name' => __('iPlanetUK', 'pi-tweet')
|
44 |
+
, 'numTweets' => __(4, 'pi-tweet') // How many to display
|
45 |
+
, 'cacheTime' => __(5, 'pi-tweet') // Time in minutes between updates
|
46 |
+
, 'consumerKey' => __('xxxxxxxxxxxx', 'pi-tweet') // Consumer key
|
47 |
+
, 'consumerSecret' => __('xxxxxxxxxxxx', 'pi-tweet') // Consumer secret
|
48 |
+
, 'accessToken' => __('xxxxxxxxxxxx', 'pi-tweet') // Access token
|
49 |
+
, 'accessTokenSecret' => __('xxxxxxxxxxxx', 'pi-tweet') // Access token secret
|
50 |
+
, 'exclude_replies' => true
|
51 |
+
);
|
52 |
+
$instance = wp_parse_args( (array) $instance, $defaults );
|
53 |
+
$title = $instance['title'];
|
54 |
+
$name = $instance['name'];
|
55 |
+
$numTweets = $instance['numTweets'];
|
56 |
+
$cacheTime = $instance['cacheTime'];
|
57 |
+
$consumerKey = $instance['consumerKey'];
|
58 |
+
$consumerSecret = $instance['consumerSecret'];
|
59 |
+
$accessToken = $instance['accessToken'];
|
60 |
+
$accessTokenSecret = $instance['accessTokenSecret'];
|
61 |
+
$exclude_replies = $instance['exclude_replies'];
|
62 |
+
?>
|
63 |
+
<p>
|
64 |
+
<label for="<?php echo $this->get_field_id('title'); ?>">Title: <input class="widefat" id="<?php echo $this->get_field_id('title'); ?>" name="<?php echo $this->get_field_name('title'); ?>" type="text" value="<?php echo attribute_escape($title); ?>" /></label>
|
65 |
+
</p>
|
66 |
+
<p>
|
67 |
+
<label for="<?php echo $this->get_field_id('name'); ?>">Twitter Name: <input class="widefat" id="<?php echo $this->get_field_id('name'); ?>" name="<?php echo $this->get_field_name('name'); ?>" type="text" value="<?php echo attribute_escape($name); ?>" /></label>
|
68 |
+
</p>
|
69 |
+
<p>
|
70 |
+
<label for="<?php echo $this->get_field_id('numTweets'); ?>">Number of Tweets: <input class="widefat" id="<?php echo $this->get_field_id('numTweets'); ?>" name="<?php echo $this->get_field_name('numTweets'); ?>" type="text" value="<?php echo attribute_escape($numTweets); ?>" /></label>
|
71 |
+
</p>
|
72 |
+
<p>
|
73 |
+
<label for="<?php echo $this->get_field_id('cacheTime'); ?>">Time in Minutes between updates: <input class="widefat" id="<?php echo $this->get_field_id('cacheTime'); ?>" name="<?php echo $this->get_field_name('cacheTime'); ?>" type="text" value="<?php echo attribute_escape($cacheTime); ?>" /></label>
|
74 |
+
</p>
|
75 |
+
<p>
|
76 |
+
<label for="<?php echo $this->get_field_id('consumerKey'); ?>">Consumer Key: <input class="widefat" id="<?php echo $this->get_field_id('consumerKey'); ?>" name="<?php echo $this->get_field_name('consumerKey'); ?>" type="text" value="<?php echo attribute_escape($consumerKey); ?>" /></label>
|
77 |
+
</p>
|
78 |
+
<p>
|
79 |
+
<label for="<?php echo $this->get_field_id('consumerSecret'); ?>">Consumer Secret: <input class="widefat" id="<?php echo $this->get_field_id('consumerSecret'); ?>" name="<?php echo $this->get_field_name('consumerSecret'); ?>" type="text" value="<?php echo attribute_escape($consumerSecret); ?>" /></label>
|
80 |
+
</p>
|
81 |
+
<p>
|
82 |
+
<label for="<?php echo $this->get_field_id('accessToken'); ?>">Access Token: <input class="widefat" id="<?php echo $this->get_field_id('accessToken'); ?>" name="<?php echo $this->get_field_name('accessToken'); ?>" type="text" value="<?php echo attribute_escape($accessToken); ?>" /></label>
|
83 |
+
</p>
|
84 |
+
<p>
|
85 |
+
<label for="<?php echo $this->get_field_id('accessTokenSecret'); ?>">Access Token Secret: <input class="widefat" id="<?php echo $this->get_field_id('accessTokenSecret'); ?>" name="<?php echo $this->get_field_name('accessTokenSecret'); ?>" type="text" value="<?php echo attribute_escape($accessTokenSecret); ?>" /></label>
|
86 |
+
</p>
|
87 |
+
<p>
|
88 |
+
<input class="checkbox" type="checkbox" <?php checked( isset( $instance['exclude_replies']), true ); ?> id="<?php echo $this->get_field_id( 'exclude_replies' ); ?>" name="<?php echo $this->get_field_name( 'exclude_replies' ); ?>" />
|
89 |
+
<label for="<?php echo $this->get_field_id( 'exclude_replies' ); ?>"><?php _e('Exclude @replies', 'pi-tweet'); ?></label>
|
90 |
+
</p>
|
91 |
+
<?php
|
92 |
+
}
|
93 |
+
|
94 |
+
function update($new_instance, $old_instance){
|
95 |
+
$instance = $old_instance;
|
96 |
+
|
97 |
+
//Strip tags from title and name to remove HTML
|
98 |
+
$instance['title'] = strip_tags( $new_instance['title'] );
|
99 |
+
$instance['name'] = strip_tags( $new_instance['name'] );
|
100 |
+
$instance['numTweets'] = $new_instance['numTweets'];
|
101 |
+
$instance['cacheTime'] = $new_instance['cacheTime'];
|
102 |
+
$instance['consumerKey'] = $new_instance['consumerKey'];
|
103 |
+
$instance['consumerSecret'] = $new_instance['consumerSecret'];
|
104 |
+
$instance['accessToken'] = $new_instance['accessToken'];
|
105 |
+
$instance['accessTokenSecret'] = $new_instance['accessTokenSecret'];
|
106 |
+
$instance['exclude_replies'] = $new_instance['exclude_replies'];
|
107 |
+
|
108 |
+
return $instance;
|
109 |
+
}
|
110 |
+
|
111 |
+
function widget($args, $instance){
|
112 |
+
extract($args, EXTR_SKIP);
|
113 |
+
|
114 |
+
echo $before_widget;
|
115 |
+
|
116 |
+
//Our variables from the widget settings.
|
117 |
+
$PI_title = empty($instance['title']) ? ' ' : apply_filters('widget_title', $instance['title']);
|
118 |
+
$PI_name = $instance['name'];
|
119 |
+
$PI_numTweets = $instance['numTweets'];
|
120 |
+
$PI_cacheTime = $instance['cacheTime'];
|
121 |
+
|
122 |
+
//Setup Twitter API OAuth tokens
|
123 |
+
$PI_consumerKey = $instance['consumerKey'];
|
124 |
+
$PI_consumerSecret = $instance['consumerSecret'];
|
125 |
+
$PI_accessToken = $instance['accessToken'];
|
126 |
+
$PI_accessTokenSecret = $instance['accessTokenSecret'];
|
127 |
+
|
128 |
+
$PI_exclude_replies = isset( $instance['exclude_replies'] ) ? $instance['exclude_replies'] : false;
|
129 |
+
|
130 |
+
|
131 |
+
if (!empty($PI_title))
|
132 |
+
echo $before_title . $PI_title . $after_title;;
|
133 |
+
|
134 |
+
// START WIDGET CODE HERE
|
135 |
+
?>
|
136 |
+
|
137 |
+
<ul class="tweets">
|
138 |
+
<?php
|
139 |
+
/*
|
140 |
+
* Uses:
|
141 |
+
* Twitter API call:
|
142 |
+
* http://dev.twitter.com/doc/get/statuses/user_timeline
|
143 |
+
* WP transient API ref.
|
144 |
+
* http://www.problogdesign.com/wordpress/use-the-transients-api-to-list-the-latest-commenter/
|
145 |
+
* Plugin Development and Script enhancement
|
146 |
+
* http://www.planet-interactive.co.uk
|
147 |
+
*/
|
148 |
+
|
149 |
+
// Configuration.
|
150 |
+
$numTweets = $PI_numTweets; // Num tweets to show
|
151 |
+
$name = $PI_name; // Twitter UserName
|
152 |
+
$cacheTime = $PI_cacheTime; // Time in minutes between updates.
|
153 |
+
|
154 |
+
// Get from https://dev.twitter.com/
|
155 |
+
// Login - Create New Application, fill in details and use required data below
|
156 |
+
$consumerKey = $PI_consumerKey; // OAuth Key
|
157 |
+
$consumerSecret = $PI_consumerSecret; // OAuth Secret
|
158 |
+
$accessToken = $PI_accessToken; // OAuth Access Token
|
159 |
+
$accessTokenSecret = $PI_accessTokenSecret;// OAuth Token Secret
|
160 |
+
|
161 |
+
$exclude_replies = $PI_exclude_replies; // Leave out @replies?
|
162 |
+
|
163 |
+
$transName = 'list-tweets'; // Name of value in database.
|
164 |
+
$backupName = $transName . '-backup'; // Name of backup value in database.
|
165 |
+
|
166 |
+
// Do we already have saved tweet data? If not, lets get it.
|
167 |
+
if(false === ($tweets = get_transient($transName) ) ) :
|
168 |
+
|
169 |
+
// Get the tweets from Twitter.
|
170 |
+
include 'twitteroauth/twitteroauth.php';
|
171 |
+
|
172 |
+
$connection = new TwitterOAuth(
|
173 |
+
$consumerKey, // Consumer key
|
174 |
+
$consumerSecret, // Consumer secret
|
175 |
+
$accessToken, // Access token
|
176 |
+
$accessTokenSecret // Access token secret
|
177 |
+
);
|
178 |
+
|
179 |
+
// If excluding replies, we need to fetch more than requested as the
|
180 |
+
// total is fetched first, and then replies removed.
|
181 |
+
$totalToFetch = ($excludeReplies) ? max(50, $numTweets * 3) : $numTweets;
|
182 |
+
|
183 |
+
$fetchedTweets = $connection->get(
|
184 |
+
'statuses/user_timeline',
|
185 |
+
array(
|
186 |
+
'screen_name' => $name,
|
187 |
+
'count' => $totalToFetch,
|
188 |
+
'exclude_replies' => $excludeReplies
|
189 |
+
)
|
190 |
+
);
|
191 |
+
|
192 |
+
// Did the fetch fail?
|
193 |
+
if($connection->http_code != 200) :
|
194 |
+
$tweets = get_option($backupName); // False if there has never been data saved.
|
195 |
+
|
196 |
+
else :
|
197 |
+
// Fetch succeeded.
|
198 |
+
// Now update the array to store just what we need.
|
199 |
+
// (Done here instead of PHP doing this for every page load)
|
200 |
+
$limitToDisplay = min($numTweets, count($fetchedTweets));
|
201 |
+
|
202 |
+
for($i = 0; $i < $limitToDisplay; $i++) :
|
203 |
+
$tweet = $fetchedTweets[$i];
|
204 |
+
|
205 |
+
// Core info.
|
206 |
+
$name = $tweet->user->name;
|
207 |
+
$permalink = 'http://twitter.com/'. $name .'/status/'. $tweet->id_str;
|
208 |
+
|
209 |
+
/* Alternative image sizes method: http://dev.twitter.com/doc/get/users/profile_image/:screen_name */
|
210 |
+
$image = $tweet->user->profile_image_url;
|
211 |
+
|
212 |
+
// Message. Convert links to real links.
|
213 |
+
$pattern = '/http:(\S)+/';
|
214 |
+
$replace = '<a href="${0}" target="_blank" rel="nofollow">${0}</a>';
|
215 |
+
$text = preg_replace($pattern, $replace, $tweet->text);
|
216 |
+
|
217 |
+
// Need to get time in Unix format.
|
218 |
+
$time = $tweet->created_at;
|
219 |
+
$time = date_parse($time);
|
220 |
+
$uTime = mktime($time['hour'], $time['minute'], $time['second'], $time['month'], $time['day'], $time['year']);
|
221 |
+
|
222 |
+
// Now make the new array.
|
223 |
+
$tweets[] = array(
|
224 |
+
'text' => $text,
|
225 |
+
'name' => $name,
|
226 |
+
'permalink' => $permalink,
|
227 |
+
'image' => $image,
|
228 |
+
'time' => $uTime
|
229 |
+
);
|
230 |
+
endfor;
|
231 |
+
|
232 |
+
// Save our new transient, and update the backup.
|
233 |
+
set_transient($transName, $tweets, 60 * $cacheTime);
|
234 |
+
update_option($backupName, $tweets);
|
235 |
+
endif;
|
236 |
+
endif;
|
237 |
+
|
238 |
+
// Now display the tweets, if we can.
|
239 |
+
if($tweets) : ?>
|
240 |
+
<?php foreach($tweets as $t) : ?>
|
241 |
+
<li><?php echo $t['text']; ?>
|
242 |
+
<br/><em>
|
243 |
+
<a href="http://www.twitter.com/<?php echo $name; ?>" target="_blank" title="Follow <?php echo $name; ?> on Twitter [Opens new window]"><?php echo human_time_diff($t['time'], current_time('timestamp')); ?> ago</a>
|
244 |
+
</em>
|
245 |
+
</li>
|
246 |
+
<?php endforeach; ?>
|
247 |
+
|
248 |
+
<?php else : ?>
|
249 |
+
<li>Waiting for Twitter... Once Twitter is ready they will display my Tweets again.</li>
|
250 |
+
<?php endif; ?>
|
251 |
+
</ul>
|
252 |
+
<?php
|
253 |
+
// END OF WIDGET CODE HERE
|
254 |
+
echo $after_widget;
|
255 |
+
}
|
256 |
+
|
257 |
+
}
|
258 |
+
add_action( 'widgets_init', create_function('', 'return register_widget("PI_SimpleTwitterTweets");') );
|
259 |
+
?>
|
trunk/twitteroauth/OAuth.php
ADDED
@@ -0,0 +1,874 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
<?php
|
2 |
+
// vim: foldmethod=marker
|
3 |
+
|
4 |
+
/* Generic exception class
|
5 |
+
*/
|
6 |
+
if (!class_exists('OAuthException')) {
|
7 |
+
class OAuthException extends Exception {
|
8 |
+
// pass
|
9 |
+
}
|
10 |
+
}
|
11 |
+
|
12 |
+
class OAuthConsumer {
|
13 |
+
public $key;
|
14 |
+
public $secret;
|
15 |
+
|
16 |
+
function __construct($key, $secret, $callback_url=NULL) {
|
17 |
+
$this->key = $key;
|
18 |
+
$this->secret = $secret;
|
19 |
+
$this->callback_url = $callback_url;
|
20 |
+
}
|
21 |
+
|
22 |
+
function __toString() {
|
23 |
+
return "OAuthConsumer[key=$this->key,secret=$this->secret]";
|
24 |
+
}
|
25 |
+
}
|
26 |
+
|
27 |
+
class OAuthToken {
|
28 |
+
// access tokens and request tokens
|
29 |
+
public $key;
|
30 |
+
public $secret;
|
31 |
+
|
32 |
+
/**
|
33 |
+
* key = the token
|
34 |
+
* secret = the token secret
|
35 |
+
*/
|
36 |
+
function __construct($key, $secret) {
|
37 |
+
$this->key = $key;
|
38 |
+
$this->secret = $secret;
|
39 |
+
}
|
40 |
+
|
41 |
+
/**
|
42 |
+
* generates the basic string serialization of a token that a server
|
43 |
+
* would respond to request_token and access_token calls with
|
44 |
+
*/
|
45 |
+
function to_string() {
|
46 |
+
return "oauth_token=" .
|
47 |
+
OAuthUtil::urlencode_rfc3986($this->key) .
|
48 |
+
"&oauth_token_secret=" .
|
49 |
+
OAuthUtil::urlencode_rfc3986($this->secret);
|
50 |
+
}
|
51 |
+
|
52 |
+
function __toString() {
|
53 |
+
return $this->to_string();
|
54 |
+
}
|
55 |
+
}
|
56 |
+
|
57 |
+
/**
|
58 |
+
* A class for implementing a Signature Method
|
59 |
+
* See section 9 ("Signing Requests") in the spec
|
60 |
+
*/
|
61 |
+
abstract class OAuthSignatureMethod {
|
62 |
+
/**
|
63 |
+
* Needs to return the name of the Signature Method (ie HMAC-SHA1)
|
64 |
+
* @return string
|
65 |
+
*/
|
66 |
+
abstract public function get_name();
|
67 |
+
|
68 |
+
/**
|
69 |
+
* Build up the signature
|
70 |
+
* NOTE: The output of this function MUST NOT be urlencoded.
|
71 |
+
* the encoding is handled in OAuthRequest when the final
|
72 |
+
* request is serialized
|
73 |
+
* @param OAuthRequest $request
|
74 |
+
* @param OAuthConsumer $consumer
|
75 |
+
* @param OAuthToken $token
|
76 |
+
* @return string
|
77 |
+
*/
|
78 |
+
abstract public function build_signature($request, $consumer, $token);
|
79 |
+
|
80 |
+
/**
|
81 |
+
* Verifies that a given signature is correct
|
82 |
+
* @param OAuthRequest $request
|
83 |
+
* @param OAuthConsumer $consumer
|
84 |
+
* @param OAuthToken $token
|
85 |
+
* @param string $signature
|
86 |
+
* @return bool
|
87 |
+
*/
|
88 |
+
public function check_signature($request, $consumer, $token, $signature) {
|
89 |
+
$built = $this->build_signature($request, $consumer, $token);
|
90 |
+
return $built == $signature;
|
91 |
+
}
|
92 |
+
}
|
93 |
+
|
94 |
+
/**
|
95 |
+
* The HMAC-SHA1 signature method uses the HMAC-SHA1 signature algorithm as defined in [RFC2104]
|
96 |
+
* where the Signature Base String is the text and the key is the concatenated values (each first
|
97 |
+
* encoded per Parameter Encoding) of the Consumer Secret and Token Secret, separated by an '&'
|
98 |
+
* character (ASCII code 38) even if empty.
|
99 |
+
* - Chapter 9.2 ("HMAC-SHA1")
|
100 |
+
*/
|
101 |
+
class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod {
|
102 |
+
function get_name() {
|
103 |
+
return "HMAC-SHA1";
|
104 |
+
}
|
105 |
+
|
106 |
+
public function build_signature($request, $consumer, $token) {
|
107 |
+
$base_string = $request->get_signature_base_string();
|
108 |
+
$request->base_string = $base_string;
|
109 |
+
|
110 |
+
$key_parts = array(
|
111 |
+
$consumer->secret,
|
112 |
+
($token) ? $token->secret : ""
|
113 |
+
);
|
114 |
+
|
115 |
+
$key_parts = OAuthUtil::urlencode_rfc3986($key_parts);
|
116 |
+
$key = implode('&', $key_parts);
|
117 |
+
|
118 |
+
return base64_encode(hash_hmac('sha1', $base_string, $key, true));
|
119 |
+
}
|
120 |
+
}
|
121 |
+
|
122 |
+
/**
|
123 |
+
* The PLAINTEXT method does not provide any security protection and SHOULD only be used
|
124 |
+
* over a secure channel such as HTTPS. It does not use the Signature Base String.
|
125 |
+
* - Chapter 9.4 ("PLAINTEXT")
|
126 |
+
*/
|
127 |
+
class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod {
|
128 |
+
public function get_name() {
|
129 |
+
return "PLAINTEXT";
|
130 |
+
}
|
131 |
+
|
132 |
+
/**
|
133 |
+
* oauth_signature is set to the concatenated encoded values of the Consumer Secret and
|
134 |
+
* Token Secret, separated by a '&' character (ASCII code 38), even if either secret is
|
135 |
+
* empty. The result MUST be encoded again.
|
136 |
+
* - Chapter 9.4.1 ("Generating Signatures")
|
137 |
+
*
|
138 |
+
* Please note that the second encoding MUST NOT happen in the SignatureMethod, as
|
139 |
+
* OAuthRequest handles this!
|
140 |
+
*/
|
141 |
+
public function build_signature($request, $consumer, $token) {
|
142 |
+
$key_parts = array(
|
143 |
+
$consumer->secret,
|
144 |
+
($token) ? $token->secret : ""
|
145 |
+
);
|
146 |
+
|
147 |
+
$key_parts = OAuthUtil::urlencode_rfc3986($key_parts);
|
148 |
+
$key = implode('&', $key_parts);
|
149 |
+
$request->base_string = $key;
|
150 |
+
|
151 |
+
return $key;
|
152 |
+
}
|
153 |
+
}
|
154 |
+
|
155 |
+
/**
|
156 |
+
* The RSA-SHA1 signature method uses the RSASSA-PKCS1-v1_5 signature algorithm as defined in
|
157 |
+
* [RFC3447] section 8.2 (more simply known as PKCS#1), using SHA-1 as the hash function for
|
158 |
+
* EMSA-PKCS1-v1_5. It is assumed that the Consumer has provided its RSA public key in a
|
159 |
+
* verified way to the Service Provider, in a manner which is beyond the scope of this
|
160 |
+
* specification.
|
161 |
+
* - Chapter 9.3 ("RSA-SHA1")
|
162 |
+
*/
|
163 |
+
abstract class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod {
|
164 |
+
public function get_name() {
|
165 |
+
return "RSA-SHA1";
|
166 |
+
}
|
167 |
+
|
168 |
+
// Up to the SP to implement this lookup of keys. Possible ideas are:
|
169 |
+
// (1) do a lookup in a table of trusted certs keyed off of consumer
|
170 |
+
// (2) fetch via http using a url provided by the requester
|
171 |
+
// (3) some sort of specific discovery code based on request
|
172 |
+
//
|
173 |
+
// Either way should return a string representation of the certificate
|
174 |
+
protected abstract function fetch_public_cert(&$request);
|
175 |
+
|
176 |
+
// Up to the SP to implement this lookup of keys. Possible ideas are:
|
177 |
+
// (1) do a lookup in a table of trusted certs keyed off of consumer
|
178 |
+
//
|
179 |
+
// Either way should return a string representation of the certificate
|
180 |
+
protected abstract function fetch_private_cert(&$request);
|
181 |
+
|
182 |
+
public function build_signature($request, $consumer, $token) {
|
183 |
+
$base_string = $request->get_signature_base_string();
|
184 |
+
$request->base_string = $base_string;
|
185 |
+
|
186 |
+
// Fetch the private key cert based on the request
|
187 |
+
$cert = $this->fetch_private_cert($request);
|
188 |
+
|
189 |
+
// Pull the private key ID from the certificate
|
190 |
+
$privatekeyid = openssl_get_privatekey($cert);
|
191 |
+
|
192 |
+
// Sign using the key
|
193 |
+
$ok = openssl_sign($base_string, $signature, $privatekeyid);
|
194 |
+
|
195 |
+
// Release the key resource
|
196 |
+
openssl_free_key($privatekeyid);
|
197 |
+
|
198 |
+
return base64_encode($signature);
|
199 |
+
}
|
200 |
+
|
201 |
+
public function check_signature($request, $consumer, $token, $signature) {
|
202 |
+
$decoded_sig = base64_decode($signature);
|
203 |
+
|
204 |
+
$base_string = $request->get_signature_base_string();
|
205 |
+
|
206 |
+
// Fetch the public key cert based on the request
|
207 |
+
$cert = $this->fetch_public_cert($request);
|
208 |
+
|
209 |
+
// Pull the public key ID from the certificate
|
210 |
+
$publickeyid = openssl_get_publickey($cert);
|
211 |
+
|
212 |
+
// Check the computed signature against the one passed in the query
|
213 |
+
$ok = openssl_verify($base_string, $decoded_sig, $publickeyid);
|
214 |
+
|
215 |
+
// Release the key resource
|
216 |
+
openssl_free_key($publickeyid);
|
217 |
+
|
218 |
+
return $ok == 1;
|
219 |
+
}
|
220 |
+
}
|
221 |
+
|
222 |
+
class OAuthRequest {
|
223 |
+
private $parameters;
|
224 |
+
private $http_method;
|
225 |
+
private $http_url;
|
226 |
+
// for debug purposes
|
227 |
+
public $base_string;
|
228 |
+
public static $version = '1.0';
|
229 |
+
public static $POST_INPUT = 'php://input';
|
230 |
+
|
231 |
+
function __construct($http_method, $http_url, $parameters=NULL) {
|
232 |
+
@$parameters or $parameters = array();
|
233 |
+
$parameters = array_merge( OAuthUtil::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $parameters);
|
234 |
+
$this->parameters = $parameters;
|
235 |
+
$this->http_method = $http_method;
|
236 |
+
$this->http_url = $http_url;
|
237 |
+
}
|
238 |
+
|
239 |
+
|
240 |
+
/**
|
241 |
+
* attempt to build up a request from what was passed to the server
|
242 |
+
*/
|
243 |
+
public static function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) {
|
244 |
+
$scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on")
|
245 |
+
? 'http'
|
246 |
+
: 'https';
|
247 |
+
@$http_url or $http_url = $scheme .
|
248 |
+
'://' . $_SERVER['HTTP_HOST'] .
|
249 |
+
':' .
|
250 |
+
$_SERVER['SERVER_PORT'] .
|
251 |
+
$_SERVER['REQUEST_URI'];
|
252 |
+
@$http_method or $http_method = $_SERVER['REQUEST_METHOD'];
|
253 |
+
|
254 |
+
// We weren't handed any parameters, so let's find the ones relevant to
|
255 |
+
// this request.
|
256 |
+
// If you run XML-RPC or similar you should use this to provide your own
|
257 |
+
// parsed parameter-list
|
258 |
+
if (!$parameters) {
|
259 |
+
// Find request headers
|
260 |
+
$request_headers = OAuthUtil::get_headers();
|
261 |
+
|
262 |
+
// Parse the query-string to find GET parameters
|
263 |
+
$parameters = OAuthUtil::parse_parameters($_SERVER['QUERY_STRING']);
|
264 |
+
|
265 |
+
// It's a POST request of the proper content-type, so parse POST
|
266 |
+
// parameters and add those overriding any duplicates from GET
|
267 |
+
if ($http_method == "POST"
|
268 |
+
&& @strstr($request_headers["Content-Type"],
|
269 |
+
"application/x-www-form-urlencoded")
|
270 |
+
) {
|
271 |
+
$post_data = OAuthUtil::parse_parameters(
|
272 |
+
file_get_contents(self::$POST_INPUT)
|
273 |
+
);
|
274 |
+
$parameters = array_merge($parameters, $post_data);
|
275 |
+
}
|
276 |
+
|
277 |
+
// We have a Authorization-header with OAuth data. Parse the header
|
278 |
+
// and add those overriding any duplicates from GET or POST
|
279 |
+
if (@substr($request_headers['Authorization'], 0, 6) == "OAuth ") {
|
280 |
+
$header_parameters = OAuthUtil::split_header(
|
281 |
+
$request_headers['Authorization']
|
282 |
+
);
|
283 |
+
$parameters = array_merge($parameters, $header_parameters);
|
284 |
+
}
|
285 |
+
|
286 |
+
}
|
287 |
+
|
288 |
+
return new OAuthRequest($http_method, $http_url, $parameters);
|
289 |
+
}
|
290 |
+
|
291 |
+
/**
|
292 |
+
* pretty much a helper function to set up the request
|
293 |
+
*/
|
294 |
+
public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=NULL) {
|
295 |
+
@$parameters or $parameters = array();
|
296 |
+
$defaults = array("oauth_version" => OAuthRequest::$version,
|
297 |
+
"oauth_nonce" => OAuthRequest::generate_nonce(),
|
298 |
+
"oauth_timestamp" => OAuthRequest::generate_timestamp(),
|
299 |
+
"oauth_consumer_key" => $consumer->key);
|
300 |
+
if ($token)
|
301 |
+
$defaults['oauth_token'] = $token->key;
|
302 |
+
|
303 |
+
$parameters = array_merge($defaults, $parameters);
|
304 |
+
|
305 |
+
return new OAuthRequest($http_method, $http_url, $parameters);
|
306 |
+
}
|
307 |
+
|
308 |
+
public function set_parameter($name, $value, $allow_duplicates = true) {
|
309 |
+
if ($allow_duplicates && isset($this->parameters[$name])) {
|
310 |
+
// We have already added parameter(s) with this name, so add to the list
|
311 |
+
if (is_scalar($this->parameters[$name])) {
|
312 |
+
// This is the first duplicate, so transform scalar (string)
|
313 |
+
// into an array so we can add the duplicates
|
314 |
+
$this->parameters[$name] = array($this->parameters[$name]);
|
315 |
+
}
|
316 |
+
|
317 |
+
$this->parameters[$name][] = $value;
|
318 |
+
} else {
|
319 |
+
$this->parameters[$name] = $value;
|
320 |
+
}
|
321 |
+
}
|
322 |
+
|
323 |
+
public function get_parameter($name) {
|
324 |
+
return isset($this->parameters[$name]) ? $this->parameters[$name] : null;
|
325 |
+
}
|
326 |
+
|
327 |
+
public function get_parameters() {
|
328 |
+
return $this->parameters;
|
329 |
+
}
|
330 |
+
|
331 |
+
public function unset_parameter($name) {
|
332 |
+
unset($this->parameters[$name]);
|
333 |
+
}
|
334 |
+
|
335 |
+
/**
|
336 |
+
* The request parameters, sorted and concatenated into a normalized string.
|
337 |
+
* @return string
|
338 |
+
*/
|
339 |
+
public function get_signable_parameters() {
|
340 |
+
// Grab all parameters
|
341 |
+
$params = $this->parameters;
|
342 |
+
|
343 |
+
// Remove oauth_signature if present
|
344 |
+
// Ref: Spec: 9.1.1 ("The oauth_signature parameter MUST be excluded.")
|
345 |
+
if (isset($params['oauth_signature'])) {
|
346 |
+
unset($params['oauth_signature']);
|
347 |
+
}
|
348 |
+
|
349 |
+
return OAuthUtil::build_http_query($params);
|
350 |
+
}
|
351 |
+
|
352 |
+
/**
|
353 |
+
* Returns the base string of this request
|
354 |
+
*
|
355 |
+
* The base string defined as the method, the url
|
356 |
+
* and the parameters (normalized), each urlencoded
|
357 |
+
* and the concated with &.
|
358 |
+
*/
|
359 |
+
public function get_signature_base_string() {
|
360 |
+
$parts = array(
|
361 |
+
$this->get_normalized_http_method(),
|
362 |
+
$this->get_normalized_http_url(),
|
363 |
+
$this->get_signable_parameters()
|
364 |
+
);
|
365 |
+
|
366 |
+
$parts = OAuthUtil::urlencode_rfc3986($parts);
|
367 |
+
|
368 |
+
return implode('&', $parts);
|
369 |
+
}
|
370 |
+
|
371 |
+
/**
|
372 |
+
* just uppercases the http method
|
373 |
+
*/
|
374 |
+
public function get_normalized_http_method() {
|
375 |
+
return strtoupper($this->http_method);
|
376 |
+
}
|
377 |
+
|
378 |
+
/**
|
379 |
+
* parses the url and rebuilds it to be
|
380 |
+
* scheme://host/path
|
381 |
+
*/
|
382 |
+
public function get_normalized_http_url() {
|
383 |
+
$parts = parse_url($this->http_url);
|
384 |
+
|
385 |
+
$port = @$parts['port'];
|
386 |
+
$scheme = $parts['scheme'];
|
387 |
+
$host = $parts['host'];
|
388 |
+
$path = @$parts['path'];
|
389 |
+
|
390 |
+
$port or $port = ($scheme == 'https') ? '443' : '80';
|
391 |
+
|
392 |
+
if (($scheme == 'https' && $port != '443')
|
393 |
+
|| ($scheme == 'http' && $port != '80')) {
|
394 |
+
$host = "$host:$port";
|
395 |
+
}
|
396 |
+
return "$scheme://$host$path";
|
397 |
+
}
|
398 |
+
|
399 |
+
/**
|
400 |
+
* builds a url usable for a GET request
|
401 |
+
*/
|
402 |
+
public function to_url() {
|
403 |
+
$post_data = $this->to_postdata();
|
404 |
+
$out = $this->get_normalized_http_url();
|
405 |
+
if ($post_data) {
|
406 |
+
$out .= '?'.$post_data;
|
407 |
+
}
|
408 |
+
return $out;
|
409 |
+
}
|
410 |
+
|
411 |
+
/**
|
412 |
+
* builds the data one would send in a POST request
|
413 |
+
*/
|
414 |
+
public function to_postdata() {
|
415 |
+
return OAuthUtil::build_http_query($this->parameters);
|
416 |
+
}
|
417 |
+
|
418 |
+
/**
|
419 |
+
* builds the Authorization: header
|
420 |
+
*/
|
421 |
+
public function to_header($realm=null) {
|
422 |
+
$first = true;
|
423 |
+
if($realm) {
|
424 |
+
$out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"';
|
425 |
+
$first = false;
|
426 |
+
} else
|
427 |
+
$out = 'Authorization: OAuth';
|
428 |
+
|
429 |
+
$total = array();
|
430 |
+
foreach ($this->parameters as $k => $v) {
|
431 |
+
if (substr($k, 0, 5) != "oauth") continue;
|
432 |
+
if (is_array($v)) {
|
433 |
+
throw new OAuthException('Arrays not supported in headers');
|
434 |
+
}
|
435 |
+
$out .= ($first) ? ' ' : ',';
|
436 |
+
$out .= OAuthUtil::urlencode_rfc3986($k) .
|
437 |
+
'="' .
|
438 |
+
OAuthUtil::urlencode_rfc3986($v) .
|
439 |
+
'"';
|
440 |
+
$first = false;
|
441 |
+
}
|
442 |
+
return $out;
|
443 |
+
}
|
444 |
+
|
445 |
+
public function __toString() {
|
446 |
+
return $this->to_url();
|
447 |
+
}
|
448 |
+
|
449 |
+
|
450 |
+
public function sign_request($signature_method, $consumer, $token) {
|
451 |
+
$this->set_parameter(
|
452 |
+
"oauth_signature_method",
|
453 |
+
$signature_method->get_name(),
|
454 |
+
false
|
455 |
+
);
|
456 |
+
$signature = $this->build_signature($signature_method, $consumer, $token);
|
457 |
+
$this->set_parameter("oauth_signature", $signature, false);
|
458 |
+
}
|
459 |
+
|
460 |
+
public function build_signature($signature_method, $consumer, $token) {
|
461 |
+
$signature = $signature_method->build_signature($this, $consumer, $token);
|
462 |
+
return $signature;
|
463 |
+
}
|
464 |
+
|
465 |
+
/**
|
466 |
+
* util function: current timestamp
|
467 |
+
*/
|
468 |
+
private static function generate_timestamp() {
|
469 |
+
return time();
|
470 |
+
}
|
471 |
+
|
472 |
+
/**
|
473 |
+
* util function: current nonce
|
474 |
+
*/
|
475 |
+
private static function generate_nonce() {
|
476 |
+
$mt = microtime();
|
477 |
+
$rand = mt_rand();
|
478 |
+
|
479 |
+
return md5($mt . $rand); // md5s look nicer than numbers
|
480 |
+
}
|
481 |
+
}
|
482 |
+
|
483 |
+
class OAuthServer {
|
484 |
+
protected $timestamp_threshold = 300; // in seconds, five minutes
|
485 |
+
protected $version = '1.0'; // hi blaine
|
486 |
+
protected $signature_methods = array();
|
487 |
+
|
488 |
+
protected $data_store;
|
489 |
+
|
490 |
+
function __construct($data_store) {
|
491 |
+
$this->data_store = $data_store;
|
492 |
+
}
|
493 |
+
|
494 |
+
public function add_signature_method($signature_method) {
|
495 |
+
$this->signature_methods[$signature_method->get_name()] =
|
496 |
+
$signature_method;
|
497 |
+
}
|
498 |
+
|
499 |
+
// high level functions
|
500 |
+
|
501 |
+
/**
|
502 |
+
* process a request_token request
|
503 |
+
* returns the request token on success
|
504 |
+
*/
|
505 |
+
public function fetch_request_token(&$request) {
|
506 |
+
$this->get_version($request);
|
507 |
+
|
508 |
+
$consumer = $this->get_consumer($request);
|
509 |
+
|
510 |
+
// no token required for the initial token request
|
511 |
+
$token = NULL;
|
512 |
+
|
513 |
+
$this->check_signature($request, $consumer, $token);
|
514 |
+
|
515 |
+
// Rev A change
|
516 |
+
$callback = $request->get_parameter('oauth_callback');
|
517 |
+
$new_token = $this->data_store->new_request_token($consumer, $callback);
|
518 |
+
|
519 |
+
return $new_token;
|
520 |
+
}
|
521 |
+
|
522 |
+
/**
|
523 |
+
* process an access_token request
|
524 |
+
* returns the access token on success
|
525 |
+
*/
|
526 |
+
public function fetch_access_token(&$request) {
|
527 |
+
$this->get_version($request);
|
528 |
+
|
529 |
+
$consumer = $this->get_consumer($request);
|
530 |
+
|
531 |
+
// requires authorized request token
|
532 |
+
$token = $this->get_token($request, $consumer, "request");
|
533 |
+
|
534 |
+
$this->check_signature($request, $consumer, $token);
|
535 |
+
|
536 |
+
// Rev A change
|
537 |
+
$verifier = $request->get_parameter('oauth_verifier');
|
538 |
+
$new_token = $this->data_store->new_access_token($token, $consumer, $verifier);
|
539 |
+
|
540 |
+
return $new_token;
|
541 |
+
}
|
542 |
+
|
543 |
+
/**
|
544 |
+
* verify an api call, checks all the parameters
|
545 |
+
*/
|
546 |
+
public function verify_request(&$request) {
|
547 |
+
$this->get_version($request);
|
548 |
+
$consumer = $this->get_consumer($request);
|
549 |
+
$token = $this->get_token($request, $consumer, "access");
|
550 |
+
$this->check_signature($request, $consumer, $token);
|
551 |
+
return array($consumer, $token);
|
552 |
+
}
|
553 |
+
|
554 |
+
// Internals from here
|
555 |
+
/**
|
556 |
+
* version 1
|
557 |
+
*/
|
558 |
+
private function get_version(&$request) {
|
559 |
+
$version = $request->get_parameter("oauth_version");
|
560 |
+
if (!$version) {
|
561 |
+
// Service Providers MUST assume the protocol version to be 1.0 if this parameter is not present.
|
562 |
+
// Chapter 7.0 ("Accessing Protected Ressources")
|
563 |
+
$version = '1.0';
|
564 |
+
}
|
565 |
+
if ($version !== $this->version) {
|
566 |
+
throw new OAuthException("OAuth version '$version' not supported");
|
567 |
+
}
|
568 |
+
return $version;
|
569 |
+
}
|
570 |
+
|
571 |
+
/**
|
572 |
+
* figure out the signature with some defaults
|
573 |
+
*/
|
574 |
+
private function get_signature_method(&$request) {
|
575 |
+
$signature_method =
|
576 |
+
@$request->get_parameter("oauth_signature_method");
|
577 |
+
|
578 |
+
if (!$signature_method) {
|
579 |
+
// According to chapter 7 ("Accessing Protected Ressources") the signature-method
|
580 |
+
// parameter is required, and we can't just fallback to PLAINTEXT
|
581 |
+
throw new OAuthException('No signature method parameter. This parameter is required');
|
582 |
+
}
|
583 |
+
|
584 |
+
if (!in_array($signature_method,
|
585 |
+
array_keys($this->signature_methods))) {
|
586 |
+
throw new OAuthException(
|
587 |
+
"Signature method '$signature_method' not supported " .
|
588 |
+
"try one of the following: " .
|
589 |
+
implode(", ", array_keys($this->signature_methods))
|
590 |
+
);
|
591 |
+
}
|
592 |
+
return $this->signature_methods[$signature_method];
|
593 |
+
}
|
594 |
+
|
595 |
+
/**
|
596 |
+
* try to find the consumer for the provided request's consumer key
|
597 |
+
*/
|
598 |
+
private function get_consumer(&$request) {
|
599 |
+
$consumer_key = @$request->get_parameter("oauth_consumer_key");
|
600 |
+
if (!$consumer_key) {
|
601 |
+
throw new OAuthException("Invalid consumer key");
|
602 |
+
}
|
603 |
+
|
604 |
+
$consumer = $this->data_store->lookup_consumer($consumer_key);
|
605 |
+
if (!$consumer) {
|
606 |
+
throw new OAuthException("Invalid consumer");
|
607 |
+
}
|
608 |
+
|
609 |
+
return $consumer;
|
610 |
+
}
|
611 |
+
|
612 |
+
/**
|
613 |
+
* try to find the token for the provided request's token key
|
614 |
+
*/
|
615 |
+
private function get_token(&$request, $consumer, $token_type="access") {
|
616 |
+
$token_field = @$request->get_parameter('oauth_token');
|
617 |
+
$token = $this->data_store->lookup_token(
|
618 |
+
$consumer, $token_type, $token_field
|
619 |
+
);
|
620 |
+
if (!$token) {
|
621 |
+
throw new OAuthException("Invalid $token_type token: $token_field");
|
622 |
+
}
|
623 |
+
return $token;
|
624 |
+
}
|
625 |
+
|
626 |
+
/**
|
627 |
+
* all-in-one function to check the signature on a request
|
628 |
+
* should guess the signature method appropriately
|
629 |
+
*/
|
630 |
+
private function check_signature(&$request, $consumer, $token) {
|
631 |
+
// this should probably be in a different method
|
632 |
+
$timestamp = @$request->get_parameter('oauth_timestamp');
|
633 |
+
$nonce = @$request->get_parameter('oauth_nonce');
|
634 |
+
|
635 |
+
$this->check_timestamp($timestamp);
|
636 |
+
$this->check_nonce($consumer, $token, $nonce, $timestamp);
|
637 |
+
|
638 |
+
$signature_method = $this->get_signature_method($request);
|
639 |
+
|
640 |
+
$signature = $request->get_parameter('oauth_signature');
|
641 |
+
$valid_sig = $signature_method->check_signature(
|
642 |
+
$request,
|
643 |
+
$consumer,
|
644 |
+
$token,
|
645 |
+
$signature
|
646 |
+
);
|
647 |
+
|
648 |
+
if (!$valid_sig) {
|
649 |
+
throw new OAuthException("Invalid signature");
|
650 |
+
}
|
651 |
+
}
|
652 |
+
|
653 |
+
/**
|
654 |
+
* check that the timestamp is new enough
|
655 |
+
*/
|
656 |
+
private function check_timestamp($timestamp) {
|
657 |
+
if( ! $timestamp )
|
658 |
+
throw new OAuthException(
|
659 |
+
'Missing timestamp parameter. The parameter is required'
|
660 |
+
);
|
661 |
+
|
662 |
+
// verify that timestamp is recentish
|
663 |
+
$now = time();
|
664 |
+
if (abs($now - $timestamp) > $this->timestamp_threshold) {
|
665 |
+
throw new OAuthException(
|
666 |
+
"Expired timestamp, yours $timestamp, ours $now"
|
667 |
+
);
|
668 |
+
}
|
669 |
+
}
|
670 |
+
|
671 |
+
/**
|
672 |
+
* check that the nonce is not repeated
|
673 |
+
*/
|
674 |
+
private function check_nonce($consumer, $token, $nonce, $timestamp) {
|
675 |
+
if( ! $nonce )
|
676 |
+
throw new OAuthException(
|
677 |
+
'Missing nonce parameter. The parameter is required'
|
678 |
+
);
|
679 |
+
|
680 |
+
// verify that the nonce is uniqueish
|
681 |
+
$found = $this->data_store->lookup_nonce(
|
682 |
+
$consumer,
|
683 |
+
$token,
|
684 |
+
$nonce,
|
685 |
+
$timestamp
|
686 |
+
);
|
687 |
+
if ($found) {
|
688 |
+
throw new OAuthException("Nonce already used: $nonce");
|
689 |
+
}
|
690 |
+
}
|
691 |
+
|
692 |
+
}
|
693 |
+
|
694 |
+
class OAuthDataStore {
|
695 |
+
function lookup_consumer($consumer_key) {
|
696 |
+
// implement me
|
697 |
+
}
|
698 |
+
|
699 |
+
function lookup_token($consumer, $token_type, $token) {
|
700 |
+
// implement me
|
701 |
+
}
|
702 |
+
|
703 |
+
function lookup_nonce($consumer, $token, $nonce, $timestamp) {
|
704 |
+
// implement me
|
705 |
+
}
|
706 |
+
|
707 |
+
function new_request_token($consumer, $callback = null) {
|
708 |
+
// return a new token attached to this consumer
|
709 |
+
}
|
710 |
+
|
711 |
+
function new_access_token($token, $consumer, $verifier = null) {
|
712 |
+
// return a new access token attached to this consumer
|
713 |
+
// for the user associated with this token if the request token
|
714 |
+
// is authorized
|
715 |
+
// should also invalidate the request token
|
716 |
+
}
|
717 |
+
|
718 |
+
}
|
719 |
+
|
720 |
+
class OAuthUtil {
|
721 |
+
public static function urlencode_rfc3986($input) {
|
722 |
+
if (is_array($input)) {
|
723 |
+
return array_map(array('OAuthUtil', 'urlencode_rfc3986'), $input);
|
724 |
+
} else if (is_scalar($input)) {
|
725 |
+
return str_replace(
|
726 |
+
'+',
|
727 |
+
' ',
|
728 |
+
str_replace('%7E', '~', rawurlencode($input))
|
729 |
+
);
|
730 |
+
} else {
|
731 |
+
return '';
|
732 |
+
}
|
733 |
+
}
|
734 |
+
|
735 |
+
|
736 |
+
// This decode function isn't taking into consideration the above
|
737 |
+
// modifications to the encoding process. However, this method doesn't
|
738 |
+
// seem to be used anywhere so leaving it as is.
|
739 |
+
public static function urldecode_rfc3986($string) {
|
740 |
+
return urldecode($string);
|
741 |
+
}
|
742 |
+
|
743 |
+
// Utility function for turning the Authorization: header into
|
744 |
+
// parameters, has to do some unescaping
|
745 |
+
// Can filter out any non-oauth parameters if needed (default behaviour)
|
746 |
+
public static function split_header($header, $only_allow_oauth_parameters = true) {
|
747 |
+
$pattern = '/(([-_a-z]*)=("([^"]*)"|([^,]*)),?)/';
|
748 |
+
$offset = 0;
|
749 |
+
$params = array();
|
750 |
+
while (preg_match($pattern, $header, $matches, PREG_OFFSET_CAPTURE, $offset) > 0) {
|
751 |
+
$match = $matches[0];
|
752 |
+
$header_name = $matches[2][0];
|
753 |
+
$header_content = (isset($matches[5])) ? $matches[5][0] : $matches[4][0];
|
754 |
+
if (preg_match('/^oauth_/', $header_name) || !$only_allow_oauth_parameters) {
|
755 |
+
$params[$header_name] = OAuthUtil::urldecode_rfc3986($header_content);
|
756 |
+
}
|
757 |
+
$offset = $match[1] + strlen($match[0]);
|
758 |
+
}
|
759 |
+
|
760 |
+
if (isset($params['realm'])) {
|
761 |
+
unset($params['realm']);
|
762 |
+
}
|
763 |
+
|
764 |
+
return $params;
|
765 |
+
}
|
766 |
+
|
767 |
+
// helper to try to sort out headers for people who aren't running apache
|
768 |
+
public static function get_headers() {
|
769 |
+
if (function_exists('apache_request_headers')) {
|
770 |
+
// we need this to get the actual Authorization: header
|
771 |
+
// because apache tends to tell us it doesn't exist
|
772 |
+
$headers = apache_request_headers();
|
773 |
+
|
774 |
+
// sanitize the output of apache_request_headers because
|
775 |
+
// we always want the keys to be Cased-Like-This and arh()
|
776 |
+
// returns the headers in the same case as they are in the
|
777 |
+
// request
|
778 |
+
$out = array();
|
779 |
+
foreach( $headers AS $key => $value ) {
|
780 |
+
$key = str_replace(
|
781 |
+
" ",
|
782 |
+
"-",
|
783 |
+
ucwords(strtolower(str_replace("-", " ", $key)))
|
784 |
+
);
|
785 |
+
$out[$key] = $value;
|
786 |
+
}
|
787 |
+
} else {
|
788 |
+
// otherwise we don't have apache and are just going to have to hope
|
789 |
+
// that $_SERVER actually contains what we need
|
790 |
+
$out = array();
|
791 |
+
if( isset($_SERVER['CONTENT_TYPE']) )
|
792 |
+
$out['Content-Type'] = $_SERVER['CONTENT_TYPE'];
|
793 |
+
if( isset($_ENV['CONTENT_TYPE']) )
|
794 |
+
$out['Content-Type'] = $_ENV['CONTENT_TYPE'];
|
795 |
+
|
796 |
+
foreach ($_SERVER as $key => $value) {
|
797 |
+
if (substr($key, 0, 5) == "HTTP_") {
|
798 |
+
// this is chaos, basically it is just there to capitalize the first
|
799 |
+
// letter of every word that is not an initial HTTP and strip HTTP
|
800 |
+
// code from przemek
|
801 |
+
$key = str_replace(
|
802 |
+
" ",
|
803 |
+
"-",
|
804 |
+
ucwords(strtolower(str_replace("_", " ", substr($key, 5))))
|
805 |
+
);
|
806 |
+
$out[$key] = $value;
|
807 |
+
}
|
808 |
+
}
|
809 |
+
}
|
810 |
+
return $out;
|
811 |
+
}
|
812 |
+
|
813 |
+
// This function takes a input like a=b&a=c&d=e and returns the parsed
|
814 |
+
// parameters like this
|
815 |
+
// array('a' => array('b','c'), 'd' => 'e')
|
816 |
+
public static function parse_parameters( $input ) {
|
817 |
+
if (!isset($input) || !$input) return array();
|
818 |
+
|
819 |
+
$pairs = explode('&', $input);
|
820 |
+
|
821 |
+
$parsed_parameters = array();
|
822 |
+
foreach ($pairs as $pair) {
|
823 |
+
$split = explode('=', $pair, 2);
|
824 |
+
$parameter = OAuthUtil::urldecode_rfc3986($split[0]);
|
825 |
+
$value = isset($split[1]) ? OAuthUtil::urldecode_rfc3986($split[1]) : '';
|
826 |
+
|
827 |
+
if (isset($parsed_parameters[$parameter])) {
|
828 |
+
// We have already recieved parameter(s) with this name, so add to the list
|
829 |
+
// of parameters with this name
|
830 |
+
|
831 |
+
if (is_scalar($parsed_parameters[$parameter])) {
|
832 |
+
// This is the first duplicate, so transform scalar (string) into an array
|
833 |
+
// so we can add the duplicates
|
834 |
+
$parsed_parameters[$parameter] = array($parsed_parameters[$parameter]);
|
835 |
+
}
|
836 |
+
|
837 |
+
$parsed_parameters[$parameter][] = $value;
|
838 |
+
} else {
|
839 |
+
$parsed_parameters[$parameter] = $value;
|
840 |
+
}
|
841 |
+
}
|
842 |
+
return $parsed_parameters;
|
843 |
+
}
|
844 |
+
|
845 |
+
public static function build_http_query($params) {
|
846 |
+
if (!$params) return '';
|
847 |
+
|
848 |
+
// Urlencode both keys and values
|
849 |
+
$keys = OAuthUtil::urlencode_rfc3986(array_keys($params));
|
850 |
+
$values = OAuthUtil::urlencode_rfc3986(array_values($params));
|
851 |
+
$params = array_combine($keys, $values);
|
852 |
+
|
853 |
+
// Parameters are sorted by name, using lexicographical byte value ordering.
|
854 |
+
// Ref: Spec: 9.1.1 (1)
|
855 |
+
uksort($params, 'strcmp');
|
856 |
+
|
857 |
+
$pairs = array();
|
858 |
+
foreach ($params as $parameter => $value) {
|
859 |
+
if (is_array($value)) {
|
860 |
+
// If two or more parameters share the same name, they are sorted by their value
|
861 |
+
// Ref: Spec: 9.1.1 (1)
|
862 |
+
natsort($value);
|
863 |
+
foreach ($value as $duplicate_value) {
|
864 |
+
$pairs[] = $parameter . '=' . $duplicate_value;
|
865 |
+
}
|
866 |
+
} else {
|
867 |
+
$pairs[] = $parameter . '=' . $value;
|
868 |
+
}
|
869 |
+
}
|
870 |
+
// For each parameter, the name is separated from the corresponding value by an '=' character (ASCII code 61)
|
871 |
+
// Each name-value pair is separated by an '&' character (ASCII code 38)
|
872 |
+
return implode('&', $pairs);
|
873 |
+
}
|
874 |
+
}
|
trunk/twitteroauth/twitteroauth.php
ADDED
@@ -0,0 +1,241 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
<?php
|
2 |
+
|
3 |
+
/*
|
4 |
+
* Abraham Williams (abraham@abrah.am) http://abrah.am
|
5 |
+
*
|
6 |
+
* The first PHP Library to support OAuth for Twitter's REST API.
|
7 |
+
*/
|
8 |
+
|
9 |
+
/* Load OAuth lib. You can find it at http://oauth.net */
|
10 |
+
require_once('OAuth.php');
|
11 |
+
|
12 |
+
/**
|
13 |
+
* Twitter OAuth class
|
14 |
+
*/
|
15 |
+
class TwitterOAuth {
|
16 |
+
/* Contains the last HTTP status code returned. */
|
17 |
+
public $http_code;
|
18 |
+
/* Contains the last API call. */
|
19 |
+
public $url;
|
20 |
+
/* Set up the API root URL. */
|
21 |
+
public $host = "https://api.twitter.com/1.1/";
|
22 |
+
/* Set timeout default. */
|
23 |
+
public $timeout = 30;
|
24 |
+
/* Set connect timeout. */
|
25 |
+
public $connecttimeout = 30;
|
26 |
+
/* Verify SSL Cert. */
|
27 |
+
public $ssl_verifypeer = FALSE;
|
28 |
+
/* Respons format. */
|
29 |
+
public $format = 'json';
|
30 |
+
/* Decode returned json data. */
|
31 |
+
public $decode_json = TRUE;
|
32 |
+
/* Contains the last HTTP headers returned. */
|
33 |
+
public $http_info;
|
34 |
+
/* Set the useragnet. */
|
35 |
+
public $useragent = 'TwitterOAuth v0.2.0-beta2';
|
36 |
+
/* Immediately retry the API call if the response was not successful. */
|
37 |
+
//public $retry = TRUE;
|
38 |
+
|
39 |
+
|
40 |
+
|
41 |
+
|
42 |
+
/**
|
43 |
+
* Set API URLS
|
44 |
+
*/
|
45 |
+
function accessTokenURL() { return 'https://api.twitter.com/oauth/access_token'; }
|
46 |
+
function authenticateURL() { return 'https://api.twitter.com/oauth/authenticate'; }
|
47 |
+
function authorizeURL() { return 'https://api.twitter.com/oauth/authorize'; }
|
48 |
+
function requestTokenURL() { return 'https://api.twitter.com/oauth/request_token'; }
|
49 |
+
|
50 |
+
/**
|
51 |
+
* Debug helpers
|
52 |
+
*/
|
53 |
+
function lastStatusCode() { return $this->http_status; }
|
54 |
+
function lastAPICall() { return $this->last_api_call; }
|
55 |
+
|
56 |
+
/**
|
57 |
+
* construct TwitterOAuth object
|
58 |
+
*/
|
59 |
+
function __construct($consumer_key, $consumer_secret, $oauth_token = NULL, $oauth_token_secret = NULL) {
|
60 |
+
$this->sha1_method = new OAuthSignatureMethod_HMAC_SHA1();
|
61 |
+
$this->consumer = new OAuthConsumer($consumer_key, $consumer_secret);
|
62 |
+
if (!empty($oauth_token) && !empty($oauth_token_secret)) {
|
63 |
+
$this->token = new OAuthConsumer($oauth_token, $oauth_token_secret);
|
64 |
+
} else {
|
65 |
+
$this->token = NULL;
|
66 |
+
}
|
67 |
+
}
|
68 |
+
|
69 |
+
|
70 |
+
/**
|
71 |
+
* Get a request_token from Twitter
|
72 |
+
*
|
73 |
+
* @returns a key/value array containing oauth_token and oauth_token_secret
|
74 |
+
*/
|
75 |
+
function getRequestToken($oauth_callback) {
|
76 |
+
$parameters = array();
|
77 |
+
$parameters['oauth_callback'] = $oauth_callback;
|
78 |
+
$request = $this->oAuthRequest($this->requestTokenURL(), 'GET', $parameters);
|
79 |
+
$token = OAuthUtil::parse_parameters($request);
|
80 |
+
$this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']);
|
81 |
+
return $token;
|
82 |
+
}
|
83 |
+
|
84 |
+
/**
|
85 |
+
* Get the authorize URL
|
86 |
+
*
|
87 |
+
* @returns a string
|
88 |
+
*/
|
89 |
+
function getAuthorizeURL($token, $sign_in_with_twitter = TRUE) {
|
90 |
+
if (is_array($token)) {
|
91 |
+
$token = $token['oauth_token'];
|
92 |
+
}
|
93 |
+
if (empty($sign_in_with_twitter)) {
|
94 |
+
return $this->authorizeURL() . "?oauth_token={$token}";
|
95 |
+
} else {
|
96 |
+
return $this->authenticateURL() . "?oauth_token={$token}";
|
97 |
+
}
|
98 |
+
}
|
99 |
+
|
100 |
+
/**
|
101 |
+
* Exchange request token and secret for an access token and
|
102 |
+
* secret, to sign API calls.
|
103 |
+
*
|
104 |
+
* @returns array("oauth_token" => "the-access-token",
|
105 |
+
* "oauth_token_secret" => "the-access-secret",
|
106 |
+
* "user_id" => "9436992",
|
107 |
+
* "screen_name" => "abraham")
|
108 |
+
*/
|
109 |
+
function getAccessToken($oauth_verifier) {
|
110 |
+
$parameters = array();
|
111 |
+
$parameters['oauth_verifier'] = $oauth_verifier;
|
112 |
+
$request = $this->oAuthRequest($this->accessTokenURL(), 'GET', $parameters);
|
113 |
+
$token = OAuthUtil::parse_parameters($request);
|
114 |
+
$this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']);
|
115 |
+
return $token;
|
116 |
+
}
|
117 |
+
|
118 |
+
/**
|
119 |
+
* One time exchange of username and password for access token and secret.
|
120 |
+
*
|
121 |
+
* @returns array("oauth_token" => "the-access-token",
|
122 |
+
* "oauth_token_secret" => "the-access-secret",
|
123 |
+
* "user_id" => "9436992",
|
124 |
+
* "screen_name" => "abraham",
|
125 |
+
* "x_auth_expires" => "0")
|
126 |
+
*/
|
127 |
+
function getXAuthToken($username, $password) {
|
128 |
+
$parameters = array();
|
129 |
+
$parameters['x_auth_username'] = $username;
|
130 |
+
$parameters['x_auth_password'] = $password;
|
131 |
+
$parameters['x_auth_mode'] = 'client_auth';
|
132 |
+
$request = $this->oAuthRequest($this->accessTokenURL(), 'POST', $parameters);
|
133 |
+
$token = OAuthUtil::parse_parameters($request);
|
134 |
+
$this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']);
|
135 |
+
return $token;
|
136 |
+
}
|
137 |
+
|
138 |
+
/**
|
139 |
+
* GET wrapper for oAuthRequest.
|
140 |
+
*/
|
141 |
+
function get($url, $parameters = array()) {
|
142 |
+
$response = $this->oAuthRequest($url, 'GET', $parameters);
|
143 |
+
if ($this->format === 'json' && $this->decode_json) {
|
144 |
+
return json_decode($response);
|
145 |
+
}
|
146 |
+
return $response;
|
147 |
+
}
|
148 |
+
|
149 |
+
/**
|
150 |
+
* POST wrapper for oAuthRequest.
|
151 |
+
*/
|
152 |
+
function post($url, $parameters = array()) {
|
153 |
+
$response = $this->oAuthRequest($url, 'POST', $parameters);
|
154 |
+
if ($this->format === 'json' && $this->decode_json) {
|
155 |
+
return json_decode($response);
|
156 |
+
}
|
157 |
+
return $response;
|
158 |
+
}
|
159 |
+
|
160 |
+
/**
|
161 |
+
* DELETE wrapper for oAuthReqeust.
|
162 |
+
*/
|
163 |
+
function delete($url, $parameters = array()) {
|
164 |
+
$response = $this->oAuthRequest($url, 'DELETE', $parameters);
|
165 |
+
if ($this->format === 'json' && $this->decode_json) {
|
166 |
+
return json_decode($response);
|
167 |
+
}
|
168 |
+
return $response;
|
169 |
+
}
|
170 |
+
|
171 |
+
/**
|
172 |
+
* Format and sign an OAuth / API request
|
173 |
+
*/
|
174 |
+
function oAuthRequest($url, $method, $parameters) {
|
175 |
+
if (strrpos($url, 'https://') !== 0 && strrpos($url, 'http://') !== 0) {
|
176 |
+
$url = "{$this->host}{$url}.{$this->format}";
|
177 |
+
}
|
178 |
+
$request = OAuthRequest::from_consumer_and_token($this->consumer, $this->token, $method, $url, $parameters);
|
179 |
+
$request->sign_request($this->sha1_method, $this->consumer, $this->token);
|
180 |
+
switch ($method) {
|
181 |
+
case 'GET':
|
182 |
+
return $this->http($request->to_url(), 'GET');
|
183 |
+
default:
|
184 |
+
return $this->http($request->get_normalized_http_url(), $method, $request->to_postdata());
|
185 |
+
}
|
186 |
+
}
|
187 |
+
|
188 |
+
/**
|
189 |
+
* Make an HTTP request
|
190 |
+
*
|
191 |
+
* @return API results
|
192 |
+
*/
|
193 |
+
function http($url, $method, $postfields = NULL) {
|
194 |
+
$this->http_info = array();
|
195 |
+
$ci = curl_init();
|
196 |
+
/* Curl settings */
|
197 |
+
curl_setopt($ci, CURLOPT_USERAGENT, $this->useragent);
|
198 |
+
curl_setopt($ci, CURLOPT_CONNECTTIMEOUT, $this->connecttimeout);
|
199 |
+
curl_setopt($ci, CURLOPT_TIMEOUT, $this->timeout);
|
200 |
+
curl_setopt($ci, CURLOPT_RETURNTRANSFER, TRUE);
|
201 |
+
curl_setopt($ci, CURLOPT_HTTPHEADER, array('Expect:'));
|
202 |
+
curl_setopt($ci, CURLOPT_SSL_VERIFYPEER, $this->ssl_verifypeer);
|
203 |
+
curl_setopt($ci, CURLOPT_HEADERFUNCTION, array($this, 'getHeader'));
|
204 |
+
curl_setopt($ci, CURLOPT_HEADER, FALSE);
|
205 |
+
|
206 |
+
switch ($method) {
|
207 |
+
case 'POST':
|
208 |
+
curl_setopt($ci, CURLOPT_POST, TRUE);
|
209 |
+
if (!empty($postfields)) {
|
210 |
+
curl_setopt($ci, CURLOPT_POSTFIELDS, $postfields);
|
211 |
+
}
|
212 |
+
break;
|
213 |
+
case 'DELETE':
|
214 |
+
curl_setopt($ci, CURLOPT_CUSTOMREQUEST, 'DELETE');
|
215 |
+
if (!empty($postfields)) {
|
216 |
+
$url = "{$url}?{$postfields}";
|
217 |
+
}
|
218 |
+
}
|
219 |
+
|
220 |
+
curl_setopt($ci, CURLOPT_URL, $url);
|
221 |
+
$response = curl_exec($ci);
|
222 |
+
$this->http_code = curl_getinfo($ci, CURLINFO_HTTP_CODE);
|
223 |
+
$this->http_info = array_merge($this->http_info, curl_getinfo($ci));
|
224 |
+
$this->url = $url;
|
225 |
+
curl_close ($ci);
|
226 |
+
return $response;
|
227 |
+
}
|
228 |
+
|
229 |
+
/**
|
230 |
+
* Get the header info to store.
|
231 |
+
*/
|
232 |
+
function getHeader($ch, $header) {
|
233 |
+
$i = strpos($header, ':');
|
234 |
+
if (!empty($i)) {
|
235 |
+
$key = str_replace('-', '_', strtolower(substr($header, 0, $i)));
|
236 |
+
$value = trim(substr($header, $i + 2));
|
237 |
+
$this->http_header[$key] = $value;
|
238 |
+
}
|
239 |
+
return strlen($header);
|
240 |
+
}
|
241 |
+
}
|