Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Here we go, first commit

commit 5918e13a8da15af460abe911b58daaff6695296e 0 parents
@themattharris authored
202 LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
23 README.md
@@ -0,0 +1,23 @@
+# tmhOAuth
+
+An OAuth 1.0A library written in PHP by @themattharris
+
+**Disclaimer**: This project is a work in progress and may contain bugs.
+
+## Goals
+
+- Support OAuth 1.0A
+- Use Authorisation headers instead of query string or POST parameters
+- Allow uploading of images
+- Provide enough information to assist with debugging
+
+## Using
+
+This will be built out later but for the moment review the examples for ways
+the library can be used.
+
+## Community
+
+License: Apache 2 (see included LICENSE file)
+
+Follow me Twitter <http://twitter.com/themattharris>
65 examples/auth.php
@@ -0,0 +1,65 @@
+<?php
+
+require '../tmhOAuth.php';
+
+$tmhOAuth = new tmhOAuth(array(
+ 'consumer_key' => '',
+ 'consumer_secret' => '',
+));
+
+$here = $tmhOAuth->php_self();
+session_start();
+
+// reset?
+if ( isset($_REQUEST['wipe'])) {
+ session_destroy();
+ header("Location: {$here}");
+
+// already got some credentials stored?
+} elseif ( isset($_SESSION['access_token']) ) {
+ $tmhOAuth->config['user_token'] = $_SESSION['access_token']['oauth_token'];
+ $tmhOAuth->config['user_secret'] = $_SESSION['access_token']['oauth_token_secret'];
+
+ $tmhOAuth->request('GET', $tmhOAuth->url('account/verify_credentials'));
+ $tmhOAuth->pr(json_decode($tmhOAuth->response['response']));
+
+// we're being called back by Twitter
+} elseif (isset($_REQUEST['oauth_verifier'])) {
+ $tmhOAuth->config['user_token'] = $_SESSION['oauth']['oauth_token'];
+ $tmhOAuth->config['user_secret'] = $_SESSION['oauth']['oauth_token_secret'];
+
+ $tmhOAuth->request('POST', "{$tmhOAuth->config['host']}/oauth/access_token", array(
+ 'oauth_verifier' => $_REQUEST['oauth_verifier']
+ ));
+ $_SESSION['access_token'] = $tmhOAuth->extract_params($tmhOAuth->response['response']);
+ unset($_SESSION['oauth']);
+ header("Location: {$here}");
+
+// start the OAuth dance
+} elseif ( isset($_REQUEST['signin']) || isset($_REQUEST['allow']) ) {
+ $callback = isset($_REQUEST['oob']) ? 'oob' : $here;
+
+ $tmhOAuth->request('POST', "{$tmhOAuth->config['host']}/oauth/request_token", array(
+ 'oauth_callback' => $callback
+ ));
+
+ if ($tmhOAuth->response['code'] == 200) {
+ $_SESSION['oauth'] = $tmhOAuth->extract_params($tmhOAuth->response['response']);
+ $method = isset($_REQUEST['signin']) ? 'authenticate' : 'authorize';
+ $force = isset($_REQUEST['force']) ? '&force_login=1' : '';
+ header("Location: {$tmhOAuth->config['host']}/oauth/{$method}?oauth_token={$_SESSION['oauth']['oauth_token']}{$force}");
+
+ } else {
+ // error
+ $tmhOAuth->pr(htmlentities($tmhOAuth->response['response']));
+ }
+}
+
+?>
+<ul>
+ <li><a href="?signin=1">Sign in with Twitter</a></li>
+ <li><a href="?signin=1&amp;force=1">Sign in with Twitter (force)</a></li>
+ <li><a href="?allow=1">Allow Application (callback)</a></li>
+ <li><a href="?allow=1&amp;oob=1">Allow Application (oob)</a></li>
+ <li><a href="?wipe=1">Start Over</a></li>
+</ul>
38 examples/images.php
@@ -0,0 +1,38 @@
+<?php
+
+require '../tmhOAuth.php';
+
+if ( ! empty($_FILES)) {
+ $tmhOAuth = new tmhOAuth(array(
+ 'consumer_key' => '',
+ 'consumer_secret' => '',
+ 'user_token' => '',
+ 'user_secret' => '',
+ ));
+
+ $tmhOAuth->request('POST', $tmhOAuth->url("account/{$_POST['method']}"), array(
+ 'image' => "@{$_FILES['image']['tmp_name']};type={$_FILES['image']['type']}",
+ 'include_entities' => '1'
+ ),
+ true, // use auth
+ true // multipart
+ );
+
+ if ($tmhOAuth->response['code'] == 200) {
+ $tmhOAuth->pr(json_decode($tmhOAuth->response['response']));
+ }
+ $tmhOAuth->pr(htmlentities($tmhOAuth->response['response']));
+}
+
+?>
+
+<form action="" method="POST" enctype="multipart/form-data">
+ <div>
+ <select name="method" id="method" >
+ <option value="update_profile_image">update_profile_image</option>
+ <option value="update_profile_background_image">update_profile_background_image</option>
+ </select>
+ <input type="file" name="image" />
+ <input type="submit" value="Submit" />
+ </div>
+</form>
20 examples/rss.php
@@ -0,0 +1,20 @@
+<?php
+
+require '../tmhOAuth.php';
+$tmhOAuth = new tmhOAuth(array(
+ 'consumer_key' => '',
+ 'consumer_secret' => '',
+ 'user_token' => '',
+ 'user_secret' => '',
+));
+
+$tmhOAuth->request('GET', $tmhOAuth->url('statuses/home_timeline', 'rss'));
+
+if ($tmhOAuth->response['code'] == 200) {
+ header('Content-Type: application/rss+xml; charset=utf-8');
+ echo $tmhOAuth->response['response'];
+} else {
+ $tmhOAuth->pr(htmlentities($tmhOAuth->response['response']));
+}
+
+?>
21 examples/tweet.php
@@ -0,0 +1,21 @@
+<?php
+
+require '../tmhOAuth.php';
+$tmhOAuth = new tmhOAuth(array(
+ 'consumer_key' => '',
+ 'consumer_secret' => '',
+ 'user_token' => '',
+ 'user_secret' => '',
+));
+
+$tmhOAuth->request('POST', $tmhOAuth->url('statuses/update'), array(
+ 'status' => 'Hanging out at the big eye café then heading -->> to meet some friends.'
+));
+
+if ($tmhOAuth->response['code'] == 200) {
+ $tmhOAuth->pr(json_decode($tmhOAuth->response['response']));
+} else {
+ $tmhOAuth->pr(htmlentities($tmhOAuth->response['response']));
+}
+
+?>
19 examples/verify.php
@@ -0,0 +1,19 @@
+<?php
+
+require '../tmhOAuth.php';
+$tmhOAuth = new tmhOAuth(array(
+ 'consumer_key' => '',
+ 'consumer_secret' => '',
+ 'user_token' => '',
+ 'user_secret' => '',
+));
+
+$tmhOAuth->request('GET', $tmhOAuth->url('account/verify_credentials'));
+
+if ($tmhOAuth->response['code'] == 200) {
+ $tmhOAuth->pr(json_decode($tmhOAuth->response['response']));
+} else {
+ $tmhOAuth->pr(htmlentities($tmhOAuth->response['response']));
+}
+
+?>
24 examples/xauth.php
@@ -0,0 +1,24 @@
+<?php
+
+require '../tmhOAuth.php';
+$tmhOAuth = new tmhOAuth(array(
+ 'consumer_key' => '',
+ 'consumer_secret' => '',
+ 'user_token' => '',
+ 'user_secret' => '',
+));
+
+$tmhOAuth->request('POST', "https://api.twitter.com/oauth/access_token", array(
+ 'x_auth_username' => '',
+ 'x_auth_password' => '',
+ 'x_auth_mode' => 'client_auth'
+));
+
+if ($tmhOAuth->response['code'] == 200) {
+ $tokens = $tmhOAuth->extract_params($tmhOAuth->response['response']);
+ $tmhOAuth->pr($tokens);
+} else {
+ $tmhOAuth->pr(htmlentities($tmhOAuth->response['response']));
+}
+
+?>
497 tmhOAuth.php
@@ -0,0 +1,497 @@
+<?php
+/**
+ * tmhOAuth
+ *
+ * An OAuth 1.0A library written in PHP.
+ * The library supports file uploading using multipart/form as well as general
+ * REST requests. OAuth authentication is sent using the an Authorization Header.
+ *
+ * @author themattharris
+ * @version 0.1
+ *
+ * 26 August 2010
+ */
+class tmhOAuth {
+ /**
+ * Creates a new tmhOAuth object
+ *
+ * @param string $config, the configuration to use for this request
+ */
+ function __construct($config) {
+ $this->params = array();
+
+ // default configuration options
+ $this->config = array_merge(
+ array(
+ 'consumer_key' => '',
+ 'consumer_secret' => '',
+ 'user_token' => '',
+ 'user_secret' => '',
+ 'host' => 'http://api.twitter.com',
+ 'v' => '1',
+ 'debug' => false,
+ 'force_nonce' => false,
+ 'nonce' => false, // used for checking signatures. leave as false for auto
+ 'force_timestamp' => false,
+ 'timestamp' => false, // used for checking signatures. leave as false for auto
+ 'oauth_version' => '1.0'
+ ),
+ $config
+ );
+ }
+
+ /**
+ * Generates a random OAuth nonce.
+ * If 'force_nonce' is true a nonce is not generated and the value in the configuration will be retained.
+ *
+ * @param string $length how many characters the nonce should be before MD5 hashing. default 12
+ * @param string $include_time whether to include time at the beginning of the nonce. default true
+ * @return void
+ */
+ private function create_nonce($length=12, $include_time=true) {
+ if ($this->config['force_nonce'] == false) {
+ $sequence = array_merge(range(0,9), range('A','Z'), range('a','z'));
+ $length = $length > count($sequence) ? count($sequence) : $length;
+ shuffle($sequence);
+ $this->config['nonce'] = md5(substr(microtime() . implode($sequence), 0, $length));
+ }
+ }
+
+ /**
+ * Generates a timestamp.
+ * If 'force_timestamp' is true a nonce is not generated and the value in the configuration will be retained.
+ *
+ * @return void
+ */
+ private function create_timestamp() {
+ $this->config['timestamp'] = ($this->config['force_timestamp'] == false ? time() : $this->config['timestamp']);
+ }
+
+ /**
+ * Encodes the string or array passed in a way compatible with OAuth.
+ * If an array is passed each array value will will be encoded.
+ *
+ * @param mixed $data the scalar or array to encode
+ * @return $data encoded in a way compatible with OAuth
+ */
+ private function safe_encode($data) {
+ if (is_array($data)) {
+ return array_map(array($this, 'safe_encode'), $data);
+ } else if (is_scalar($data)) {
+ return str_ireplace(
+ array('+', '%7E'),
+ array(' ', '~'),
+ rawurlencode($data)
+ );
+ } else {
+ return '';
+ }
+ }
+
+ /**
+ * Decodes the string or array from it's URL encoded form
+ * If an array is passed each array value will will be decoded.
+ *
+ * @param mixed $data the scalar or array to decode
+ * @return $data decoded from the URL encoded form
+ */
+ private function safe_decode($data) {
+ if (is_array($data)) {
+ return array_map(array($this, 'safe_decode'), $data);
+ } else if (is_scalar($data)) {
+ return rawurldecode($data);
+ } else {
+ return '';
+ }
+ }
+
+ /**
+ * Returns an array of the standard OAuth parameters.
+ *
+ * @return array all required OAuth parameters, safely encoded
+ */
+ private function get_defaults() {
+ $defaults = array(
+ 'oauth_version' => $this->config['oauth_version'],
+ 'oauth_nonce' => $this->config['nonce'],
+ 'oauth_timestamp' => $this->config['timestamp'],
+ 'oauth_consumer_key' => $this->config['consumer_key'],
+ 'oauth_signature_method' => 'HMAC-SHA1',
+ );
+
+ // include the user token if it exists
+ if ( $this->config['user_token'] )
+ $defaults['oauth_token'] = $this->config['user_token'];
+
+ // safely encode
+ foreach ($defaults as $k => $v) {
+ $_defaults[$this->safe_encode($k)] = $this->safe_encode($v);
+ }
+
+ return $_defaults;
+ }
+
+ /**
+ * Extracts and decodes OAuth parameters from the passed string
+ *
+ * @param string $body the response body from an OAuth flow method
+ * @return array the response body safely decoded to an array of key => values
+ */
+ function extract_params($body) {
+ $kvs = explode('&', $body);
+ $decoded = array();
+ foreach ($kvs as $kv) {
+ $kv = explode('=', $kv, 2);
+ $kv[0] = $this->safe_decode($kv[0]);
+ $kv[1] = $this->safe_decode($kv[1]);
+ $decoded[$kv[0]] = $kv[1];
+ }
+ return $decoded;
+ }
+
+ /**
+ * Prepares the HTTP method for use in the base string by converting it to
+ * uppercase.
+ *
+ * @param string $method an HTTP method such as GET or POST
+ * @return void value is stored to a class variable
+ * @author Matt Harris
+ */
+ private function prepare_method($method) {
+ $this->method = strtoupper($method);
+ }
+
+ /**
+ * Prepares the URL for use in the base string by ripping it apart and
+ * reconstructing it.
+ *
+ * @param string $url the request URL
+ * @return void value is stored to a class variable
+ * @author Matt Harris
+ */
+ private function prepare_url($url) {
+ $parts = parse_url($url);
+
+ $port = @$parts['port'];
+ $scheme = $parts['scheme'];
+ $host = $parts['host'];
+ $path = @$parts['path'];
+
+ $port or $port = ($scheme == 'https') ? '443' : '80';
+
+ if (($scheme == 'https' && $port != '443')
+ || ($scheme == 'http' && $port != '80')) {
+ $host = "$host:$port";
+ }
+ $this->url = "$scheme://$host$path";
+ }
+
+ /**
+ * Prepares all parameters for the base string and request.
+ * Multipart parameters are ignored as they are not defined in the specification,
+ * all other types of parameter are encoded for compatibility with OAuth.
+ *
+ * @param array $params the parameters for the request
+ * @return void prepared values are stored in class variables
+ */
+ private function prepare_params($params) {
+ // do not encode multipart parameters, leave them alone
+ if ($this->config['multipart']) {
+ $this->request_params = $params;
+ $params = array();
+ }
+
+ // signing parameters are request parameters + OAuth default parameters
+ $this->signing_params = array_merge($this->get_defaults(), (array)$params);
+
+ // Remove oauth_signature if present
+ // Ref: Spec: 9.1.1 ("The oauth_signature parameter MUST be excluded.")
+ if (isset($this->signing_params['oauth_signature'])) {
+ unset($this->signing_params['oauth_signature']);
+ }
+
+ // Parameters are sorted by name, using lexicographical byte value ordering.
+ // Ref: Spec: 9.1.1 (1)
+ uksort($this->signing_params, 'strcmp');
+
+ // encode. Also sort the signed parameters from the POST parameters
+ foreach ($this->signing_params as $k => $v) {
+ $k = $this->safe_encode($k);
+ $v = $this->safe_encode($v);
+ $_signing_params[$k] = $v;
+ $kv[] = "{$k}={$v}";
+ }
+
+ // auth params = the default oauth params which are present in our collection of signing params
+ $this->auth_params = array_intersect_key($this->get_defaults(), $_signing_params);
+ if (isset($_signing_params['oauth_callback'])) {
+ $this->auth_params['oauth_callback'] = $_signing_params['oauth_callback'];
+ unset($_signing_params['oauth_callback']);
+ }
+
+ // request_params is already set if we're doing multipart, if not we need to set them now
+ if ( ! $this->config['multipart'])
+ $this->request_params = array_diff_key($_signing_params, $this->get_defaults());
+
+ // create the parameter part of the base string
+ $this->signing_params = implode('&', $kv);
+ }
+
+ /**
+ * Prepares the OAuth signing key
+ *
+ * @return void prepared signing key is stored in a class variables
+ */
+ private function prepare_signing_key() {
+ $this->signing_key = $this->safe_encode($this->config['consumer_secret']) . '&' . $this->safe_encode($this->config['user_secret']);
+ }
+
+ /**
+ * Prepare the base string.
+ * Ref: Spec: 9.1.3 ("Concatenate Request Elements")
+ *
+ * @return void prepared base string is stored in a class variables
+ */
+ private function prepare_base_string() {
+ $base = array(
+ $this->method,
+ $this->url,
+ $this->signing_params
+ );
+ $this->base_string = implode('&', $this->safe_encode($base));
+ }
+
+ /**
+ * Prepares the Authorization header
+ *
+ * @return void prepared authorization header is stored in a class variables
+ */
+ private function prepare_auth_header() {
+ $this->headers = array();
+ uksort($this->auth_params, 'strcmp');
+ foreach ($this->auth_params as $k => $v) {
+ $kv[] = "{$k}=\"{$v}\"";
+ }
+ $this->auth_header = 'Authorization: OAuth ' . implode(', ', $kv);
+ $this->headers[] = $this->auth_header;
+ }
+
+ /**
+ * Signs the request and adds the OAuth signature. This runs all the request
+ * parameter preparation methods.
+ *
+ * @param string $method the HTTP method being used. e.g. POST, GET, HEAD etc
+ * @param string $url the request URL without query string parameters
+ * @param array $params the request parameters as an array of key=value pairs
+ * @param string $useauth whether to use authentication when making the request.
+ */
+ private function sign($method, $url, $params, $useauth) {
+ $this->prepare_method($method);
+ $this->prepare_url($url);
+ $this->prepare_params($params);
+
+ // we don't sign anything is we're not using auth
+ if ($useauth) {
+ $this->prepare_base_string();
+ $this->prepare_signing_key();
+
+ $this->auth_params['oauth_signature'] = $this->safe_encode(
+ base64_encode(
+ hash_hmac(
+ 'sha1', $this->base_string, $this->signing_key, true
+ )));
+
+ $this->prepare_auth_header();
+ }
+ }
+
+ /**
+ * Make an HTTP request using this library. This method doesn't return anything.
+ * Instead the response should be inspected directly.
+ *
+ * @param string $method the HTTP method being used. e.g. POST, GET, HEAD etc
+ * @param string $url the request URL without query string parameters
+ * @param array $params the request parameters as an array of key=value pairs
+ * @param string $useauth whether to use authentication when making the request. Default true.
+ * @param string $multipart whether this request contains multipart data. Default false
+ * @author Matt Harris
+ */
+ function request($method, $url, $params=array(), $useauth=true, $multipart=false) {
+ $this->config['multipart'] = $multipart;
+
+ $this->create_nonce();
+ $this->create_timestamp();
+
+ $this->sign($method, $url, $params, $useauth);
+ $this->curlit($multipart);
+ }
+
+ /**
+ * Utility function to create the request URL in the requested format
+ *
+ * @param string $request the API method without extension
+ * @param string $format the format of the response. Default json. Set to an empty string to exclude the format
+ * @return string the concatenation of the host, API version, API method and format
+ */
+ function url($request, $format='json') {
+ $format = strlen($format) > 0 ? ".$format" : '';
+ return implode('/', array(
+ $this->config['host'],
+ $this->config['v'],
+ $request . $format
+ ));
+ }
+
+ /**
+ * Utility function to parse the returned curl headers and store them in the
+ * class array variable.
+ *
+ * @param object $ch curl handle
+ * @param string $header the response headers
+ * @return the string length of the header
+ */
+ private function curlHeader($ch, $header) {
+ $i = strpos($header, ':');
+ if ( ! empty($i) ) {
+ $key = str_replace('-', '_', strtolower(substr($header, 0, $i)));
+ $value = trim(substr($header, $i + 2));
+ $this->response['headers'][$key] = $value;
+ }
+ return strlen($header);
+ }
+
+ /**
+ * Makes a curl request. Takes no parameters as all should have been prepared
+ * by the request method
+ *
+ * @return void response data is stored in the class variable 'response'
+ */
+ private function curlit() {
+ if (@$this->config['prevent_request'])
+ return;
+
+ // method handling
+ switch ($this->method) {
+ case 'GET':
+ // GET request so convert the parameters to a querystring
+ if ( ! empty($this->request_params)) {
+ foreach ($this->request_params as $k => $v) {
+ $params[] = $this->safe_encode($k) . '=' . $this->safe_encode($v);
+ }
+ $qs = implode('&', $params);
+ $this->url = strlen($qs) > 0 ? $this->url . '?' . $qs : $this->url;
+ $this->request_params = array();
+ }
+ break;
+ }
+
+ // configure curl
+ $c = curl_init();
+ curl_setopt($c, CURLOPT_USERAGENT, "themattharris' HTTP Client");
+ curl_setopt($c, CURLOPT_CONNECTTIMEOUT, 30);
+ curl_setopt($c, CURLOPT_TIMEOUT, 10);
+ curl_setopt($c, CURLOPT_RETURNTRANSFER, TRUE);
+ // for security you may want to set this to TRUE. If you do you need to install
+ // the servers certificate in your local certificate store.
+ curl_setopt($c, CURLOPT_SSL_VERIFYPEER, FALSE);
+ curl_setopt($c, CURLOPT_URL, $this->url);
+ // process the headers
+ curl_setopt($c, CURLOPT_HEADERFUNCTION, array($this, 'curlHeader'));
+ curl_setopt($c, CURLOPT_HEADER, FALSE);
+ curl_setopt($c, CURLINFO_HEADER_OUT, true);
+ switch ($this->method) {
+ case 'GET':
+ break;
+ case 'POST':
+ curl_setopt($c, CURLOPT_POST, TRUE);
+ break;
+ default:
+ curl_setopt($c, CURLOPT_CUSTOMREQUEST, $this->method);
+ }
+
+ if ( ! empty($this->request_params) ) {
+ // if not doing multipart we need to implode the parameters
+ if ( ! $this->config['multipart'] ) {
+ foreach ($this->request_params as $k => $v) {
+ $ps[] = "{$k}={$v}";
+ }
+ $this->request_params = implode('&', $ps);
+ }
+ curl_setopt($c, CURLOPT_POSTFIELDS, $this->request_params);
+ } else {
+ // CURL will set length to -1 when there is no data, which breaks Twitter
+ $this->headers[] = 'Content-Type:';
+ $this->headers[] = 'Content-Length:';
+ }
+
+ // CURL defaults to setting this to Expect: 100-Continue which Twitter rejects
+ $this->headers[] = 'Expect:';
+
+ if ( ! empty($this->headers)) {
+ curl_setopt($c, CURLOPT_HTTPHEADER, $this->headers);
+ }
+
+ // do it!
+ $response = curl_exec($c);
+ $code = curl_getinfo($c, CURLINFO_HTTP_CODE);
+ $info = curl_getinfo($c);
+ curl_close($c);
+
+ // store the response
+ $this->response['code'] = $code;
+ $this->response['response'] = $response;
+ $this->response['info'] = $info;
+ }
+
+ /**
+ * Debug function for printing the content of an object
+ *
+ * @param mixes $obj
+ */
+ function pr($obj) {
+ echo '<pre style="word-wrap: break-word">';
+ if ( is_object($obj) )
+ print_r($obj);
+ elseif ( is_array($obj) )
+ print_r($obj);
+ else
+ echo $obj;
+ echo '</pre>';
+ }
+
+ /**
+ * Returns the current URL. This is instead of PHP_SELF which is unsafe
+ *
+ * @param bool $dropqs whether to drop the querystring or not. Default true
+ * @return string the current URL
+ */
+ function php_self($dropqs=true) {
+ $url = sprintf('%s://%s%s',
+ $_SERVER['SERVER_PORT'] == 80 ? 'http' : 'https',
+ $_SERVER['SERVER_NAME'],
+ $_SERVER['REQUEST_URI']
+ );
+
+ $parts = parse_url($url);
+
+ $port = @$parts['port'];
+ $scheme = $parts['scheme'];
+ $host = $parts['host'];
+ $path = @$parts['path'];
+ $qs = @$parts['query'];
+
+ $port or $port = ($scheme == 'https') ? '443' : '80';
+
+ if (($scheme == 'https' && $port != '443')
+ || ($scheme == 'http' && $port != '80')) {
+ $host = "$host:$port";
+ }
+ $url = "$scheme://$host$path";
+ if ( ! $dropqs)
+ return "{$url}?{$qs}";
+ else
+ return $url;
+ }
+}
+
+?>
Please sign in to comment.
Something went wrong with that request. Please try again.