/library/Zend/Service/WindowsAzure/Storage/Storage.php

<?php
/**
 * Zend Framework (http://framework.zend.com/)
 *
 * @link      http://github.com/zendframework/zf2 for the canonical source repository
 * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
 * @license   http://framework.zend.com/license/new-bsd New BSD License
 * @package   Zend_Service
 */

namespace Zend\Service\WindowsAzure\Storage;

use Zend\Http\Client;
use Zend\Http\Request;
use Zend\Http\Response;
use Zend\Service\WindowsAzure\Credentials;
use Zend\Service\WindowsAzure\Exception\DomainException;
use Zend\Service\WindowsAzure\RetryPolicy;

/**
 * @category   Zend
 * @package    Zend_Service_WindowsAzure
 * @subpackage Storage
 */
class Storage
{
    /**
     * Development storage URLS
     */
    const URL_DEV_BLOB  = "127.0.0.1:10000";
    const URL_DEV_QUEUE = "127.0.0.1:10001";
    const URL_DEV_TABLE = "127.0.0.1:10002";

    /**
     * Live storage URLS
     */
    const URL_CLOUD_BLOB  = "blob.core.windows.net";
    const URL_CLOUD_QUEUE = "queue.core.windows.net";
    const URL_CLOUD_TABLE = "table.core.windows.net";

    /**
     * Resource types
     */
    const RESOURCE_UNKNOWN   = "unknown";
    const RESOURCE_CONTAINER = "c";
    const RESOURCE_BLOB      = "b";
    const RESOURCE_TABLE     = "t";
    const RESOURCE_ENTITY    = "e";
    const RESOURCE_QUEUE     = "q";

    /**
     * Current API version
     *
     * @var string
     */
    protected $_apiVersion = '2009-04-14';

    /**
     * Storage host name
     *
     * @var string
     */
    protected $_host = '';

    /**
     * Account name for Windows Azure
     *
     * @var string
     */
    protected $_accountName = '';

    /**
     * Account key for Windows Azure
     *
     * @var string
     */
    protected $_accountKey = '';

    /**
     * Use path-style URI's
     *
     * @var boolean
     */
    protected $_usePathStyleUri = false;

    /**
     * Credentials\AbstractCredentials instance
     *
     * @var Credentials\AbstractCredentials
     */
    protected $_credentials = null;

    /**
     * RetryPolicy\AbstractRetryPolicy instance
     *
     * @var RetryPolicy\AbstractRetryPolicy
     */
    protected $_retryPolicy = null;

    /**
     * Client channel used for communication with REST services
     *
     * @var Client
     */
    protected $_httpClientChannel = null;

    /**
     * Use proxy?
     *
     * @var boolean
     */
    protected $_useProxy = false;

    /**
     * Proxy url
     *
     * @var string
     */
    protected $_proxyUrl = '';

    /**
     * Proxy port
     *
     * @var int
     */
    protected $_proxyPort = 80;

    /**
     * Proxy credentials
     *
     * @var string
     */
    protected $_proxyCredentials = '';

    /**
     * Creates a new Zend_Service_WindowsAzure_Storage instance
     *
     * @param string                          $host            Storage host name
     * @param string                          $accountName     Account name for Windows Azure
     * @param string                          $accountKey      Account key for Windows Azure
     * @param boolean                         $usePathStyleUri Use path-style URI's
     * @param RetryPolicy\AbstractRetryPolicy $retryPolicy     Retry policy to use when making requests
     */
    public function __construct(
        $host = self::URL_DEV_BLOB,
        $accountName = Credentials\AbstractCredentials::DEVSTORE_ACCOUNT,
        $accountKey = Credentials\AbstractCredentials::DEVSTORE_KEY,
        $usePathStyleUri = false,
        RetryPolicy\AbstractRetryPolicy $retryPolicy = null
    )
    {
        $this->_host            = $host;
        $this->_accountName     = $accountName;
        $this->_accountKey      = $accountKey;
        $this->_usePathStyleUri = $usePathStyleUri;

        // Using local storage?
        if (!$this->_usePathStyleUri
            && ($this->_host == self::URL_DEV_BLOB
                || $this->_host == self::URL_DEV_QUEUE
                || $this->_host == self::URL_DEV_TABLE)
        ) {
            // Local storage
            $this->_usePathStyleUri = true;
        }

        if ($this->_credentials === null) {
            $this->_credentials = new Credentials\SharedKey(
                $this->_accountName, $this->_accountKey, $this->_usePathStyleUri);
        }

        $this->_retryPolicy = $retryPolicy;
        if ($this->_retryPolicy === null) {
            $this->_retryPolicy = RetryPolicy\AbstractRetryPolicy::noRetry();
        }

        // Setup default Client channel
        $options = array(
            'adapter' => 'Zend\\Http\\Client\\Adapter\\Proxy'
        );
        if (function_exists('curl_init')) {
            // Set cURL options if cURL is used afterwards
            $options['curloptions'] = array(
                CURLOPT_FOLLOWLOCATION => true,
                CURLOPT_TIMEOUT        => 120,
            );
        }
        $this->_httpClientChannel = new Client(null, $options);
    }

    /**
     * Set the HTTP client channel to use
     *
     * @param Client\Adapter\AdapterInterface|string $adapterInstance Adapter instance or adapter class name.
     */
    public function setHttpClientChannel($adapterInstance = 'Zend\Http\Client\Adapter\Proxy')
    {
        $this->_httpClientChannel->setAdapter($adapterInstance);
    }

    /**
     * Set retry policy to use when making requests
     *
     * @param RetryPolicy\AbstractRetryPolicy $retryPolicy Retry policy to use when making requests
     */
    public function setRetryPolicy(RetryPolicy\AbstractRetryPolicy $retryPolicy = null)
    {
        $this->_retryPolicy = $retryPolicy;
        if ($this->_retryPolicy === null) {
            $this->_retryPolicy = RetryPolicy\AbstractRetryPolicy::noRetry();
        }
    }

    /**
     * Set proxy
     *
     * @param boolean $useProxy         Use proxy?
     * @param string  $proxyUrl         Proxy URL
     * @param int     $proxyPort        Proxy port
     * @param string  $proxyCredentials Proxy credentials
     */
    public function setProxy($useProxy = false, $proxyUrl = '', $proxyPort = 80, $proxyCredentials = '')
    {
        $this->_useProxy         = $useProxy;
        $this->_proxyUrl         = $proxyUrl;
        $this->_proxyPort        = $proxyPort;
        $this->_proxyCredentials = $proxyCredentials;

        if ($this->_useProxy) {
            $credentials = explode(':', $this->_proxyCredentials);
            if (!isset($credentials[1])) {
                $credentials[1] = '';
            }
            $this->_httpClientChannel->setOptions(array(
                                                       'proxy_host' => $this->_proxyUrl,
                                                       'proxy_port' => $this->_proxyPort,
                                                       'proxy_user' => $credentials[0],
                                                       'proxy_pass' => $credentials[1],
                                                  ));
        } else {
            $this->_httpClientChannel->setOptions(array(
                                                       'proxy_host' => '',
                                                       'proxy_port' => 8080,
                                                       'proxy_user' => '',
                                                       'proxy_pass' => '',
                                                  ));
        }
    }

    /**
     * Returns the Windows Azure account name
     *
     * @return string
     */
    public function getAccountName()
    {
        return $this->_accountName;
    }

    /**
     * Get base URL for creating requests
     *
     * @return string
     */
    public function getBaseUrl()
    {
        if ($this->_usePathStyleUri) {
            return 'http://' . $this->_host . '/' . $this->_accountName;
        } else {
            return 'http://' . $this->_accountName . '.' . $this->_host;
        }
    }

    /**
     * Set Credentials\AbstractCredentials instance
     *
     * @param Credentials\AbstractCredentials $credentials Credentials\AbstractCredentials instance to use for request signing.
     */
    public function setCredentials(Credentials\AbstractCredentials $credentials)
    {
        $this->_credentials = $credentials;
        $this->_credentials->setAccountName($this->_accountName);
        $this->_credentials->setAccountkey($this->_accountKey);
        $this->_credentials->setUsePathStyleUri($this->_usePathStyleUri);
    }

    /**
     * Get Credentials\AbstractCredentials instance
     *
     * @return Credentials\AbstractCredentials
     */
    public function getCredentials()
    {
        return $this->_credentials;
    }

    /**
     * Perform request using Client channel
     *
     * @param string  $path               Path
     * @param string  $queryString        Query string
     * @param string  $httpVerb           HTTP verb the request will use
     * @param array   $headers            x-ms headers to add
     * @param boolean $forTableStorage    Is the request for table storage?
     * @param mixed   $rawData            Optional RAW HTTP data to be sent over the wire
     * @param string  $resourceType       Resource type
     * @param string  $requiredPermission Required permission
     * @return Response
     */
    protected function _performRequest(
        $path = '/',
        $queryString = '',
        $httpVerb = Request::METHOD_GET,
        $headers = array(),
        $forTableStorage = false,
        $rawData = null,
        $resourceType = Storage::RESOURCE_UNKNOWN,
        $requiredPermission = Credentials\AbstractCredentials::PERMISSION_READ
    )
    {
        // Clean path
        if (strpos($path, '/') !== 0) {
            $path = '/' . $path;
        }

        // Clean headers
        if ($headers === null) {
            $headers = array();
        }

        // Ensure cUrl will also work correctly:
        //  - disable Content-Type if required
        //  - disable Expect: 100 Continue
        if (!isset($headers["Content-Type"])) {
            $headers["Content-Type"] = '';
        }
        $headers["Expect"] = '';

        // Add version header
        $headers['x-ms-version'] = $this->_apiVersion;

        // URL encoding
        $path        = self::urlencode($path);
        $queryString = self::urlencode($queryString);

        // Generate URL and sign request
        $requestUrl     = $this->_credentials
            ->signRequestUrl($this->getBaseUrl() . $path . $queryString, $resourceType, $requiredPermission);
        $requestHeaders = $this->_credentials
            ->signRequestHeaders($httpVerb, $path, $queryString, $headers, $forTableStorage, $resourceType,
                                 $requiredPermission);

        // Prepare request
        $this->_httpClientChannel->resetParameters(true);
        $this->_httpClientChannel->setUri($requestUrl);
        $this->_httpClientChannel->setHeaders($requestHeaders);
        $this->_httpClientChannel->setRawBody($rawData);

        // Execute request
        $response = $this->_retryPolicy->execute(
            array($this->_httpClientChannel, 'request'),
            array($httpVerb)
        );

        return $response;
    }

    /**
     * Parse result from Response
     *
     * @param Response $response Response from HTTP call
     * @return \SimpleXMLElement
     */
    protected function _parseResponse(Response $response)
    {
        $xml = @simplexml_load_string($response->getBody());

        if ($xml !== false) {
            // Fetch all namespaces

            $namespaces = array_merge($xml->getNamespaces(true), $xml->getDocNamespaces(true));


            // Register all namespace prefixes

            foreach ($namespaces as $prefix => $ns) {

                if ($prefix != '') {
                    $xml->registerXPathNamespace($prefix, $ns);
                }
            }
        }

        return $xml;
    }

    /**
     * Generate metadata headers
     *
     * @param array $metadata
     * @throws DomainException
     * @return array HTTP headers containing metadata
     */
    protected function _generateMetadataHeaders($metadata = array())
    {
        // Validate
        if (!is_array($metadata)) {
            return array();
        }

        // Return headers
        $headers = array();
        foreach ($metadata as $key => $value) {
            if (strpos($value, "\r") !== false || strpos($value, "\n") !== false) {
                throw new DomainException('Metadata cannot contain newline characters.');
            }
            $headers['x-ms-meta-' . strtolower($key)] = $value;
        }
        return $headers;
    }

    /**
     * Parse metadata errors
     *
     * @param array $headers HTTP headers containing metadata
     * @return array
     */
    protected function _parseMetadataHeaders($headers = array())
    {
        // Validate
        if (!is_array($headers)) {
            return array();
        }

        // Return metadata
        $metadata = array();
        foreach ($headers as $key => $value) {
            if (substr(strtolower($key), 0, 10) == 'x-ms-meta-') {
                $metadata[str_replace('x-ms-meta-', '', strtolower($key))] = $value;
            }
        }
        return $metadata;
    }

    /**
     * Generate ISO 8601 compliant date string in UTC time zone
     *
     * @param int $timestamp
     * @return string
     */
    public function isoDate($timestamp = null)
    {
        $tz = @date_default_timezone_get();
        @date_default_timezone_set('UTC');

        if ($timestamp === null) {
            $timestamp = time();
        }

        $returnValue = str_replace('+00:00', '.0000000Z', @date('c', $timestamp));
        @date_default_timezone_set($tz);
        return $returnValue;
    }

    /**
     * URL encode function
     *
     * @param  string $value Value to encode
     * @return string        Encoded value
     */
    public static function urlencode($value)
    {
        return str_replace(' ', '%20', $value);
    }
}