Find file
Fetching contributors…
Cannot retrieve contributors at this time
1410 lines (1220 sloc) 39 KB
<?php
/*
* Copyright 2010 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file 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.
*/
/**
* File: CFRuntime
* Core functionality and default settings shared across all SDK classes. All methods and properties in this class are inherited by the service-specific classes.
*
* Version:
* 2010.12.03
*
* License and Copyright:
* See the included NOTICE.md file for more information.
*
* See Also:
* [PHP Developer Center](http://aws.amazon.com/php/)
*/
/*%******************************************************************************************%*/
// CORE DEPENDENCIES
// Look for include file in the same directory (e.g. `./config.inc.php`).
if (file_exists(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'config.inc.php'))
{
include_once dirname(__FILE__) . DIRECTORY_SEPARATOR . 'config.inc.php';
}
// Fallback to `~/.aws/sdk/config.inc.php`
elseif (getenv('HOME') && file_exists(getenv('HOME') . DIRECTORY_SEPARATOR . '.aws' . DIRECTORY_SEPARATOR . 'sdk' . DIRECTORY_SEPARATOR . 'config.inc.php'))
{
include_once getenv('HOME') . DIRECTORY_SEPARATOR . '.aws' . DIRECTORY_SEPARATOR . 'sdk' . DIRECTORY_SEPARATOR . 'config.inc.php';
}
/*%******************************************************************************************%*/
// EXCEPTIONS
/**
* Exception: CFRuntime_Exception
* Default CFRuntime Exception.
*/
class CFRuntime_Exception extends Exception {}
/*%******************************************************************************************%*/
// DETERMINE WHAT ENVIRONMENT DATA TO ADD TO THE USERAGENT FOR METRIC TRACKING
/*
Define a temporary callback function for this calculation. Get the PHP version and any
required/optional extensions that are leveraged.
Tracking this data gives Amazon better metrics about what configurations are being used
so that forward-looking plans for the code can be made with more certainty (e.g. What
version of PHP are most people running? Do they tend to have the latest PCRE?).
*/
function __aws_sdk_ua_callback()
{
$ua_append = '';
$extensions = get_loaded_extensions();
$sorted_extensions = array();
if ($extensions)
{
foreach ($extensions as $extension)
{
if ($extension === 'curl' && function_exists('curl_version'))
{
$curl_version = curl_version();
$sorted_extensions[strtolower($extension)] = $curl_version['version'];
}
elseif ($extension === 'pcre' && defined('PCRE_VERSION'))
{
$pcre_version = explode(' ', PCRE_VERSION);
$sorted_extensions[strtolower($extension)] = $pcre_version[0];
}
elseif ($extension === 'openssl' && defined('OPENSSL_VERSION_TEXT'))
{
$openssl_version = explode(' ', OPENSSL_VERSION_TEXT);
$sorted_extensions[strtolower($extension)] = $openssl_version[1];
}
else
{
$sorted_extensions[strtolower($extension)] = phpversion($extension);
}
}
}
foreach (array('simplexml', 'json', 'pcre', 'spl', 'curl', 'openssl', 'apc', 'xcache', 'memcache', 'memcached', 'pdo', 'pdo_sqlite', 'sqlite', 'sqlite3', 'zlib', 'xdebug') as $ua_ext)
{
if (isset($sorted_extensions[$ua_ext]) && $sorted_extensions[$ua_ext])
{
$ua_append .= ' ' . $ua_ext . '/' . $sorted_extensions[$ua_ext];
}
elseif (isset($sorted_extensions[$ua_ext]))
{
$ua_append .= ' ' . $ua_ext . '/0';
}
}
return $ua_append;
}
/*%******************************************************************************************%*/
// INTERMEDIARY CONSTANTS
define('CFRUNTIME_NAME', 'aws-sdk-php');
define('CFRUNTIME_VERSION', '1.2');
// define('CFRUNTIME_BUILD', gmdate('YmdHis', filemtime(__FILE__))); // @todo: Hardcode for release.
define('CFRUNTIME_BUILD', '20101203002835');
define('CFRUNTIME_USERAGENT', CFRUNTIME_NAME . '/' . CFRUNTIME_VERSION . ' PHP/' . PHP_VERSION . ' ' . php_uname('s') . '/' . php_uname('r') . ' Arch/' . php_uname('m') . ' SAPI/' . php_sapi_name() . ' Integer/' . PHP_INT_MAX . ' Build/' . CFRUNTIME_BUILD . __aws_sdk_ua_callback());
/*%******************************************************************************************%*/
// CLASS
/**
* Class: CFRuntime
* Container for all shared methods. This is not intended to be instantiated directly, but is extended by the service-specific classes.
*/
class CFRuntime
{
/*%******************************************************************************************%*/
// CONSTANTS
/**
* Constant: NAME
* Name of the software.
*/
const NAME = CFRUNTIME_NAME;
/**
* Constant: VERSION
* Version of the software.
*/
const VERSION = CFRUNTIME_VERSION;
/**
* Constant: BUILD
* Build ID of the software.
*/
const BUILD = CFRUNTIME_BUILD;
/**
* Constant: USERAGENT
* User agent string used to identify the software.
* > aws-sdk-php/1.0 PHP/5.3.3 Darwin/10.4.0 Arch/i386 SAPI/apache2handler Build/20100915173336 [environmental information]
*/
const USERAGENT = CFRUNTIME_USERAGENT;
/*%******************************************************************************************%*/
// PROPERTIES
/**
* Property: key
* The Amazon API Key.
*/
public $key;
/**
* Property: secret_key
* The Amazon API Secret Key.
*/
public $secret_key;
/**
* Property: account_id
* The Amazon Account ID, without hyphens.
*/
public $account_id;
/**
* Property: assoc_id
* The Amazon Associates ID.
*/
public $assoc_id;
/**
* Property: util
* Handle for the utility functions.
*/
public $util;
/**
* Property: service
* An identifier for the current AWS service.
*/
public $service = null;
/**
* Property: api_version
* The supported API version.
*/
public $api_version = null;
/**
* Property: utilities_class
* The default class to use for utilities (defaults to <CFUtilities>).
*/
public $utilities_class = 'CFUtilities';
/**
* Property: request_class
* The default class to use for HTTP requests (defaults to <CFRequest>).
*/
public $request_class = 'CFRequest';
/**
* Property: response_class
* The default class to use for HTTP responses (defaults to <CFResponse>).
*/
public $response_class = 'CFResponse';
/**
* Property: parser_class
* The default class to use for parsing XML (defaults to <CFSimpleXML>).
*/
public $parser_class = 'CFSimpleXML';
/**
* Property: batch_class
* The default class to use for handling batch requests (defaults to <CFBatchRequest>).
*/
public $batch_class = 'CFBatchRequest';
/**
* Property: adjust_offset
* The number of seconds to adjust the request timestamp by (defaults to 0).
*/
public $adjust_offset = 0;
/**
* Property: use_ssl
* The state of SSL/HTTPS use.
*/
public $use_ssl = true;
/**
* Property: proxy
* The proxy to use for connecting.
*/
public $proxy = null;
/**
* Property: hostname
* The alternate hostname to use, if any.
*/
public $hostname = null;
/**
* Property: override_hostname
* The state of the capability to override the hostname with <set_hostname()>.
*/
public $override_hostname = true;
/**
* Property: port_number
* The alternate port number to use, if any.
*/
public $port_number = null;
/**
* Property: resource_prefix
* The alternate resource prefix to use, if any.
*/
public $resource_prefix = null;
/**
* Property: use_cache_flow
* The state of cache flow usage.
*/
public $use_cache_flow = false;
/**
* Property: cache_class
* The caching class to use.
*/
public $cache_class = null;
/**
* Property: cache_location
* The caching location to use.
*/
public $cache_location = null;
/**
* Property: cache_expires
* When the cache should be considered stale.
*/
public $cache_expires = null;
/**
* Property: cache_compress
* The state of cache compression.
*/
public $cache_compress = null;
/**
* Property: cache_object
* The current instantiated cache object.
*/
public $cache_object = null;
/**
* Property: batch_object
* The current instantiated batch request object.
*/
public $batch_object = null;
/**
* Property: internal_batch_object
* The internally instantiated batch request object.
*/
public $internal_batch_object = null;
/**
* Property: use_batch_flow
* The state of batch flow usage.
*/
public $use_batch_flow = false;
/**
* Property: delete_cache
* The state of the cache deletion setting.
*/
public $delete_cache = false;
/**
* Property: debug_mode
* The state of the debug mode setting.
*/
public $debug_mode = false;
/**
* Property: max_retries
* The number of times to retry failed requests.
*/
public $max_retries = 3;
/*%******************************************************************************************%*/
// CONSTRUCTOR
/**
* Method: __construct()
* The constructor. You would not normally instantiate this class directly. Rather, you would instantiate a service-specific class.
*
* Access:
* public
*
* Parameters:
* $key - _string_ (Optional) Your Amazon API Key. If blank, it will look for the <AWS_KEY> constant.
* $secret_key - _string_ (Optional) Your Amazon API Secret Key. If blank, it will look for the <AWS_SECRET_KEY> constant.
* $account_id - _string_ (Optional) Your Amazon account ID without the hyphens. Required for EC2. If blank, it will look for the <AWS_ACCOUNT_ID> constant.
* $assoc_id - _string_ (Optional) Your Amazon Associates ID. Required for AAWS. If blank, it will look for the <AWS_ASSOC_ID> constant.
*
* Returns:
* _boolean_ A value of `false` if no valid values are set, otherwise `true`.
*/
public function __construct($key = null, $secret_key = null, $account_id = null, $assoc_id = null)
{
// Instantiate the utilities class.
$this->util = new $this->utilities_class();
// Determine the current service.
$this->service = get_class($this);
// Set default values
$this->key = null;
$this->secret_key = null;
$this->account_id = null;
$this->assoc_id = null;
// Set the Account ID
if ($account_id)
{
$this->account_id = $account_id;
}
elseif (defined('AWS_ACCOUNT_ID'))
{
$this->account_id = AWS_ACCOUNT_ID;
}
// Set the Associates ID
if ($assoc_id)
{
$this->assoc_id = $assoc_id;
}
elseif (defined('AWS_ASSOC_ID'))
{
$this->assoc_id = AWS_ASSOC_ID;
}
// If both a key and secret key are passed in, use those.
if ($key && $secret_key)
{
$this->key = $key;
$this->secret_key = $secret_key;
return true;
}
// If neither are passed in, look for the constants instead.
elseif (defined('AWS_KEY') && defined('AWS_SECRET_KEY'))
{
$this->key = AWS_KEY;
$this->secret_key = AWS_SECRET_KEY;
return true;
}
// Otherwise set the values to blank and return false.
else
{
throw new CFRuntime_Exception('No valid credentials were used to authenticate with AWS.');
}
}
/**
* Method: init()
* Alternate approach to constructing a new instance. Supports chaining.
*
* Access:
* public
*
* Parameters:
* $key - _string_ (Optional) Your Amazon API Key. If blank, it will look for the <AWS_KEY> constant.
* $secret_key - _string_ (Optional) Your Amazon API Secret Key. If blank, it will look for the <AWS_SECRET_KEY> constant.
* $account_id - _string_ (Optional) Your Amazon account ID without the hyphens. Required for EC2. If blank, it will look for the <AWS_ACCOUNT_ID> constant.
* $assoc_id - _string_ (Optional) Your Amazon Associates ID. Required for AAWS. If blank, it will look for the <AWS_ASSOC_ID> constant.
*
* Returns:
* _boolean_ A value of `false` if no valid values are set, otherwise `true`.
*/
public static function init($key = null, $secret_key = null, $account_id = null, $assoc_id = null)
{
if (version_compare(PHP_VERSION, '5.3.0', '<'))
{
throw new Exception('PHP 5.3 or newer is required to instantiate a new class with CLASS::init().');
}
$self = get_called_class();
return new $self($key, $secret_key, $account_id, $assoc_id);
}
/*%******************************************************************************************%*/
// MAGIC METHODS
/**
* Method: __call()
* A magic method that allows `camelCase` method names to be translated into `snake_case` names.
*
* Access:
* public
*
* Parameters:
* $name - _string_ (Required) The name of the method.
* $arguments - _array_ (Required) The arguments passed to the method.
*
* Returns:
* _mixed_ The results of the intended method.
*/
public function __call($name, $arguments)
{
// Convert camelCase method calls to snake_case.
$method_name = strtolower(preg_replace('/([a-z])([A-Z])/', '$1_$2', $name));
if (method_exists($this, $method_name))
{
return call_user_func_array(array($this, $method_name), $arguments);
}
throw new CFRuntime_Exception('The method ' . $name . '() is undefined. Attempted to map to ' . $method_name . '() which is also undefined. Error occurred');
}
/*%******************************************************************************************%*/
// SET CUSTOM SETTINGS
/**
* Method: adjust_offset()
* Adjusts the current time. Use this method for occasions when a server is out of sync with Amazon S3 servers.
*
* Access:
* public
*
* Parameters:
* $seconds - _integer_ (Required) The number of seconds to adjust the sent timestamp by.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function adjust_offset($seconds)
{
$this->adjust_offset = $seconds;
return $this;
}
/**
* Method: set_proxy()
* Set the proxy settings to use.
*
* Access:
* public
*
* Parameters:
* $proxy - _string_ (Required) Accepts proxy credentials in the following format: `proxy://user:pass@hostname:port`
*
* Returns:
* `$this` A reference to the current instance.
*/
public function set_proxy($proxy)
{
$this->proxy = $proxy;
return $this;
}
/**
* Method: set_hostname()
* Set the hostname to connect to. This is useful for alternate services that are API-compatible with AWS, but run from a different hostname.
*
* Access:
* public
*
* Parameters:
* $hostname - _string_ (Required) The alternate hostname to use in place of the default one. Useful for API-compatible applications living on different hostnames.
* $port_number - _integer_ (Optional) The alternate port number to use in place of the default one. Useful for API-compatible applications living on different port numbers.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function set_hostname($hostname, $port_number = null)
{
if ($this->override_hostname)
{
$this->hostname = $hostname;
if ($port_number)
{
$this->port_number = $port_number;
$this->hostname .= ':' . (string) $this->port_number;
}
}
return $this;
}
/**
* Method: set_resource_prefix()
* Set the resource prefix to use. This method is useful for alternate services that are API-compatible
* with AWS.
*
* Access:
* public
*
* Parameters:
* $prefix - _string_ (Required) An alternate prefix to prepend to the resource path. Useful for API-compatible applications.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function set_resource_prefix($prefix)
{
$this->resource_prefix = $prefix;
return $this;
}
/**
* Method: allow_hostname_override()
* Disables any subsequent use of the <set_hostname()> method. Use this method when using third-party, Amazon API-compatible services.
*
* Access:
* public
*
* Parameters:
* $override - _boolean_ (Optional) Whether or not subsequent calls to <set_hostname()> should be obeyed. A `false` value disables the further effectiveness of <set_hostname()>. Defaults to `true`.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function allow_hostname_override($override = true)
{
$this->override_hostname = $override;
return $this;
}
/**
* Method: disable_ssl()
* Disables SSL/HTTPS connections for hosts that don't support them. Some services, however, still require SSL support.
*
* Access:
* public
*
* Returns:
* `$this` A reference to the current instance.
*/
public function disable_ssl()
{
$this->use_ssl = false;
return $this;
}
/**
* Method: enable_debug_mode()
* Enables HTTP request/response header logging to `STDERR`.
*
* Access:
* public
*
* Parameters:
* $enabled - _boolean_ (Optional) Whether or not to enable debug mode. Defaults to `true`.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function enable_debug_mode($enabled = true)
{
$this->debug_mode = $enabled;
return $this;
}
/**
* Method: set_max_retries()
* Sets the maximum number of times to retry failed requests.
*
* Access:
* public
*
* Parameters:
* $retries - _integer_ (Optional) The maximum number of times to retry failed requests. Defaults to `3`.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function set_max_retries($retries = 3)
{
$this->max_retries = $retries;
return $this;
}
/**
* Method: set_cache_config()
* Set the caching configuration to use for response caching.
*
* Access:
* public
*
* Parameters:
* $location - _string_ (Required) The location to store the cache object in. This may vary by cache method. See below.
* $gzip - _boolean_ (Optional) Whether or not data should be gzipped before being stored. A value of `true` will compress the contents before caching them. A value of `false` will leave the contents uncompressed. Defaults to `true`.
*
* Example values for $location:
* File - The local file system paths such as `./cache` (relative) or `/tmp/cache/` (absolute). The location must be server-writable.
* APC - Pass in `apc` to use this lightweight cache. You must have the APC extension installed (see [php.net/apc](http://php.net/apc)).
* XCache - Pass in `xcache` to use this lightweight cache. You must have the XCache extension installed (see [xcache.lighttpd.net](http://xcache.lighttpd.net)).
* Memcached - Pass in an indexed array of associative arrays. Each associative array should have a `host` and a `port` value representing a Memcached server to connect to.
* PDO - A URL-style string (e.g. `pdo.mysql://user:pass@localhost/cache`) or a standard DSN-style string (e.g. `pdo.sqlite:/sqlite/cache.db`). MUST be prefixed with `pdo.`. See <CachePDO> and [php.net/pdo](http://php.net/pdo) for more details.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function set_cache_config($location, $gzip = true)
{
// If we have an array, we're probably passing in Memcached servers and ports.
if (is_array($location))
{
$this->cache_class = 'CacheMC';
}
else
{
// I would expect locations like `/tmp/cache`, `pdo.mysql://user:pass@hostname:port`, `pdo.sqlite:memory:`, and `apc`.
$type = strtolower(substr($location, 0, 3));
switch ($type)
{
case 'apc':
$this->cache_class = 'CacheAPC';
break;
case 'xca': // First three letters of `xcache`
$this->cache_class = 'CacheXCache';
break;
case 'pdo':
$this->cache_class = 'CachePDO';
$location = substr($location, 4);
break;
default:
$this->cache_class = 'CacheFile';
break;
}
}
// Set the remaining cache information.
$this->cache_location = $location;
$this->cache_compress = $gzip;
return $this;
}
/*%******************************************************************************************%*/
// SET CUSTOM CLASSES
/**
* Method: set_utilities_class()
* Set a custom class for this functionality. Use this method when extending/overriding existing classes with new functionality.
*
* The replacement class must extend from <CFUtilities>.
*
* Access:
* public
*
* Parameters:
* class - _string_ (Optional) The name of the new class to use for this functionality.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function set_utilities_class($class = 'CFUtilities')
{
$this->utilities_class = $class;
$this->util = new $this->utilities_class();
return $this;
}
/**
* Method: set_request_class()
* Set a custom class for this functionality. Use this method when extending/overriding existing classes with new functionality.
*
* The replacement class must extend from <CFRequest>.
*
* Access:
* public
*
* Parameters:
* class - _string_ (Optional) The name of the new class to use for this functionality.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function set_request_class($class = 'CFRequest')
{
$this->request_class = $class;
return $this;
}
/**
* Method: set_response_class()
* Set a custom class for this functionality. Use this method when extending/overriding existing classes with new functionality.
*
* The replacement class must extend from <CFResponse>.
*
* Access:
* public
*
* Parameters:
* class - _string_ (Optional) The name of the new class to use for this functionality.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function set_response_class($class = 'CFResponse')
{
$this->response_class = $class;
return $this;
}
/**
* Method: set_parser_class()
* Set a custom class for this functionality. Use this method when extending/overriding existing classes with new functionality.
*
* The replacement class must extend from <CFSimpleXML>.
*
* Access:
* public
*
* Parameters:
* class - _string_ (Optional) The name of the new class to use for this functionality.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function set_parser_class($class = 'CFSimpleXML')
{
$this->parser_class = $class;
return $this;
}
/**
* Method: set_batch_class()
* Set a custom class for this functionality. Use this method when extending/overriding existing classes with new functionality.
*
* The replacement class must extend from <CFBatchRequest>.
*
* Access:
* public
*
* Parameters:
* class - _string_ (Optional) The name of the new class to use for this functionality.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function set_batch_class($class = 'CFBatchRequest')
{
$this->batch_class = $class;
return $this;
}
/*%******************************************************************************************%*/
// AUTHENTICATION
/**
* Method: authenticate()
* Default, shared method for authenticating a connection to AWS. Overridden on a class-by-class basis as necessary.
*
* Access:
* public
*
* Parameters:
* $action - _string_ (Required) Indicates the action to perform.
* $opt - _array_ (Optional) An associative array of parameters for authenticating. See the individual methods for allowed keys.
* $domain - _string_ (Optional) The URL of the queue to perform the action on.
* $signature_version - _string_ (Optional) The signature version to use. Defaults to 2.
* $redirects - _integer_ (Do Not Use) Used internally by this function on occasions when Amazon S3 returns a redirect code and it needs to call itself recursively.
*
* Returns:
* <CFResponse> Object containing a parsed HTTP response.
*/
public function authenticate($action, $opt = null, $domain = null, $signature_version = 2, $redirects = 0)
{
// Handle nulls
if (is_null($signature_version))
{
$signature_version = 2;
}
$method_arguments = func_get_args();
// Use the caching flow to determine if we need to do a round-trip to the server.
if ($this->use_cache_flow)
{
// Generate an identifier specific to this particular set of arguments.
$cache_id = $this->key . '_' . get_class($this) . '_' . $action . '_' . sha1(serialize($method_arguments));
// Instantiate the appropriate caching object.
$this->cache_object = new $this->cache_class($cache_id, $this->cache_location, $this->cache_expires, $this->cache_compress);
if ($this->delete_cache)
{
$this->use_cache_flow = false;
$this->delete_cache = false;
return $this->cache_object->delete();
}
// Invoke the cache callback function to determine whether to pull data from the cache or make a fresh request.
$data = $this->cache_object->response_manager(array($this, 'cache_callback'), $method_arguments);
// Parse the XML body
$data = $this->parse_callback($data);
// End!
return $data;
}
$return_curl_handle = false;
// Do we have a custom resource prefix?
if ($this->resource_prefix)
{
$domain .= $this->resource_prefix;
}
// Determine signing values
$current_time = time() + $this->adjust_offset;
$date = gmdate($this->util->konst($this->util, 'DATE_FORMAT_RFC2616'), $current_time);
$timestamp = gmdate($this->util->konst($this->util, 'DATE_FORMAT_ISO8601'), $current_time);
$nonce = $this->util->generate_guid();
// Manage the key-value pairs that are used in the query.
$query['Action'] = $action;
$query['Version'] = $this->api_version;
// Only Signature v2
if ($signature_version === 2)
{
$query['AWSAccessKeyId'] = $this->key;
$query['SignatureMethod'] = 'HmacSHA256';
$query['SignatureVersion'] = 2;
$query['Timestamp'] = $timestamp;
}
// Merge in any options that were passed in
if (is_array($opt))
{
$query = array_merge($query, $opt);
}
$return_curl_handle = isset($query['returnCurlHandle']) ? $query['returnCurlHandle'] : false;
unset($query['returnCurlHandle']);
// Do a case-sensitive, natural order sort on the array keys.
uksort($query, 'strcmp');
// Create the string that needs to be hashed.
$canonical_query_string = $this->util->to_signable_string($query);
// Remove the default scheme from the domain.
$domain = str_replace(array('http://', 'https://'), '', $domain);
// Parse our request.
$parsed_url = parse_url('http://' . $domain);
// Set the proper host header.
if (isset($parsed_url['port']) && (integer) $parsed_url['port'] !== 80 && (integer) $parsed_url['port'] !== 443)
{
$host_header = strtolower($parsed_url['host']) . ':' . $parsed_url['port'];
}
else
{
$host_header = strtolower($parsed_url['host']);
}
// Set the proper request URI.
$request_uri = isset($parsed_url['path']) ? $parsed_url['path'] : '/';
// Handle signing differently between v2 and v3
if ($signature_version === 3)
{
// Prepare the string to sign
$string_to_sign = $date . $nonce;
// Hash the AWS secret key and generate a signature for the request.
$signature = base64_encode(hash_hmac('sha256', $string_to_sign, $this->secret_key, true));
}
elseif ($signature_version === 2)
{
// Prepare the string to sign
$string_to_sign = "POST\n$host_header\n$request_uri\n$canonical_query_string";
// Hash the AWS secret key and generate a signature for the request.
$query['Signature'] = base64_encode(hash_hmac('sha256', $string_to_sign, $this->secret_key, true));
}
// Generate the querystring from $query
$querystring = $this->util->to_query_string($query);
// Gather information to pass along to other classes.
$helpers = array(
'utilities' => $this->utilities_class,
'request' => $this->request_class,
'response' => $this->response_class,
);
// Compose the request.
$request_url = (($this->use_ssl) ? 'https://' : 'http://') . $domain;
$request_url .= !isset($parsed_url['path']) ? '/' : '';
// Instantiate the request class
$request = new $this->request_class($request_url, $this->proxy, $helpers);
$request->set_method('POST');
$request->add_header('Content-Type', 'application/x-www-form-urlencoded; charset=utf-8');
$request->set_body($querystring);
// Add authentication headers
if ($signature_version === 3)
{
$request->add_header('Date', $date);
$request->add_header('Content-Length', strlen($querystring));
$request->add_header('Content-MD5', $this->util->hex_to_base64(md5($querystring)));
$request->add_header('x-amz-nonce', $nonce);
$request->add_header('X-Amzn-Authorization', 'AWS3-HTTPS AWSAccessKeyId=' . $this->key . ',Algorithm=HmacSHA256,Signature=' . $signature);
}
// Update RequestCore settings
$request->request_class = $this->request_class;
$request->response_class = $this->response_class;
$curlopts = array();
// Set custom CURLOPT settings
if (isset($opt['curlopts']))
{
$curlopts = $opt['curlopts'];
unset($opt['curlopts']);
}
// Debug mode
if ($this->debug_mode)
{
$curlopts[CURLOPT_VERBOSE] = true;
}
if (count($curlopts))
{
$request->set_curlopts($curlopts);
}
// Manage the (newer) batch request API or the (older) returnCurlHandle setting.
if ($this->use_batch_flow)
{
$handle = $request->prep_request();
$this->batch_object->add($handle);
$this->use_batch_flow = false;
return $handle;
}
elseif ($return_curl_handle)
{
return $request->prep_request();
}
// Send!
$request->send_request();
// Prepare the response.
$headers = $request->get_response_header();
$headers['x-aws-stringtosign'] = $string_to_sign;
$headers['x-aws-body'] = $querystring;
$data = new $this->response_class($headers, $this->parse_callback($request->get_response_body()), $request->get_response_code());
// Was it Amazon's fault the request failed? Retry the request until we reach $max_retries.
if ((integer) $request->get_response_code() === 500 || (integer) $request->get_response_code() === 503)
{
if ($redirects <= $this->max_retries)
{
// Exponential backoff
$delay = (integer) (pow(4, $redirects) * 100000);
usleep($delay);
$data = $this->authenticate($action, $opt, $domain, $signature_version, ++$redirects);
}
}
return $data;
}
/*%******************************************************************************************%*/
// BATCH REQUEST LAYER
/**
* Method: batch()
* Specifies that the intended request should be queued for a later batch request.
*
* Access:
* public
*
* Parameters:
* $queue - _CFBatchRequest_ (Optional) The <CFBatchRequest> instance to use for managing batch requests. If not available, it generates a new instance of <CFBatchRequest>.
*
* Returns:
* `$this` A reference to the current instance.
*/
public function batch(CFBatchRequest &$queue = null)
{
if ($queue)
{
$this->batch_object = $queue;
}
elseif ($this->internal_batch_object)
{
$this->batch_object = &$this->internal_batch_object;
}
else
{
$this->internal_batch_object = new $this->batch_class();
$this->batch_object = &$this->internal_batch_object;
}
$this->use_batch_flow = true;
return $this;
}
/**
* Method: send()
* Executes the batch request queue by sending all queued requests.
*
* Access:
* public
*
* Parameters:
* $clear_after_send - _boolean_ (Optional) Whether or not to clear the batch queue after sending a request. Defaults to `true`. Set this to `false` if you are caching batch responses and want to retrieve results later.
*
* Returns:
* _array_ An array of <CFResponse> objects.
*/
public function send($clear_after_send = true)
{
if ($this->use_batch_flow)
{
// When we send the request, disable batch flow.
$this->use_batch_flow = false;
// If we're not caching, simply send the request.
if (!$this->use_cache_flow)
{
$response = $this->batch_object->send();
$parsed_data = array_map(array($this, 'parse_callback'), $response);
$parsed_data = new CFArray($parsed_data);
// Clear the queue
if ($clear_after_send)
{
$this->batch_object->queue = array();
}
return $parsed_data;
}
// Generate an identifier specific to this particular set of arguments.
$cache_id = $this->key . '_' . get_class($this) . '_' . sha1(serialize($this->batch_object));
// Instantiate the appropriate caching object.
$this->cache_object = new $this->cache_class($cache_id, $this->cache_location, $this->cache_expires, $this->cache_compress);
if ($this->delete_cache)
{
$this->use_cache_flow = false;
$this->delete_cache = false;
return $this->cache_object->delete();
}
// Invoke the cache callback function to determine whether to pull data from the cache or make a fresh request.
$data_set = $this->cache_object->response_manager(array($this, 'cache_callback_batch'), array($this->batch_object));
$parsed_data = array_map(array($this, 'parse_callback'), $data_set);
$parsed_data = new CFArray($parsed_data);
// Clear the queue
if ($clear_after_send)
{
$this->batch_object->queue = array();
}
// End!
return $parsed_data;
}
// Load the class
$null = new CFBatchRequest();
unset($null);
throw new CFBatchRequest_Exception('You must use $object->batch()->send()');
}
/**
* Method: parse_callback()
* Parses a response body into a PHP object if appropriate.
*
* Access:
* public
*
* Parameters:
* $response - _CFResponse_|_string_ (Required) The <CFResponse> object to parse, or an XML string that would otherwise be a response body.
*
* Returns:
* _CFResponse_|_string_ A parsed <CFResponse> object, or parsed XML.
*/
public function parse_callback($response)
{
// Shorten this so we have a (mostly) single code path
if (isset($response->body))
{
if (is_string($response->body))
{
$body = $response->body;
}
else
{
return $response;
}
}
elseif (is_string($response))
{
$body = $response;
}
else
{
return $response;
}
// Look for XML cues
if (
(stripos($body, '<?xml') === 0 || strpos($body, '<Error>') === 0) ||
preg_match('/^<(\w*) xmlns="http(s?):\/\/(\w*).amazon(aws)?.com/im', $body)
)
{
// Strip the default XML namespace to simplify XPath expressions
$body = str_replace("xmlns=", "ns=", $body);
// Parse the XML body
$body = new $this->parser_class($body);
}
// Put the parsed data back where it goes
if (isset($response->body))
{
$response->body = $body;
}
else
{
$response = $body;
}
return $response;
}
/*%******************************************************************************************%*/
// CACHING LAYER
/**
* Method: cache()
* Specifies that the resulting <CFResponse> object should be cached according to the settings from <set_cache_config()>.
*
* Access:
* public
*
* Parameters:
* $expires - _string_|_integer_ (Required) The time the cache is to expire. Accepts a number of seconds as an integer, or an amount of time, as a string, that is understood by `strtotime()` (e.g. "1 hour").
*
* Returns:
* `$this` A reference to the current instance.
*/
public function cache($expires)
{
// Die if they haven't used set_cache_config().
if (!$this->cache_class)
{
throw new CFRuntime_Exception('Must call set_cache_config() before using cache()');
}
if (is_string($expires))
{
$expires = strtotime($expires);
$this->cache_expires = $expires - time();
}
elseif (is_int($expires))
{
$this->cache_expires = $expires;
}
$this->use_cache_flow = true;
return $this;
}
/**
* Method: cache_callback()
* The callback function that is executed when the cache doesn't exist or has expired. The response of this method is cached. Accepts identical parameters as the <authenticate()> method. Never call this method directly -- it is used internally by the caching system.
*
* Access:
* public
*
* Parameters:
* $action - _string_ (Required) Indicates the action to perform.
* $opt - _array_ (Optional) An associative array of parameters for authenticating. See the individual methods for allowed keys.
* $domain - _string_ (Optional) The URL of the queue to perform the action on.
* $signature_version - _string_ (Optional) The signature version to use. Defaults to 2.
*
* Returns:
* <CFResponse> object
*/
public function cache_callback($action, $opt = null, $domain = null, $signature_version = 2)
{
// Disable the cache flow since it's already been handled.
$this->use_cache_flow = false;
// Make the request
$response = $this->authenticate($action, $opt, $domain, $signature_version);
// If this is an XML document, convert it back to a string.
if (isset($response->body) && ($response->body instanceof SimpleXMLElement))
{
$response->body = $response->body->asXML();
}
return $response;
}
/**
* Method: cache_callback_batch()
* Used for caching the results of a batch request. Never call this method directly; it is used internally by the caching system.
*
* Access:
* public
*
* Parameters:
* $batch - _CFBatchRequest_ (Required) The batch request object to send.
*
* Returns:
* <CFResponse> object
*/
public function cache_callback_batch(CFBatchRequest $batch)
{
return $batch->send();
}
/**
* Method: delete_cache()
* Deletes a cached <CFResponse> object using the specified cache storage type.
*
* Access:
* public
*
* Returns:
* _boolean_ A value of `true` if cached object exists and is successfully deleted, otherwise `false`.
*/
public function delete_cache()
{
$this->use_cache_flow = true;
$this->delete_cache = true;
return $this;
}
}
/**
* Class: CFLoader
* Contains the functionality for auto-loading service classes.
*/
class CFLoader
{
/*%******************************************************************************************%*/
// AUTO-LOADER
/**
* Method: autoloader()
* Automatically load classes that aren't included.
*
* Access:
* public static
*
* Parameters:
* $class - _string_ (Required) The classname to load.
*
* Returns:
* void
*/
public static function autoloader($class)
{
$path = dirname(__FILE__) . DIRECTORY_SEPARATOR;
// Amazon SDK classes
if (strstr($class, 'Amazon'))
{
$path .= 'services' . DIRECTORY_SEPARATOR . str_ireplace('Amazon', '', strtolower($class)) . '.class.php';
}
// Utility classes
elseif (strstr($class, 'CF'))
{
$path .= 'utilities' . DIRECTORY_SEPARATOR . str_ireplace('CF', '', strtolower($class)) . '.class.php';
}
// Load CacheCore
elseif (strstr($class, 'Cache'))
{
if (file_exists($ipath = 'lib' . DIRECTORY_SEPARATOR . 'cachecore' . DIRECTORY_SEPARATOR . 'icachecore.interface.php'))
{
require_once($ipath);
}
$path .= 'lib' . DIRECTORY_SEPARATOR . 'cachecore' . DIRECTORY_SEPARATOR . strtolower($class) . '.class.php';
}
// Load RequestCore
elseif (strstr($class, 'RequestCore') || strstr($class, 'ResponseCore'))
{
$path .= 'lib' . DIRECTORY_SEPARATOR . 'requestcore' . DIRECTORY_SEPARATOR . 'requestcore.class.php';
}
// Load Symfony YAML classes
elseif (strstr($class, 'sfYaml'))
{
$path .= 'lib' . DIRECTORY_SEPARATOR . 'yaml' . DIRECTORY_SEPARATOR . 'lib' . DIRECTORY_SEPARATOR . 'sfYaml.php';
}
// Fall back to the 'extensions' directory.
elseif (defined('AWS_ENABLE_EXTENSIONS') && AWS_ENABLE_EXTENSIONS)
{
$path .= 'extensions' . DIRECTORY_SEPARATOR . strtolower($class) . '.class.php';
}
if (file_exists($path) && !is_dir($path))
{
require_once($path);
}
}
}
// Register the autoloader.
spl_autoload_register(array('CFLoader', 'autoloader'));