Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge branch 'master' of git://github.com/dwhittle/yos-social-php int…

…o dwhittle/master
  • Loading branch information...
commit fbaae9b7744afe0e8e00a5ef62af8407ecea27ec 2 parents 4904ff9 + c2cc55a
@dustinwhittle dustinwhittle authored
View
14 INSTALL.txt
@@ -1,5 +1,7 @@
+=================
Yahoo! OS PHP SDK
-=============
+=================
+
After downloading and unpackaging the release, copy the contents of yosdk/lib
to a directory that is accessible via the PHP require/require_once methods. In
your PHP scripts, require the Yahoo.inc file:
@@ -46,8 +48,8 @@ YahooLogger::setDebugDestination('LOG');
Storing OAuth credentials on filesystem, memcache, cookies
==========================================================
-By default OAuth credential (request + access tokens) are stored in PHP sessions.
-PHP sessions can easily be configured to work from local filesystem, database, or
+By default, OAuth credentials (request + access tokens) are stored in PHP sessions.
+PHP sessions can easily be configured to work from a local filesystem, a database, or
a memcache instance. The sample apps provide working examples of filesystem storage
and memcache storage.
@@ -58,9 +60,9 @@ Filesystem Session Storage (default)
// Include the YOS library.
require dirname(__FILE__).'/../lib/Yahoo.inc';
-// use memcache to store oauth credentials via php native sessions
-ini_set('session.save_handler', 'memcache');
-session_save_path('tcp://localhost:11211?persistent=1&weight=1&timeout=1&retry_interval=15');
+// use local filesystem to store oauth credentials via php native sessions
+ini_set('session.save_handler', 'files');
+session_save_path('/tmp/');
session_start();
========================
View
5 lib/JSON.php
@@ -1,5 +1,4 @@
<?php
-/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/**
* Converts to and from JSON format.
@@ -666,7 +665,7 @@ function decode($str)
// element in an associative array,
// for now
$parts = array();
-
+
if (preg_match('/^\s*(["\'].*[^\\\]["\'])\s*:\s*(\S.*),?$/Uis', $slice, $parts)) {
// "name":value pair
$key = $this->decode($parts[1]);
@@ -802,5 +801,3 @@ function Services_JSON_Error($message = 'unknown error', $code = null,
}
}
-
-?>
View
749 lib/OAuth.php
@@ -1,19 +1,20 @@
<?php
+
/**
* The MIT License
- *
- * Copyright (c) 2008 OAuth.net
- *
+ *
+ * Copyright (c) 2007 Andy Smith
+ *
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
- *
+ *
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
- *
+ *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -21,28 +22,24 @@
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
- *
- */
-
-/**
- * Branched from version 587 of OAuth.php from the OAuth.net project. Major
- * changes are limited to adding PHP 4 compatibility.
- *
- * Ryan Kennedy (rckenned@yahoo-inc.com)
*/
-class OAuthConsumer {/*{{{*/
+class OAuthConsumer {
var $key;
var $secret;
- function OAuthConsumer($key, $secret, $callback_url=NULL) {/*{{{*/
+ function OAuthConsumer($key, $secret, $callback_url=NULL) {
$this->key = $key;
$this->secret = $secret;
$this->callback_url = $callback_url;
- }/*}}}*/
-}/*}}}*/
+ }
-class OAuthToken {/*{{{*/
+ function __toString() {
+ return "OAuthConsumer[key=$this->key,secret=$this->secret]";
+ }
+}
+
+class OAuthToken {
// access tokens and request tokens
var $key;
var $secret;
@@ -51,38 +48,38 @@ class OAuthToken {/*{{{*/
* key = the token
* secret = the token secret
*/
- function OAuthToken($key, $secret) {/*{{{*/
+ function OAuthToken($key, $secret) {
$this->key = $key;
$this->secret = $secret;
- }/*}}}*/
+ }
/**
* generates the basic string serialization of a token that a server
* would respond to request_token and access_token calls with
*/
- function to_string() {/*{{{*/
- return "oauth_token=" . OAuthUtil::urlencodeRFC3986($this->key) .
- "&oauth_token_secret=" . OAuthUtil::urlencodeRFC3986($this->secret);
- }/*}}}*/
+ function to_string() {
+ return "oauth_token=" . OAuthUtil::urlencode_rfc3986($this->key) .
+ "&oauth_token_secret=" . OAuthUtil::urlencode_rfc3986($this->secret);
+ }
- function __toString() {/*{{{*/
+ function __toString() {
return $this->to_string();
- }/*}}}*/
-}/*}}}*/
+ }
+}
-class OAuthSignatureMethod {/*{{{*/
+class OAuthSignatureMethod {
function check_signature(&$request, $consumer, $token, $signature) {
$built = $this->build_signature($request, $consumer, $token);
return $built == $signature;
}
-}/*}}}*/
+}
-class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod {/*{{{*/
- function get_name() {/*{{{*/
+class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod {
+ function get_name() {
return "HMAC-SHA1";
- }/*}}}*/
+ }
- function build_signature($request, $consumer, $token) {/*{{{*/
+ function build_signature($request, $consumer, $token) {
$base_string = $request->get_signature_base_string();
$request->base_string = $base_string;
@@ -91,25 +88,25 @@ function build_signature($request, $consumer, $token) {/*{{{*/
($token) ? $token->secret : ""
);
- $key_parts = array_map(array('OAuthUtil','urlencodeRFC3986'), $key_parts);
+ $key_parts = OAuthUtil::urlencode_rfc3986($key_parts);
$key = implode('&', $key_parts);
- return base64_encode(hash_hmac('sha1', $base_string, $key, true));
- }/*}}}*/
-}/*}}}*/
+ return base64_encode( hash_hmac('sha1', $base_string, $key, true));
+ }
+}
-class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod {/*{{{*/
- function get_name() {/*{{{*/
+class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod {
+ function get_name() {
return "PLAINTEXT";
- }/*}}}*/
+ }
- function build_signature($request, $consumer, $token) {/*{{{*/
+ function build_signature($request, $consumer, $token) {
$sig = array(
- OAuthUtil::urlencodeRFC3986($consumer->secret)
+ OAuthUtil::urlencode_rfc3986($consumer->secret)
);
if ($token) {
- array_push($sig, OAuthUtil::urlencodeRFC3986($token->secret));
+ array_push($sig, OAuthUtil::urlencode_rfc3986($token->secret));
} else {
array_push($sig, '');
}
@@ -118,38 +115,39 @@ function build_signature($request, $consumer, $token) {/*{{{*/
// for debug purposes
$request->base_string = $raw;
- return $raw;
- }/*}}}*/
-}/*}}}*/
+ return OAuthUtil::urlencode_rfc3986($raw);
+ }
+}
-class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod {/*{{{*/
- function get_name() {/*{{{*/
+class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod {
+ function get_name() {
return "RSA-SHA1";
- }/*}}}*/
+ }
- function fetch_public_cert(&$request) {/*{{{*/
+ function fetch_public_cert(&$request) {
// not implemented yet, ideas are:
// (1) do a lookup in a table of trusted certs keyed off of consumer
// (2) fetch via http using a url provided by the requester
// (3) some sort of specific discovery code based on request
//
// either way should return a string representation of the certificate
- trigger_error("fetch_public_cert not implemented", E_USER_ERROR);
+ trigger_error("fetch_public_cert not implemented", E_USER_WARNING);
return NULL;
- }/*}}}*/
+ }
- function fetch_private_cert(&$request) {/*{{{*/
+ function fetch_private_cert(&$request) {
// not implemented yet, ideas are:
// (1) do a lookup in a table of trusted certs keyed off of consumer
//
// either way should return a string representation of the certificate
- trigger_error("fetch_private_cert not implemented", E_USER_ERROR);
+ trigger_error("fetch_private_cert not implemented", E_USER_WARNING);
return NULL;
- }/*}}}*/
+ }
- function build_signature(&$request, $consumer, $token) {/*{{{*/
+ function build_signature(&$request, $consumer, $token) {
$base_string = $request->get_signature_base_string();
-
+ $request->base_string = $base_string;
+
// Fetch the private key cert based on the request
$cert = $this->fetch_private_cert($request);
@@ -157,19 +155,19 @@ function build_signature(&$request, $consumer, $token) {/*{{{*/
$privatekeyid = openssl_get_privatekey($cert);
// Sign using the key
- $ok = openssl_sign($base_string, $signature, $privatekeyid);
+ $ok = openssl_sign($base_string, $signature, $privatekeyid);
// Release the key resource
openssl_free_key($privatekeyid);
-
+
return base64_encode($signature);
- } /*}}}*/
+ }
- function check_signature(&$request, $consumer, $token, $signature) {/*{{{*/
+ function check_signature(&$request, $consumer, $token, $signature) {
$decoded_sig = base64_decode($signature);
$base_string = $request->get_signature_base_string();
-
+
// Fetch the public key cert based on the request
$cert = $this->fetch_public_cert($request);
@@ -177,37 +175,43 @@ function check_signature(&$request, $consumer, $token, $signature) {/*{{{*/
$publickeyid = openssl_get_publickey($cert);
// Check the computed signature against the one passed in the query
- $ok = openssl_verify($base_string, $decoded_sig, $publickeyid);
+ $ok = openssl_verify($base_string, $decoded_sig, $publickeyid);
// Release the key resource
openssl_free_key($publickeyid);
-
+
return $ok == 1;
- } /*}}}*/
-}/*}}}*/
+ }
+}
-class OAuthRequest {/*{{{*/
+class OAuthRequest {
var $parameters;
var $http_method;
var $http_url;
// for debug purposes
var $base_string;
+ var $version = '1.0';
- function OAuthRequest($http_method, $http_url, $parameters=array()) {/*{{{*/
+ function OAuthRequest($http_method, $http_url, $parameters=NULL) {
+ @$parameters or $parameters = array();
$this->parameters = $parameters;
$this->http_method = $http_method;
$this->http_url = $http_url;
- }/*}}}*/
+ }
+
+ function unset_parameter($name) {
+ unset($this->parameters[$name]);
+ }
/**
* attempt to build up a request from what was passed to the server
*/
- function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) {/*{{{*/
+ static function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) {
$scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on") ? 'http' : 'https';
- @$http_url or $http_url = $scheme . '://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
+ @$http_url or $http_url = $scheme . '://' . $_SERVER['HTTP_HOST'] . ':' . $_SERVER['SERVER_PORT'] . $_SERVER['REQUEST_URI'];
@$http_method or $http_method = $_SERVER['REQUEST_METHOD'];
-
+
$request_headers = OAuthRequest::get_headers();
// let the library user override things however they'd like, if they know
@@ -215,36 +219,33 @@ function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) {/*{{
// do this
if ($parameters) {
$req = new OAuthRequest($http_method, $http_url, $parameters);
+ } else {
+ // collect request parameters from query string (GET) and post-data (POST) if appropriate (note: POST vars have priority)
+ // NOTE: $_GET and $_POST will strip duplicate query parameters
+ $req_parameters = $_GET;
+ if ($http_method == "POST" && @strstr($request_headers["Content-Type"], "application/x-www-form-urlencoded") ) {
+ $req_parameters = array_merge($req_parameters, $_POST);
+ }
+
+ // next check for the auth header, we need to do some extra stuff
+ // if that is the case, namely suck in the parameters from GET or POST
+ // so that we can include them in the signature
+ if (@substr($request_headers['Authorization'], 0, 6) == "OAuth ") {
+ $header_parameters = OAuthRequest::split_header($request_headers['Authorization']);
+ $parameters = array_merge($req_parameters, $header_parameters);
+ $req = new OAuthRequest($http_method, $http_url, $parameters);
+ } else $req = new OAuthRequest($http_method, $http_url, $req_parameters);
}
- // next check for the auth header, we need to do some extra stuff
- // if that is the case, namely suck in the parameters from GET or POST
- // so that we can include them in the signature
- else if (@substr($request_headers['Authorization'], 0, 5) == "OAuth") {
- $header_parameters = OAuthRequest::split_header($request_headers['Authorization']);
- if ($http_method == "GET") {
- $req_parameters = $_GET;
- }
- else if ($http_method = "POST") {
- $req_parameters = $_POST;
- }
- $parameters = array_merge($header_parameters, $req_parameters);
- $req = new OAuthRequest($http_method, $http_url, $parameters);
- }
- else if ($http_method == "GET") {
- $req = new OAuthRequest($http_method, $http_url, $_GET);
- }
- else if ($http_method == "POST") {
- $req = new OAuthRequest($http_method, $http_url, $_POST);
- }
+
return $req;
- }/*}}}*/
+ }
/**
* pretty much a helper function to set up the request
*/
- function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=array()) {/*{{{*/
- static $version = '1.0';
- $defaults = array("oauth_version" => $version,
+ static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=NULL) {
+ @$parameters or $parameters = array();
+ $defaults = array("oauth_version" => '1.0',
"oauth_nonce" => OAuthRequest::generate_nonce(),
"oauth_timestamp" => OAuthRequest::generate_timestamp(),
"oauth_consumer_key" => $consumer->key);
@@ -253,82 +254,58 @@ function from_consumer_and_token($consumer, $token, $http_method, $http_url, $pa
if ($token) {
$parameters['oauth_token'] = $token->key;
}
- $req = new OAuthRequest($http_method, $http_url, $parameters);
- return $req;
- }/*}}}*/
+ return new OAuthRequest($http_method, $http_url, $parameters);
+ }
- function set_parameter($name, $value) {/*{{{*/
+ function set_parameter($name, $value) {
$this->parameters[$name] = $value;
- }/*}}}*/
+ }
- function get_parameter($name) {/*{{{*/
- return $this->parameters[$name];
- }/*}}}*/
+ function get_parameter($name) {
+ return isset($this->parameters[$name]) ? $this->parameters[$name] : NULL;
+ }
- function get_parameters() {/*{{{*/
+ function get_parameters() {
return $this->parameters;
- }/*}}}*/
+ }
/**
* Returns the normalized parameters of the request
- *
+ *
* This will be all (except oauth_signature) parameters,
* sorted first by key, and if duplicate keys, then by
* value.
*
* The returned string will be all the key=value pairs
* concated by &.
- *
+ *
* @return string
*/
- function get_signable_parameters() {/*{{{*/
+ function get_signable_parameters() {
// Include query parameters
- $url = parse_url($this->http_url);
- if(array_key_exists("query", $url)) {
- parse_str($url["query"], $query);
+ $query_str = parse_url($this->http_url, PHP_URL_QUERY);
+ if($query_str) {
+ $parsed_query = OAuthUtil::oauth_parse_string($query_str);
+ parse_str($query_str, $php_parsed_query);
- foreach($query as $key => $value) {
- $this->set_parameter($key, $value);
- }
- }
+ if(OAuthUtil::oauth_http_build_query($parsed_query) != OAuthUtil::oauth_http_build_query($php_parsed_query)) {
+ $parsed_query = $php_parsed_query;
+ }
+ foreach($parsed_query as $key => $value) {
+ $this->set_parameter($key, $value);
+ }
+ }
// Grab all parameters
$params = $this->parameters;
-
+
// Remove oauth_signature if present
if (isset($params['oauth_signature'])) {
unset($params['oauth_signature']);
}
-
- // Urlencode both keys and values
- $keys = array_map(array('OAuthUtil', 'urlencodeRFC3986'), array_keys($params));
- $values = array_map(array('OAuthUtil', 'urlencodeRFC3986'), array_values($params));
- $params = array();
- for($i = 0; $i < count($keys); $i++) {
- $params[$keys[$i]] = $values[$i];
- }
-
- // Sort by keys (natsort)
- uksort($params, 'strnatcmp');
- // Generate key=value pairs
- $pairs = array();
- foreach ($params as $key=>$value ) {
- if (is_array($value)) {
- // If the value is an array, it's because there are multiple
- // with the same key, sort them, then add all the pairs
- natsort($value);
- foreach ($value as $v2) {
- $pairs[] = $key . '=' . $v2;
- }
- } else {
- $pairs[] = $key . '=' . $value;
- }
- }
-
- // Return the pairs, concated with &
- return implode('&', $pairs);
- }/*}}}*/
+ return OAuthUtil::oauth_http_build_query($params);
+ }
/**
* Returns the base string of this request
@@ -337,132 +314,144 @@ function get_signable_parameters() {/*{{{*/
* and the parameters (normalized), each urlencoded
* and the concated with &.
*/
- function get_signature_base_string() {/*{{{*/
+ function get_signature_base_string() {
$parts = array(
$this->get_normalized_http_method(),
$this->get_normalized_http_url(),
$this->get_signable_parameters()
);
- $parts = array_map(array('OAuthUtil', 'urlencodeRFC3986'), $parts);
+ $parts = OAuthUtil::urlencode_rfc3986($parts);
return implode('&', $parts);
- }/*}}}*/
+ }
/**
* just uppercases the http method
*/
- function get_normalized_http_method() {/*{{{*/
+ function get_normalized_http_method() {
return strtoupper($this->http_method);
- }/*}}}*/
+ }
/**
* parses the url and rebuilds it to be
* scheme://host/path
*/
- function get_normalized_http_url() {/*{{{*/
+ function get_normalized_http_url() {
$parts = parse_url($this->http_url);
- // FIXME: port should handle according to http://groups.google.com/group/oauth/browse_thread/thread/1b203a51d9590226
- $port = (isset($parts['port']) && $parts['port'] != '80') ? ':' . $parts['port'] : '';
- $path = (isset($parts['path'])) ? $parts['path'] : '';
+ $port = @$parts['port'];
+ $scheme = $parts['scheme'];
+ $host = $parts['host'];
+ $path = @$parts['path'];
+
+ $port or $port = ($scheme == 'https') ? '443' : '80';
- return $parts['scheme'] . '://' . $parts['host'] . $port . $path;
- }/*}}}*/
+ if (($scheme == 'https' && $port != '443')
+ || ($scheme == 'http' && $port != '80')) {
+ $host = "$host:$port";
+ }
+ return "$scheme://$host$path";
+ }
/**
* builds a url usable for a GET request
*/
- function to_url() {/*{{{*/
+ function to_url() {
$out = $this->get_normalized_http_url() . "?";
$out .= $this->to_postdata();
return $out;
- }/*}}}*/
+ }
/**
* builds the data one would send in a POST request
*/
- function to_postdata() {/*{{{*/
- $total = array();
- foreach ($this->parameters as $k => $v) {
- $total[] = OAuthUtil::urlencodeRFC3986($k) . "=" . OAuthUtil::urlencodeRFC3986($v);
- }
- $out = implode("&", $total);
- return $out;
- }/*}}}*/
+ function to_postdata() {
+ return OAuthUtil::oauth_http_build_query($this->parameters);
+ }
/**
* builds the Authorization: header
*/
- function to_header() {/*{{{*/
- $headerParams = array();
+ function to_header() {
+ $out ='Authorization: OAuth realm="yahooapis.com"';
+ $total = array();
foreach ($this->parameters as $k => $v) {
- if (substr($k, 0, 5) != "oauth") continue;
- $headerParams[] = OAuthUtil::urlencodeRFC3986($k) . '="' . OAuthUtil::urlencodeRFC3986($v) . '"';
+ if (substr($k, 0, 5) != "oauth")
+ {
+ continue;
+ }
+ if (is_array($v))
+ {
+ trigger_error('Arrays not supported in headers', E_USER_WARNING);
+ return NULL;
+ }
+ $out .= ',' . OAuthUtil::urlencode_rfc3986($k) . '="' . OAuthUtil::urlencode_rfc3986($v) . '"';
}
- return sprintf("Authorization: OAuth %s", implode(",", $headerParams));
- }/*}}}*/
- function __toString() {/*{{{*/
+ return $out;
+ }
+
+ function __toString() {
return $this->to_url();
- }/*}}}*/
+ }
- function sign_request($signature_method, $consumer, $token) {/*{{{*/
+ function sign_request($signature_method, $consumer, $token) {
$this->set_parameter("oauth_signature_method", $signature_method->get_name());
$signature = $this->build_signature($signature_method, $consumer, $token);
$this->set_parameter("oauth_signature", $signature);
- }/*}}}*/
+ }
- function build_signature($signature_method, $consumer, $token) {/*{{{*/
+ function build_signature($signature_method, $consumer, $token) {
$signature = $signature_method->build_signature($this, $consumer, $token);
return $signature;
- }/*}}}*/
+ }
/**
* util function: current timestamp
*/
- function generate_timestamp() {/*{{{*/
+ static function generate_timestamp() {
return time();
- }/*}}}*/
+ }
/**
* util function: current nonce
*/
- function generate_nonce() {/*{{{*/
+ static function generate_nonce() {
$mt = microtime();
$rand = mt_rand();
return md5($mt . $rand); // md5s look nicer than numbers
- }/*}}}*/
+ }
/**
* util function for turning the Authorization: header into
* parameters, has to do some unescaping
*/
- function split_header($header) {/*{{{*/
- // this should be a regex
- // error cases: commas in parameter values
- $parts = explode(",", $header);
- $out = array();
- foreach ($parts as $param) {
- $param = ltrim($param);
- // skip the "realm" param, nobody ever uses it anyway
- if (substr($param, 0, 5) != "oauth") continue;
-
- $param_parts = explode("=", $param);
+ static function split_header($header) {
+ $pattern = '/(([-_a-z]*)=("([^"]*)"|([^,]*)),?)/';
+ $offset = 0;
+ $params = array();
+ while (preg_match($pattern, $header, $matches, PREG_OFFSET_CAPTURE, $offset) > 0) {
+ $match = $matches[0];
+ $header_name = $matches[2][0];
+ $header_content = (isset($matches[5])) ? $matches[5][0] : $matches[4][0];
+ $params[$header_name] = OAuthUtil::urldecode_rfc3986( $header_content );
+ $offset = $match[1] + strlen($match[0]);
+ }
- // rawurldecode() used because urldecode() will turn a "+" in the
- // value into a space
- $out[$param_parts[0]] = rawurldecode(substr($param_parts[1], 1, -1));
+ if (isset($params['realm'])) {
+ unset($params['realm']);
}
- return $out;
- }/*}}}*/
+
+ return $params;
+ }
/**
* helper to try to sort out headers for people who aren't running apache
*/
- function get_headers() {/*{{{*/
+ static function get_headers() {
if (function_exists('apache_request_headers')) {
// we need this to get the actual Authorization: header
// because apache tends to tell us it doesn't exist
@@ -481,32 +470,32 @@ function get_headers() {/*{{{*/
}
}
return $out;
- }/*}}}*/
-}/*}}}*/
+ }
+}
-class OAuthServer {/*{{{*/
+class OAuthServer {
var $timestamp_threshold = 300; // in seconds, five minutes
- var $version = 1.0; // hi blaine
+ var $version = '1.0'; // hi blaine
var $signature_methods = array();
var $data_store;
- function OAuthServer($data_store) {/*{{{*/
+ function OAuthServer($data_store) {
$this->data_store = $data_store;
- }/*}}}*/
+ }
- function add_signature_method($signature_method) {/*{{{*/
- $this->signature_methods[$signature_method->get_name()] =
+ function add_signature_method($signature_method) {
+ $this->signature_methods[$signature_method->get_name()] =
$signature_method;
- }/*}}}*/
-
+ }
+
// high level functions
/**
* process a request_token request
* returns the request token on success
*/
- function fetch_request_token(&$request) {/*{{{*/
+ function fetch_request_token(&$request) {
$this->get_version($request);
$consumer = $this->get_consumer($request);
@@ -519,13 +508,13 @@ function fetch_request_token(&$request) {/*{{{*/
$new_token = $this->data_store->new_request_token($consumer);
return $new_token;
- }/*}}}*/
+ }
/**
* process an access_token request
* returns the access token on success
*/
- function fetch_access_token(&$request) {/*{{{*/
+ function fetch_access_token(&$request) {
$this->get_version($request);
$consumer = $this->get_consumer($request);
@@ -533,61 +522,63 @@ function fetch_access_token(&$request) {/*{{{*/
// requires authorized request token
$token = $this->get_token($request, $consumer, "request");
+
$this->check_signature($request, $consumer, $token);
$new_token = $this->data_store->new_access_token($token, $consumer);
return $new_token;
- }/*}}}*/
+ }
/**
* verify an api call, checks all the parameters
*/
- function verify_request(&$request) {/*{{{*/
+ function verify_request(&$request) {
$this->get_version($request);
$consumer = $this->get_consumer($request);
$token = $this->get_token($request, $consumer, "access");
$this->check_signature($request, $consumer, $token);
return array($consumer, $token);
- }/*}}}*/
+ }
// Internals from here
/**
* version 1
*/
- function get_version(&$request) {/*{{{*/
+ function get_version(&$request) {
$version = $request->get_parameter("oauth_version");
if (!$version) {
- $version = 1.0;
+ $version = '1.0';
}
if ($version && $version != $this->version) {
trigger_error("OAuth version '$version' not supported", E_USER_WARNING);
- return NULL;
+ return '1.0';
}
return $version;
- }/*}}}*/
+ }
/**
* figure out the signature with some defaults
*/
- function get_signature_method(&$request) {/*{{{*/
- $signature_method =
+ function get_signature_method(&$request) {
+ $signature_method =
@$request->get_parameter("oauth_signature_method");
if (!$signature_method) {
$signature_method = "PLAINTEXT";
}
- if (!in_array($signature_method,
+ if (!in_array($signature_method,
array_keys($this->signature_methods))) {
- trigger_error("Signature method '$signature_method' not supported try one of the following: " . implode(", ", array_keys($this->signature_methods)), E_USER_WARNING);
- return NULL;
+ trigger_error(
+ "Signature method '$signature_method' not supported try one of the following: " . implode(", ", array_keys($this->signature_methods)), E_USER_WARNING
+ ); return NULL;
}
return $this->signature_methods[$signature_method];
- }/*}}}*/
+ }
/**
* try to find the consumer for the provided request's consumer key
*/
- function get_consumer(&$request) {/*{{{*/
+ function get_consumer(&$request) {
$consumer_key = @$request->get_parameter("oauth_consumer_key");
if (!$consumer_key) {
trigger_error("Invalid consumer key", E_USER_WARNING);
@@ -601,12 +592,12 @@ function get_consumer(&$request) {/*{{{*/
}
return $consumer;
- }/*}}}*/
+ }
/**
* try to find the token for the provided request's token key
*/
- function get_token(&$request, $consumer, $token_type="access") {/*{{{*/
+ function get_token(&$request, $consumer, $token_type="access") {
$token_field = @$request->get_parameter('oauth_token');
$token = $this->data_store->lookup_token(
$consumer, $token_type, $token_field
@@ -616,13 +607,13 @@ function get_token(&$request, $consumer, $token_type="access") {/*{{{*/
return NULL;
}
return $token;
- }/*}}}*/
+ }
/**
* all-in-one function to check the signature on a request
* should guess the signature method appropriately
*/
- function check_signature(&$request, $consumer, $token) {/*{{{*/
+ function check_signature(&$request, $consumer, $token) {
// this should probably be in a different method
$timestamp = @$request->get_parameter('oauth_timestamp');
$nonce = @$request->get_parameter('oauth_nonce');
@@ -632,11 +623,11 @@ function check_signature(&$request, $consumer, $token) {/*{{{*/
$signature_method = $this->get_signature_method($request);
- $signature = $request->get_parameter('oauth_signature');
+ $signature = $request->get_parameter('oauth_signature');
$valid_sig = $signature_method->check_signature(
- $request,
- $consumer,
- $token,
+ $request,
+ $consumer,
+ $token,
$signature
);
@@ -644,110 +635,110 @@ function check_signature(&$request, $consumer, $token) {/*{{{*/
trigger_error("Invalid signature", E_USER_WARNING);
return NULL;
}
- }/*}}}*/
+ }
/**
* check that the timestamp is new enough
*/
- function check_timestamp($timestamp) {/*{{{*/
+ function check_timestamp($timestamp) {
// verify that timestamp is recentish
$now = time();
if ($now - $timestamp > $this->timestamp_threshold) {
trigger_error("Expired timestamp, yours $timestamp, ours $now", E_USER_WARNING);
return NULL;
}
- }/*}}}*/
+ }
/**
* check that the nonce is not repeated
*/
- function check_nonce($consumer, $token, $nonce, $timestamp) {/*{{{*/
+ function check_nonce($consumer, $token, $nonce, $timestamp) {
// verify that the nonce is uniqueish
$found = $this->data_store->lookup_nonce($consumer, $token, $nonce, $timestamp);
if ($found) {
trigger_error("Nonce already used: $nonce", E_USER_WARNING);
return NULL;
}
- }/*}}}*/
+ }
-}/*}}}*/
+}
-class OAuthDataStore {/*{{{*/
- function lookup_consumer($consumer_key) {/*{{{*/
+class OAuthDataStore {
+ function lookup_consumer($consumer_key) {
// implement me
- }/*}}}*/
+ }
- function lookup_token($consumer, $token_type, $token) {/*{{{*/
+ function lookup_token($consumer, $token_type, $token) {
// implement me
- }/*}}}*/
+ }
- function lookup_nonce($consumer, $token, $nonce, $timestamp) {/*{{{*/
+ function lookup_nonce($consumer, $token, $nonce, $timestamp) {
// implement me
- }/*}}}*/
+ }
- function fetch_request_token($consumer) {/*{{{*/
+ function new_request_token($consumer) {
// return a new token attached to this consumer
- }/*}}}*/
+ }
- function fetch_access_token($token, $consumer) {/*{{{*/
+ function new_access_token($token, $consumer) {
// return a new access token attached to this consumer
// for the user associated with this token if the request token
// is authorized
// should also invalidate the request token
- }/*}}}*/
+ }
-}/*}}}*/
+}
/* A very naive dbm-based oauth storage
*/
-class SimpleOAuthDataStore extends OAuthDataStore {/*{{{*/
+class SimpleOAuthDataStore extends OAuthDataStore {
var $dbh;
- function SimpleOAuthDataStore($path = "oauth.gdbm") {/*{{{*/
+ function SimpleOAuthDataStore($path = "oauth.gdbm") {
$this->dbh = dba_popen($path, 'c', 'gdbm');
- }/*}}}*/
+ }
- function __destruct() {/*{{{*/
+ function __destruct() {
dba_close($this->dbh);
- }/*}}}*/
+ }
- function lookup_consumer($consumer_key) {/*{{{*/
+ function lookup_consumer($consumer_key) {
$rv = dba_fetch("consumer_$consumer_key", $this->dbh);
if ($rv === FALSE) {
return NULL;
}
$obj = unserialize($rv);
- if (!is_a($obj, "OAuthConsumer")) {
+ if (!($obj instanceof OAuthConsumer)) {
return NULL;
}
return $obj;
- }/*}}}*/
+ }
- function lookup_token($consumer, $token_type, $token) {/*{{{*/
+ function lookup_token($consumer, $token_type, $token) {
$rv = dba_fetch("${token_type}_${token}", $this->dbh);
if ($rv === FALSE) {
return NULL;
}
$obj = unserialize($rv);
- if (!is_a($obj, "OAuthToken")) {
+ if (!($obj instanceof OAuthToken)) {
return NULL;
}
return $obj;
- }/*}}}*/
+ }
- function lookup_nonce($consumer, $token, $nonce, $timestamp) {/*{{{*/
+ function lookup_nonce($consumer, $token, $nonce, $timestamp) {
if (dba_exists("nonce_$nonce", $this->dbh)) {
return TRUE;
} else {
dba_insert("nonce_$nonce", "1", $this->dbh);
return FALSE;
}
- }/*}}}*/
+ }
- function new_token($consumer, $type="request") {/*{{{*/
+ function new_token($consumer, $type="request") {
$key = md5(time());
$secret = time() + time();
$token = new OAuthToken($key, md5(md5($secret)));
@@ -756,32 +747,218 @@ function new_token($consumer, $type="request") {/*{{{*/
return NULL;
}
return $token;
- }/*}}}*/
+ }
- function new_request_token($consumer) {/*{{{*/
+ function new_request_token($consumer) {
return $this->new_token($consumer, "request");
- }/*}}}*/
+ }
- function new_access_token($token, $consumer) {/*{{{*/
+ function new_access_token($token, $consumer) {
$token = $this->new_token($consumer, 'access');
dba_delete("request_" . $token->key, $this->dbh);
return $token;
- }/*}}}*/
-}/*}}}*/
-
-class OAuthUtil {/*{{{*/
- function urlencodeRFC3986($string) {/*{{{*/
- return str_replace('%7E', '~', rawurlencode($string));
- }/*}}}*/
-
- function urldecodeRFC3986($string) {/*{{{*/
- return rawurldecode($string);
- }/*}}}*/
-}/*}}}*/
+ }
+}
+
+class OAuthUtil {
+
+ // This function takes a input like a=b&a=c&d=e and returns the parsed
+ // parameters like this
+ // array('a' => array('b','c'), 'd' => 'e')
+ static function parse_parameters( $input ) {
+ if (!isset($input) || !$input) return array();
+
+ $pairs = explode('&', $input);
+
+ $parsed_parameters = array();
+ foreach ($pairs as $pair) {
+ $split = explode('=', $pair, 2);
+ $parameter = OAuthUtil::urldecode_rfc3986($split[0]);
+ $value = isset($split[1]) ? OAuthUtil::urldecode_rfc3986($split[1]) : '';
+
+ if (isset($parsed_parameters[$parameter])) {
+ // We have already recieved parameter(s) with this name, so add to the list
+ // of parameters with this name
+
+ if (is_scalar($parsed_parameters[$parameter])) {
+ // This is the first duplicate, so transform scalar (string) into an array
+ // so we can add the duplicates
+ $parsed_parameters[$parameter] = array($parsed_parameters[$parameter]);
+ }
+
+ $parsed_parameters[$parameter][] = $value;
+ } else {
+ $parsed_parameters[$parameter] = $value;
+ }
+ }
+ return $parsed_parameters;
+ }
+
+ // Utility function for turning the Authorization: header into
+ // parameters, has to do some unescaping
+ // Can filter out any non-oauth parameters if needed (default behaviour)
+ static function split_header($header, $only_allow_oauth_parameters = true) {
+ $pattern = '/(([-_a-z]*)=("([^"]*)"|([^,]*)),?)/';
+ $offset = 0;
+ $params = array();
+ while (preg_match($pattern, $header, $matches, PREG_OFFSET_CAPTURE, $offset) > 0) {
+ $match = $matches[0];
+ $header_name = $matches[2][0];
+ $header_content = (isset($matches[5])) ? $matches[5][0] : $matches[4][0];
+ if (preg_match('/^oauth_/', $header_name) || !$only_allow_oauth_parameters) {
+ $params[$header_name] = OAuthUtil::urldecode_rfc3986($header_content);
+ }
+ $offset = $match[1] + strlen($match[0]);
+ }
+
+ if (isset($params['realm'])) {
+ unset($params['realm']);
+ }
+
+ return $params;
+ }
+
+ // helper to try to sort out headers for people who aren't running apache
+ static function get_headers() {
+ if (function_exists('apache_request_headers')) {
+ // we need this to get the actual Authorization: header
+ // because apache tends to tell us it doesn't exist
+ return apache_request_headers();
+ }
+ // otherwise we don't have apache and are just going to have to hope
+ // that $_SERVER actually contains what we need
+ $out = array();
+ foreach ($_SERVER as $key => $value) {
+ if (substr($key, 0, 5) == "HTTP_") {
+ // this is chaos, basically it is just there to capitalize the first
+ // letter of every word that is not an initial HTTP and strip HTTP
+ // code from przemek
+ $key = str_replace(
+ " ",
+ "-",
+ ucwords(strtolower(str_replace("_", " ", substr($key, 5))))
+ );
+ $out[$key] = $value;
+ }
+ }
+ return $out;
+ }
+
+
+ static function build_http_query($params) {
+ if (!$params) return '';
+
+ // Urlencode both keys and values
+ $keys = OAuthUtil::urlencode_rfc3986(array_keys($params));
+ $values = OAuthUtil::urlencode_rfc3986(array_values($params));
+ $params = array_combine($keys, $values);
+
+ // Parameters are sorted by name, using lexicographical byte value ordering.
+ // Ref: Spec: 9.1.1 (1)
+ uksort($params, 'strcmp');
+
+ $pairs = array();
+ foreach ($params as $parameter => $value) {
+ if (is_array($value)) {
+ // If two or more parameters share the same name, they are sorted by their value
+ // Ref: Spec: 9.1.1 (1)
+ natsort($value);
+ foreach ($value as $duplicate_value) {
+ $pairs[] = $parameter . '=' . $duplicate_value;
+ }
+ } else {
+ $pairs[] = $parameter . '=' . $value;
+ }
+ }
+ // For each parameter, the name is separated from the corresponding value by an '=' character (ASCII code 61)
+ // Each name-value pair is separated by an '&' character (ASCII code 38)
+ return implode('&', $pairs);
+ }
+
+ static function oauth_parse_string($query_string) {
+ if(!isset($query_string)) {
+ return array();
+ }
+ $pairs = explode('&', $query_string);
+ $query_arr = array();
+ foreach($pairs as $pair) {
+ list($k, $v) = explode('=', $pair, 2);
+
+ // Handle duplicate query params
+ if(isset($query_arr[$k])) {
+
+ // Transform scalar to array
+ if(is_scalar($query_arr[$k])) {
+ $query_arr[$k] = array($query_arr[$k]);
+ }
+ $query_arr[$k][] = $v;
+ } else {
+ $query_arr[$k] = $v;
+ }
+ }
+ return $query_arr;
+ }
+
+ static function oauth_http_build_query($params) {
+
+ $out = false;
+ if(!empty($params))
+ {
+ // Urlencode both keys and values
+ $keys = OAuthUtil::urlencode_rfc3986(array_keys($params));
+ $values = OAuthUtil::urlencode_rfc3986(array_values($params));
+ $params = array_combine($keys, $values);
+
+ // Sort by keys (natsort)
+ uksort($params, 'strcmp');
+
+ $pairs = array();
+ foreach ($params as $k => $v) {
+ if (is_array($v)) {
+ natsort($v);
+ foreach ($v as $duplicate_value) {
+ $pairs[] = $k . '=' . $duplicate_value;
+ }
+ } else {
+ $pairs[] = $k . '=' . $v;
+ }
+ }
+ $out = implode('&', $pairs);
+ }
+ return $out;
+ }
+
+ static function urlencode_rfc3986($input) {
+ if (is_array($input)) {
+ return array_map(array('OAuthUtil','urlencode_rfc3986'), $input);
+ } else if (is_scalar($input)) {
+ return str_replace('+', ' ',
+ str_replace('%7E', '~', rawurlencode($input)));
+ } else {
+ return '';
+ }
+ }
+
+ // This decode function isn't taking into consideration the above
+ // modifications to the encoding process. However, this method doesn't
+ // seem to be used anywhere so leaving it as is.
+ static function urldecode_rfc3986($string) {
+ return urldecode($string);
+ }
+
+ static function urlencodeRFC3986($input) {
+ return OAuthUtil::urlencode_rfc3986($input);
+ }
+
+ static function urldecodeRFC3986($input) {
+ return OAuthUtil::urldecode_rfcC3986($input);
+ }
+}
+
/**
- * Crib'd native implementation of hash_hmac() for SHA1 from the
+ * Crib'd native implementation of hash_hmac() for SHA1 from the
* Fire Eagle PHP code:
*
* http://fireeagle.yahoo.net/developer/code/php
@@ -792,7 +969,7 @@ function urldecodeRFC3986($string) {/*{{{*/
function hash_hmac($algo, $data, $key) {
// Thanks, Kellan: http://laughingmeme.org/code/hmacsha1.php.txt
if ($algo != 'sha1') {
- error_log("Internal hash_hmac() can only do sha1, sorry");
+ trigger_error("Internal hash_hmac() can only do sha1, sorry", E_USER_WARNING);
return NULL;
}
@@ -815,5 +992,3 @@ function hash_hmac($algo, $data, $key) {
return $hmac;
}
}
-
-?>
View
222 lib/Yahoo.inc
@@ -1,14 +1,51 @@
<?php
-// Yahoo.inc
-// yos_sdk_php
-//
-// Created by Ryan Kennedy on 6/01/09.
-// Copyright (c) 2009 Yahoo! Inc. All rights reserved.
-//
-// The copyrights embodied in the content of this file are licensed under the BSD (revised) open source license.
-//
-//
+/**
+ * YOS PHP SDK for accessing social and data apis at Yahoo!
+ *
+ * @package yos-php-sdk
+ * @author Yahoo! Developer Network
+ * @example http://developer.yahoo.com/social/sdk/php/
+ *
+ * @copyright Copyright (c) 2009 Yahoo! Inc. All rights reserved.
+ * @license
+ *
+ * The copyrights embodied in the content of this file are licensed under the
+ * BSD (revised) open source license.
+ *
+ * Redistribution and use of this software in source and binary forms, with
+ * or without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * * Redistributions of source code must retain the above
+ * copyright notice, this list of conditions and the
+ * following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the
+ * following disclaimer in the documentation and/or other
+ * materials provided with the distribution.
+ *
+ * * Neither the name of Yahoo! Inc. nor the names of its
+ * contributors may be used to endorse or promote products
+ * derived from this software without specific prior
+ * written permission of Yahoo! Inc.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Please see the Yahoo! Developer Network forums for support: http://developer.yahoo.net/forum/
+ *
+ * Documentation: http://developer.yahoo.com/social/sdk/php/
+ */
// Use OAuthConsumer as a test to see if any other instances of OAuth.php may
// have been included. require_once() won't catch situations where multiple
@@ -582,7 +619,7 @@ class YahooSession {
$GLOBAL_YAHOO_SESSION = new YahooSession($consumer, $accessToken, $applicationId);
}
else if($redirect)
- {
+ {
// TODO: Add redirect counter so this doesn't happen over and over and over when Yahoo! is completely busted.
// The fetch for the access token failed. Generate a new
// request token and try again.
@@ -590,14 +627,14 @@ class YahooSession {
YahooSession::redirectForAuthorization($consumerKey, $consumerSecret, $callback, $sessionStore);
}
else
- {
+ {
// Don't redirect the user, just inform the caller that
// no session is present.
$sessionStore->clearRequestToken();
$GLOBAL_YAHOO_SESSION = NULL;
}
}
- else if($type == YAHOO_YAP_SESSION_TYPE)
+ else if($type == YAHOO_YAP_SESSION_TYPE)
{
// Found a YAP session.
$GLOBAL_YAHOO_SESSION = YahooSession::initSessionFromYAP($consumerKey, $consumerSecret, $applicationId);
@@ -616,7 +653,7 @@ class YahooSession {
* @private
*/
function accessTokenExpired($accessToken, $consumer, $applicationId, $sessionStore)
- {
+ {
global $GLOBAL_YAHOO_SESSION;
$now = time();
@@ -640,7 +677,7 @@ class YahooSession {
$consumer, $newAccessToken, $applicationId);
}
else
- {
+ {
// The access token is expired and we don't have
// a sufficient access session handle to renew
// the access token. Clear the cookie and redirect
@@ -737,21 +774,21 @@ class YahooApplication {
* Executes the given YQL query.
*
* @param $yql The query to execute.
- * @param $env A URL to a YQL environment file.
+ * @param $env A URL to a YQL environment file.
* @return The response or NULL if the request fails..
*/
function query($yql, $env=NULL)
- {
+ {
global $YahooConfig;
- $client = new OAuthClient($this->consumer, $this->token);
+ $client = new OAuthClient($this->consumer, $this->token);
- $request_url = sprintf("http://%s/v1/yql",$YahooConfig["QUERY_WS_HOSTNAME"]);
- $params = array('q' => $yql, 'format' => 'json');
+ $request_url = sprintf("http://%s/v1/yql",$YahooConfig["QUERY_WS_HOSTNAME"]);
+ $params = array('q' => $yql, 'format' => 'json', 'env' => 'http://datatables.org/alltables.env');
- if(!is_null($env)) {
- $params['env'] = $env;
- }
+ if(!is_null($env)) {
+ $params['env'] = $env;
+ }
$response = $client->get($request_url, $params, 30);
@@ -801,7 +838,7 @@ class YahooUser {
$this->sessioned = $sessioned;
}
- /**
+ /**
* Gets the user's status message.
*
* @return The status of the user or NULL if the fetch fails.
@@ -809,8 +846,8 @@ class YahooUser {
function getStatus() {
global $YahooConfig;
- $request_url = sprintf("http://%s/v1/user/%s/profile/status",
- $YahooConfig["SOCIAL_WS_HOSTNAME"],urlencode($this->guid));
+ $request_url = sprintf("http://%s/v1/user/%s/profile/status",
+ $YahooConfig["SOCIAL_WS_HOSTNAME"],urlencode($this->guid));
$response = $this->client->get($request_url);
@@ -822,7 +859,7 @@ class YahooUser {
$status = new stdclass();
$status->message = "";
- $status->lastStatusModified = NULL;
+ $status->lastStatusModified = NULL;
$status->uri = NULL;
return $status;
}
@@ -835,7 +872,7 @@ class YahooUser {
}
}
- /**
+ /**
* Sets the user's status message.
*
* @param $message The new status message for the user.
@@ -849,12 +886,11 @@ class YahooUser {
return NULL;
}
- $message = array("message" => $message);
+ $message = array("message" => $message);
$status = array("status" => $message);
- $status_json = json_encode($status);
+ $status_json = json_encode($status);
- $request_url = sprintf("http://%s/v1/user/%s/profile/status",
- $YahooConfig["SOCIAL_WS_HOSTNAME"], $this->guid);
+ $request_url = sprintf("http://%s/v1/user/%s/profile/status", $YahooConfig["SOCIAL_WS_HOSTNAME"], $this->guid);
$response = $this->client->put($request_url, "application/json", $status_json);
@@ -875,7 +911,7 @@ class YahooUser {
*/
function getUpdates($start = 0, $count = 10) {
$parameters = array("start" => $start, "count" => $count, "transform" => '(sort "pubDate" numeric descending (all))');
- $updates = $this->get_resource("updates", $parameters);
+ $updates = $this->get_resource("updates", $parameters);
return $updates->updates;
}
@@ -889,7 +925,7 @@ class YahooUser {
*/
function getConnectionUpdates($start = 0, $count = 10) {
$parameters = array("start" => $start, "count" => $count, "transform" => '(sort "pubDate" numeric descending (all))');
- $updates = $this->get_resource("updates/connections", $parameters);
+ $updates = $this->get_resource("updates/connections", $parameters);
return $updates->updates;
}
@@ -905,8 +941,7 @@ class YahooUser {
* optional.
* @param $date The date of the update event, optional, defaults to now.
*/
- function insertUpdate($suid, $title, $link, $description="", $date=NULL)
- {
+ function insertUpdate($suid, $title, $link, $description="", $date=NULL) {
global $YahooConfig;
// Make sure this YahooUser is sessioned.
@@ -920,7 +955,7 @@ class YahooUser {
}
// Make sure an application ID was given.
- $appid = $this->session->getApplicationId();
+ $appid = $this->session->getApplicationId();
if(empty($appid)) {
YahooLogger::error("No application ID given, can't insert update");
return NULL;
@@ -928,24 +963,23 @@ class YahooUser {
$source = sprintf("APP.%s", $appid);
- $update = array(
- "collectionID" => $this->guid,
- "collectionType" => "guid",
- "class" => "app",
- "source" => $source,
- "type" => 'appActivity',
- "suid" => $suid,
- "title" => $title,
- "description" => $description,
- "link" => $link,
- "pubDate" => (string)$date
- );
-
- $update_body = array("updates" => array($update));
- $update_body_json = json_encode($update_body);
-
- $request_url = sprintf("http://%s/v1/user/%s/updates/%s/%s",
- $YahooConfig["UPDATES_WS_HOSTNAME"], $this->guid, $source, urlencode($suid));
+ $update = array(
+ "collectionID" => $this->guid,
+ "collectionType" => "guid",
+ "class" => "app",
+ "source" => $source,
+ "type" => 'appActivity',
+ "suid" => $suid,
+ "title" => $title,
+ "description" => $description,
+ "link" => $link,
+ "pubDate" => (string)$date
+ );
+
+ $update_body = array("updates" => array($update));
+ $update_body_json = json_encode($update_body);
+
+ $request_url = sprintf("http://%s/v1/user/%s/updates/%s/%s", $YahooConfig["UPDATES_WS_HOSTNAME"], $this->guid, $source, urlencode($suid));
$response = $this->client->put($request_url, "application/json", $update_body_json);
@@ -974,7 +1008,7 @@ class YahooUser {
}
// Make sure an application ID was given.
- $appid = $this->session->getApplicationId();
+ $appid = $this->session->getApplicationId();
if( empty($appid) ) {
YahooLogger::error("No application ID given, can't delete update");
return FALSE;
@@ -982,8 +1016,7 @@ class YahooUser {
$source = sprintf("APP.%s", $appid);
- $request_url = sprintf("http://%s/v1/user/%s/updates/%s/%s",
- $YahooConfig["UPDATES_WS_HOSTNAME"], $this->guid, $source, urlencode($suid));
+ $request_url = sprintf("http://%s/v1/user/%s/updates/%s/%s", $YahooConfig["UPDATES_WS_HOSTNAME"], $this->guid, $source, urlencode($suid));
$response = $this->client->delete($request_url);
@@ -1002,7 +1035,7 @@ class YahooUser {
function getProfile() {
global $YahooConfig;
- $profile = $this->get_resource("profile");
+ $profile = $this->get_resource("profile");
return $profile->profile;
}
@@ -1018,8 +1051,8 @@ class YahooUser {
function getConnections(&$start, &$count, &$total) {
global $YahooConfig;
- $parameters = array("view" => "usercard", "start" => $start, "count" => $count);
- $connections = $this->get_resource("connections",$parameters);
+ $parameters = array("view" => "usercard", "start" => $start, "count" => $count);
+ $connections = $this->get_resource("connections",$parameters);
$start = $connections->connections->start;
$count = $connections->connections->count;
@@ -1043,8 +1076,8 @@ class YahooUser {
return NULL;
}
- $parameters = array("view" => "tinyusercard", "start" => $start, "count" => $count);
- $contacts = $this->get_resource("contacts",$parameters);
+ $parameters = array("view" => "tinyusercard", "start" => $start, "count" => $count);
+ $contacts = $this->get_resource("contacts",$parameters);
return $contacts;
}
@@ -1067,7 +1100,7 @@ class YahooUser {
global $YahooConfig;
$request_url = sprintf("http://%s/v1/user/%s/%s",
- $YahooConfig["SOCIAL_WS_HOSTNAME"], urlencode($this->guid), $resource);
+ $YahooConfig["SOCIAL_WS_HOSTNAME"], urlencode($this->guid), $resource);
$response = $this->client->get($request_url,$parameters);
@@ -1076,6 +1109,7 @@ class YahooUser {
}
$data = json_decode($response["responseBody"]);
+
return $data;
}
@@ -1083,18 +1117,20 @@ class YahooUser {
// Deprecated methods
///////////////////////////////////////////////////////////////////////////
- /**
+ /**
* Loads the extended profile of the current user.
* @deprecated As of 1.2, replaced by getProfile.
* @return The extended profile of the current user.
*/
function loadProfile() {
+
// method renamed, keeping for compatibility.
YahooLogger::info("loadProfile is deprecated since 1.2: Please use getProfile");
+
return $this->getProfile();
}
- /**
+ /**
* Lists the updates for the current user.
* @deprecated As of 1.2, replaced by getUpdates.
*
@@ -1104,13 +1140,14 @@ class YahooUser {
* @return A list of updates for the current user.
*/
function listUpdates($start = 0, $count = 10) {
+
// method renamed, keeping for compatibility.
YahooLogger::info("listUpdates is deprecated since 1.2: Please use getUpdates");
return $this->getUpdates($start, $count);
}
- /**
+ /**
* Gets the updates for the connections of the current user.
* @deprecated As of 1.2, replaced by getConnectionUpdates.
* @param $start The starting offset to list updates from.
@@ -1133,10 +1170,10 @@ class YahooUser {
function getPresence() {
global $YahooConfig;
- YahooLogger::info("getPresence is deprecated since 1.2: Please use getStatus.");
+ YahooLogger::info("getPresence is deprecated since 1.2: Please use getStatus.");
- $request_url = sprintf("http://%s/v1/user/%s/presence/presence",
- $YahooConfig["PRESENCE_WS_HOSTNAME"],urlencode($this->guid));
+ $request_url = sprintf("http://%s/v1/user/%s/presence/presence",
+ $YahooConfig["PRESENCE_WS_HOSTNAME"],urlencode($this->guid));
$response = $this->client->get($request_url);
@@ -1169,7 +1206,7 @@ class YahooUser {
function setPresence($status) {
global $YahooConfig;
- YahooLogger::info("setPresence is deprecated since 1.2: Please use setStatus");
+ YahooLogger::info("setPresence is deprecated since 1.2: Please use setStatus");
if(!$this->sessioned) {
YahooLogger::error("Can't set the presence of an unsessioned user");
@@ -1177,10 +1214,9 @@ class YahooUser {
}
$presence = array("status" => $status);
- $presence_json = json_encode($presence);
+ $presence_json = json_encode($presence);
- $request_url = sprintf("http://%s/v1/user/%s/presence/presence",
- $YahooConfig["PRESENCE_WS_HOSTNAME"], $this->guid);
+ $request_url = sprintf("http://%s/v1/user/%s/presence/presence", $YahooConfig["PRESENCE_WS_HOSTNAME"], $this->guid);
$response = $this->client->put($request_url, "application/json", $presence_json);
@@ -1212,7 +1248,7 @@ class YahooAuthorization {
$client = new OAuthClient($consumer, NULL, OAUTH_PARAMS_IN_POST_BODY, OAUTH_SIGNATURE_HMAC_SHA1);
$request_url = sprintf("https://%s/oauth/v2/get_request_token", $YahooConfig["OAUTH_HOSTNAME"]);
- $parameters = array("oauth_callback" => $callback);
+ $parameters = array("oauth_callback" => $callback);
$response = $client->post($request_url, "application/x-www-form-urlencoded", $parameters);
@@ -1254,8 +1290,7 @@ class YahooAuthorization {
return sprintf("https://%s/oauth/v2/request_auth?oauth_token=%s", $YahooConfig["OAUTH_HOSTNAME"], urlencode($requestToken->key));
}
- function getAccessToken($consumerKey, $consumerSecret, $requestToken, $verifier)
- {
+ function getAccessToken($consumerKey, $consumerSecret, $requestToken, $verifier) {
$at = YahooAuthorization::getAccessTokenProxy($consumerKey, $consumerSecret, $requestToken, $verifier);
if(is_null($at)) {
@@ -1269,8 +1304,7 @@ class YahooAuthorization {
return $at;
}
- function getAccessTokenProxy($consumerKey, $consumerSecret, $requestToken, $verifier)
- {
+ function getAccessTokenProxy($consumerKey, $consumerSecret, $requestToken, $verifier) {
global $YahooConfig;
$request_url = sprintf("https://%s/oauth/v2/get_token", $YahooConfig["OAUTH_HOSTNAME"]);
@@ -1350,8 +1384,7 @@ class CookieSessionStore {
* @return True if a request token is present, false otherwise.
*/
function hasRequestToken() {
- return array_key_exists("yosdk_rt", $_COOKIE) &&
- (strlen($_COOKIE["yosdk_rt"]) > 0);
+ return array_key_exists("yosdk_rt", $_COOKIE) && (strlen($_COOKIE["yosdk_rt"]) > 0);
}
/**
@@ -1360,8 +1393,7 @@ class CookieSessionStore {
* @return True if an access token is present, false otherwise.
*/
function hasAccessToken() {
- return array_key_exists("yosdk_at", $_COOKIE) &&
- (strlen($_COOKIE["yosdk_at"]) > 0);
+ return array_key_exists("yosdk_at", $_COOKIE) && (strlen($_COOKIE["yosdk_at"]) > 0);
}
/**
@@ -1373,8 +1405,7 @@ class CookieSessionStore {
*/
function storeRequestToken($token) {
if(!headers_sent()) {
- return setcookie("yosdk_rt", base64_encode(json_encode($token)),
- time() + 600);
+ return setcookie("yosdk_rt", base64_encode(json_encode($token)), time() + 600);
}
else {
return false;
@@ -1479,8 +1510,7 @@ class NativeSessionStore {
/**
* Stores the given request token in the session store.
*
- * @param $token A PHP stdclass object containing the components of
- * the OAuth request token.
+ * @param $token A PHP stdclass object containing the components of the OAuth request token.
*/
function storeRequestToken($token) {
$_SESSION['yosdk_rt'] = json_encode($token);
@@ -1506,8 +1536,7 @@ class NativeSessionStore {
/**
* Stores the given access token in the session store.
*
- * @param $token A PHP stdclass object containing the components of
- * the OAuth access token.
+ * @param $token A PHP stdclass object containing the components of the OAuth access token.
*/
function storeAccessToken($token) {
$_SESSION['yosdk_at'] = json_encode($token);
@@ -1562,9 +1591,9 @@ class OAuthClient {
*/
var $signatureMethod = NULL;
- /**
- * @private
- */
+ /**
+ * @private
+ */
var $accepts = "application/json";
/**
@@ -1575,9 +1604,7 @@ class OAuthClient {
* @param $oauthParamsLocation OAUTH_PARAMS_IN_HEADERS or OAUTH_PARAMS_IN_POST_BODY, depending on where you want the OAuth parameters to show up. Optional, defaults to using the headers.
* @param $signatureMethod OAUTH_SIGNATURE_PLAINTEXT or OAUTH_SIGNATURE_HMAC_SHA1, depending on what request signing mechanism to use. Optional, defaults to HMAC SHA1 signatures.
*/
- function OAuthClient($consumer, $token = NULL,
- $oauthParamsLocation = OAUTH_PARAMS_IN_HEADERS,
- $signatureMethod = OAUTH_SIGNATURE_HMAC_SHA1) {
+ function OAuthClient($consumer, $token = NULL, $oauthParamsLocation = OAUTH_PARAMS_IN_HEADERS, $signatureMethod = OAUTH_SIGNATURE_HMAC_SHA1) {
$this->consumer = $consumer;
$this->token = $token;
$this->oauthParamsLocation = $oauthParamsLocation;
@@ -1713,7 +1740,7 @@ class OAuthClient {
}
$requestTimeout = array_key_exists("timeout", $request) ?
- $request["timeout"] : $this->defaultTimeout;
+ $request["timeout"] : $this->defaultTimeout;
$ch = curl_init($requestUrl);
curl_setopt($ch, CURLOPT_TIMEOUT, $requestTimeout);
@@ -1877,9 +1904,8 @@ function oauth_http_build_query($parameters) {
}
/**
- * PHP Compatibility functions
+ * PHP4/5 compatibility functions
*/
-
if(!function_exists("property_exists")) {
function property_exists( $class, $property ) {
if ( is_object( $class ) ) {
@@ -1912,5 +1938,3 @@ if(!function_exists("json_decode")) {
return $js->encode($value);
}
}
-
-?>
View
69 lib/YahooSessionStore.inc
@@ -1,20 +1,59 @@
<?php
-//
-// YahooSessionStore.inc
-// yos_sdk_php
-//
-// Created by Ryan Kennedy on 6/01/09.
-// Copyright (c) 2009 Yahoo! Inc. All rights reserved.
-//
-// The copyrights embodied in the content of this file are licensed under the BSD (revised) open source license.
-//
-//
+
+/**
+ * YOS PHP SDK for accessing social and data apis at Yahoo!
+ *
+ * YahooSessionStore provides an interface for implementing session storage backends.
+ *
+ * @package yos-php-sdk
+ * @author Yahoo! Developer Network
+ * @example http://developer.yahoo.com/social/sdk/php/
+ *
+ * @copyright Copyright (c) 2009 Yahoo! Inc. All rights reserved.
+ * @license
+ *
+ * The copyrights embodied in the content of this file are licensed under the
+ * BSD (revised) open source license.
+ *
+ * Redistribution and use of this software in source and binary forms, with
+ * or without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * * Redistributions of source code must retain the above
+ * copyright notice, this list of conditions and the
+ * following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the
+ * following disclaimer in the documentation and/or other
+ * materials provided with the distribution.
+ *
+ * * Neither the name of Yahoo! Inc. nor the names of its
+ * contributors may be used to endorse or promote products
+ * derived from this software without specific prior
+ * written permission of Yahoo! Inc.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Please see the Yahoo! Developer Network forums for support: http://developer.yahoo.net/forum/
+ *
+ * Documentation: http://developer.yahoo.com/social/sdk/php/
+ */
/**
- * The session store interface. Developers are free to implement their
+ * The session store interface. Developers are free to implement their
* own session store implementations and pass them to YahooSession::hasSession,
- * YahooSession::requireSession and YahooSession::clearSession.
+ * YahooSession::requireSession and YahooSession::clearSession.
*
* @brief The session store interface.
*/
@@ -36,7 +75,7 @@ interface YahooSessionStore {
/**
* Stores the given request token in the session store.
*
- * @param $token A PHP stdclass object containing the components of
+ * @param $token A PHP stdclass object containing the components of
* the OAuth request token.
* @return True on success, false otherwise.
*/
@@ -59,7 +98,7 @@ interface YahooSessionStore {
/**
* Stores the given access token in the session store.
*
- * @param $token A PHP stdclass object containing the components of
+ * @param $token A PHP stdclass object containing the components of
* the OAuth access token.
* @return True on success, false otherwise.
*/
@@ -79,5 +118,3 @@ interface YahooSessionStore {
*/
function clearAccessToken(){}
}
-
-?>
View
9 sample/delicious.php
@@ -24,9 +24,10 @@
// Make sure you obtain application keys before continuing by visiting:
// https://developer.yahoo.com/dashboard/createKey.html
-$consumerKey = '###';
-$consumerKeySecret = '###';
-$applicationId = '###';
+// create a Yahoo! Open Application - http://developer.yahoo.com/dashboard
+$consumerKey = 'dj0yJmk9WUxPUkhFUWxISWpvJmQ9WVdrOWFYWmhTVzVDTXpBbWNHbzlNVGt4TmpJNU1EazROdy0tJnM9Y29uc3VtZXJzZWNyZXQmeD01Ng--';
+$consumerKeySecret = 'f893cf549be5cb37f83b1414e2ff212df2ea4c18';
+$applicationId = 'ivaInB30';
// oauth dance if not authenticated
$session = YahooSession::requireSession($consumerKey, $consumerKeySecret, $applicationId);
@@ -42,7 +43,7 @@
if(is_object($user))
{
// load y! profile data
- $profile = $user->loadProfile();
+ $profile = $user->getProfile();
// get yap app instance for yql / small view
$application = new YahooApplication($consumerKey, $consumerKeySecret);
View
20 sample/sampleapp.php
@@ -17,14 +17,9 @@
// Make sure you obtain application keys before continuing by visiting:
// https://developer.yahoo.com/dashboard/createKey.html
-// Your consumer key goes here.
-define("CONSUMER_KEY","###");
-
-// Your consumer key secret goes here.
-define("CONSUMER_SECRET","###");
-
-// Your application ID goes here.
-define("APP_ID","###");
+define("CONSUMER_KEY", "dj0yJmk9WUxPUkhFUWxISWpvJmQ9WVdrOWFYWmhTVzVDTXpBbWNHbzlNVGt4TmpJNU1EazROdy0tJnM9Y29uc3VtZXJzZWNyZXQmeD01Ng--");
+define("CONSUMER_SECRET", "f893cf549be5cb37f83b1414e2ff212df2ea4c18");
+define("APP_ID", "ivaInB30");
if(array_key_exists("logout", $_GET)) {
// if a session exists and the logout flag is detected
@@ -95,19 +90,16 @@ function close_popup() {
if($hasSession == FALSE) {
// if a session does not exist, output the
// login / share button linked to the auth_url.
- echo sprintf("<a href=\"%s\" id=\"yloginLink\"><img src=\"http://l.yimg.com/a/i/ydn/social/updt-spurp.png\"></a>\n",
- $auth_url);
+ echo sprintf("<a href=\"%s\" id=\"yloginLink\"><img src=\"http://l.yimg.com/a/i/ydn/social/updt-spurp.png\"></a>\n", $auth_url);
}
else if($hasSession && $profile) {
// if a session does exist and the profile data was
// fetched without error, print out a simple usercard.
- echo sprintf("<img src=\"%s\"/><p><h2>Hi <a href=\"%s\" target=\"_blank\">%s!</a></h2></p>\n",
- $profile->image->imageUrl, $profile->profileUrl, $profile->nickname);
+ echo sprintf("<img src=\"%s\"/><p><h2>Hi <a href=\"%s\" target=\"_blank\">%s!</a></h2></p>\n", $profile->image->imageUrl, $profile->profileUrl, $profile->nickname);
if($profile->status->message != "") {
$statusDate = date('F j, y, g:i a', strtotime($profile->status->lastStatusModified));
- echo sprintf("<p><strong>&#8220;</strong>%s<strong>&#8221;</strong> on %s</p>",
- $profile->status->message, $statusDate);
+ echo sprintf("<p><strong>&#8220;</strong>%s<strong>&#8221;</strong> on %s</p>", $profile->status->message, $statusDate);
}
echo "<p><a href=\"?logout\">Logout</a></p>";
View
42 test/OAuthTest.php
@@ -0,0 +1,42 @@
+<?php
+
+if (!defined('PHPUnit_MAIN_METHOD')) {
+ define('PHPUnit_MAIN_METHOD', 'AllTests::main');
+}
+
+require_once 'PHPUnit/Framework.php';
+require_once 'PHPUnit/TextUI/TestRunner.php';
+
+require_once dirname(__FILE__).'/unit/oauth/OAuthConsumerTest.php';
+require_once dirname(__FILE__).'/unit/oauth/OAuthRequestTest.php';
+require_once dirname(__FILE__).'/unit/oauth/OAuthSignatureMethodHmacSha1Test.php';
+require_once dirname(__FILE__).'/unit/oauth/OAuthSignatureMethodRsaSha1Test.php';
+require_once dirname(__FILE__).'/unit/oauth/OAuthTokenTest.php';
+require_once dirname(__FILE__).'/unit/oauth/OAuthUtilTest.php';
+
+class AllTests
+{
+
+ public static function main()
+ {
+ PHPUnit_TextUI_TestRunner::run(self::suite());
+ }
+
+ public static function suite()
+ {
+ $suite = new PHPUnit_Framework_TestSuite();
+
+ $suite->addTestSuite('OAuthConsumerTest');
+ $suite->addTestSuite('OAuthRequestTest');
+ $suite->addTestSuite('OAuthSignatureMethodHmacSha1Test');
+ $suite->addTestSuite('OAuthSignatureMethodRsaSha1Test');
+ $suite->addTestSuite('OAuthTokenTest');
+ $suite->addTestSuite('OAuthUtilTest');
+
+ return $suite;
+ }
+}
+
+if (PHPUnit_MAIN_METHOD == 'AllTests::main') {
+ AllTests::main();
+}
View
12 test/unit/oauth/Mock_OAuthBaseStringRequest.php
@@ -0,0 +1,12 @@
+<?php
+
+/**
+ * A very simple class that you can pass a base-string, and then have it returned again.
+ * Used for testing the signature-methods
+ */
+class Mock_OAuthBaseStringRequest {
+ private $provided_base_string;
+ public $base_string; // legacy
+ public function __construct($bs) { $this->provided_base_string = $bs; }
+ public function get_signature_base_string() { return $this->provided_base_string; }
+}
View
57