<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Service_WindowsAzure

 * @subpackage Storage

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://todo     name_todo

 * @version    $Id: Blob.php 23167 2010-10-19 17:53:31Z mabe $

 */

/**

 * @see Zend_Service_WindowsAzure_Credentials_CredentialsAbstract_SharedKey

 */

require_once 'Zend/Service/WindowsAzure/Credentials/SharedKey.php';

/**

 * @see Zend_Service_WindowsAzure_Credentials_SharedAccessSignature

 */

require_once 'Zend/Service/WindowsAzure/Credentials/SharedAccessSignature.php';

/**

 * @see Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

 */

require_once 'Zend/Service/WindowsAzure/RetryPolicy/RetryPolicyAbstract.php';

/**

 * @see Zend_Http_Client

 */

require_once 'Zend/Http/Client.php';

/**

 * @see Zend_Http_Response

 */

require_once 'Zend/Http/Response.php';

/**

 * @see Zend_Service_WindowsAzure_Storage

 */

require_once 'Zend/Service/WindowsAzure/Storage.php';

/**

 * @see Zend_Service_WindowsAzure_Storage_BlobContainer

 */

require_once 'Zend/Service/WindowsAzure/Storage/BlobContainer.php';

/**

 * @see Zend_Service_WindowsAzure_Storage_BlobInstance

 */

require_once 'Zend/Service/WindowsAzure/Storage/BlobInstance.php';

/**

 * @see Zend_Service_WindowsAzure_Storage_PageRegionInstance

 */

require_once 'Zend/Service/WindowsAzure/Storage/PageRegionInstance.php';

/**

 * @see Zend_Service_WindowsAzure_Storage_LeaseInstance

 */

require_once 'Zend/Service/WindowsAzure/Storage/LeaseInstance.php';

/**

 * @see Zend_Service_WindowsAzure_Storage_SignedIdentifier

 */

require_once 'Zend/Service/WindowsAzure/Storage/SignedIdentifier.php';

/**

 * @see Zend_Service_WindowsAzure_Exception

 */

require_once 'Zend/Service/WindowsAzure/Exception.php';

/**

 * @category   Zend

 * @package    Zend_Service_WindowsAzure

 * @subpackage Storage

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Service_WindowsAzure_Storage_Blob extends Zend_Service_WindowsAzure_Storage

{

	/**

	 * ACL - Private access

	 */

	const ACL_PRIVATE = null;

	/**

	 * ACL - Public access (read all blobs)

	 *

	 * @deprecated Use ACL_PUBLIC_CONTAINER or ACL_PUBLIC_BLOB instead.

	 */

	const ACL_PUBLIC = 'container';

	/**

	 * ACL - Blob Public access (read all blobs)

	 */

	const ACL_PUBLIC_BLOB = 'blob';

	/**

	 * ACL - Container Public access (enumerate and read all blobs)

	 */

	const ACL_PUBLIC_CONTAINER = 'container';

	/**

	 * Blob lease constants

	 */

	const LEASE_ACQUIRE = 'acquire';

	const LEASE_RENEW   = 'renew';

	const LEASE_RELEASE = 'release';

	const LEASE_BREAK   = 'break';

	/**

	 * Maximal blob size (in bytes)

	 */

	const MAX_BLOB_SIZE = 67108864;

	/**

	 * Maximal blob transfer size (in bytes)

	 */

	const MAX_BLOB_TRANSFER_SIZE = 4194304;

	/**

	 * Blob types

	 */

	const BLOBTYPE_BLOCK = 'BlockBlob';

	const BLOBTYPE_PAGE  = 'PageBlob';

	/**

	 * Put page write options

	 */

	const PAGE_WRITE_UPDATE = 'update';

	const PAGE_WRITE_CLEAR  = 'clear';

	/**

	 * Stream wrapper clients

	 *

	 * @var array

	 */

	protected static $_wrapperClients = array();

	/**

	 * SharedAccessSignature credentials

	 *

	 * @var Zend_Service_WindowsAzure_Credentials_SharedAccessSignature

	 */

	private $_sharedAccessSignatureCredentials = null;

	/**

	 * Creates a new Zend_Service_WindowsAzure_Storage_Blob 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 Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy Retry policy to use when making requests

	 */

	public function __construct($host = Zend_Service_WindowsAzure_Storage::URL_DEV_BLOB, $accountName = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, $accountKey = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, $usePathStyleUri = false, Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null)

	{

		parent::__construct($host, $accountName, $accountKey, $usePathStyleUri, $retryPolicy);

		// API version

		$this->_apiVersion = '2009-09-19';

		// SharedAccessSignature credentials

		$this->_sharedAccessSignatureCredentials = new Zend_Service_WindowsAzure_Credentials_SharedAccessSignature($accountName, $accountKey, $usePathStyleUri);

	}

	/**

	 * Check if a blob exists

	 *

	 * @param string $containerName Container name

	 * @param string $blobName      Blob name

	 * @param string $snapshotId    Snapshot identifier

	 * @return boolean

	 */

	public function blobExists($containerName = '', $blobName = '', $snapshotId = null)

	{

		if ($containerName === '') {

			throw new Zend_Service_WindowsAzure_Exception('Container name is not specified.');

		}

		if (!self::isValidContainerName($containerName)) {

			throw new Zend_Service_WindowsAzure_Exception('Container name does not adhere to container naming conventions. See http://msdn.microsoft.com/en-us/library/dd135715.aspx for more information.');

		}

		if ($blobName === '') {

			throw new Zend_Service_WindowsAzure_Exception('Blob name is not specified.');

		}

		// Get blob instance

		try {

			$this->getBlobInstance($containerName, $blobName, $snapshotId);

		} catch (Zend_Service_WindowsAzure_Exception $e) {

			return false;

		}

		return true;

	}

	/**

	 * Check if a container exists

	 *

	 * @param string $containerName Container name

	 * @return boolean

	 */

	public function containerExists($containerName = '')

	{

		if ($containerName === '') {

			throw new Zend_Service_WindowsAzure_Exception('Container name is not specified.');

		}

		if (!self::isValidContainerName($containerName)) {

			throw new Zend_Service_WindowsAzure_Exception('Container name does not adhere to container naming conventions. See http://msdn.microsoft.com/en-us/library/dd135715.aspx for more information.');

		}

		// List containers

		$containers = $this->listContainers($containerName, 1);

		foreach ($containers as $container) {

			if ($container->Name == $containerName) {

				return true;

			}

		}

		return false;

	}

	/**

	 * Create container

	 *

	 * @param string $containerName Container name

	 * @param array  $metadata      Key/value pairs of meta data

	 * @return object Container properties

	 * @throws Zend_Service_WindowsAzure_Exception

	 */

	public function createContainer($containerName = '', $metadata = array())

	{

		if ($containerName === '') {

			throw new Zend_Service_WindowsAzure_Exception('Container name is not specified.');

		}

		if (!self::isValidContainerName($containerName)) {

			throw new Zend_Service_WindowsAzure_Exception('Container name does not adhere to container naming conventions. See http://msdn.microsoft.com/en-us/library/dd135715.aspx for more information.');

		}

		if (!is_array($metadata)) {

			throw new Zend_Service_WindowsAzure_Exception('Meta data should be an array of key and value pairs.');

		}

		// Create metadata headers

		$headers = array();

		$headers = array_merge($headers, $this->_generateMetadataHeaders($metadata));

		// Perform request

		$response = $this->_performRequest($containerName, '?restype=container', Zend_Http_Client::PUT, $headers, false, null, Zend_Service_WindowsAzure_Storage::RESOURCE_CONTAINER, Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_WRITE);

		if ($response->isSuccessful()) {

			return new Zend_Service_WindowsAzure_Storage_BlobContainer(

			$containerName,

			$response->getHeader('Etag'),

			$response->getHeader('Last-modified'),

			$metadata

			);

		} else {

			throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));

		}

	}

	/**

	 * Get container ACL

	 *

	 * @param string $containerName Container name

	 * @param bool   $signedIdentifiers Display only private/blob/container or display signed identifiers?

	 * @return string Acl, to be compared with Zend_Service_WindowsAzure_Storage_Blob::ACL_*

	 * @throws Zend_Service_WindowsAzure_Exception

	 */

	public function getContainerAcl($containerName = '', $signedIdentifiers = false)

	{

		if ($containerName === '') {

			throw new Zend_Service_WindowsAzure_Exception('Container name is not specified.');

		}

		if (!self::isValidContainerName($containerName)) {

			throw new Zend_Service_WindowsAzure_Exception('Container name does not adhere to container naming conventions. See http://msdn.microsoft.com/en-us/library/dd135715.aspx for more information.');

		}

		// Perform request

		$response = $this->_performRequest($containerName, '?restype=container&comp=acl', Zend_Http_Client::GET, array(), false, null, Zend_Service_WindowsAzure_Storage::RESOURCE_CONTAINER, Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ);

		if ($response->isSuccessful()) {

			if ($signedIdentifiers == false)  {

				// Only private/blob/container

				$accessType = $response->getHeader(Zend_Service_WindowsAzure_Storage::PREFIX_STORAGE_HEADER . 'blob-public-access');

				if (strtolower($accessType) == 'true') {

					$accessType = self::ACL_PUBLIC_CONTAINER;

				}

				return $accessType;

			} else {

				// Parse result

				$result = $this->_parseResponse($response);

				if (!$result) {

					return array();

				}

				$entries = null;

				if ($result->SignedIdentifier) {

					if (count($result->SignedIdentifier) > 1) {

						$entries = $result->SignedIdentifier;

					} else {

						$entries = array($result->SignedIdentifier);

					}

				}

				// Return value

				$returnValue = array();

				foreach ($entries as $entry) {

					$returnValue[] = new Zend_Service_WindowsAzure_Storage_SignedIdentifier(

					$entry->Id,

					$entry->AccessPolicy ? $entry->AccessPolicy->Start ? $entry->AccessPolicy->Start : '' : '',

					$entry->AccessPolicy ? $entry->AccessPolicy->Expiry ? $entry->AccessPolicy->Expiry : '' : '',

					$entry->AccessPolicy ? $entry->AccessPolicy->Permission ? $entry->AccessPolicy->Permission : '' : ''

					);

				}

				// Return

				return $returnValue;

			}

		} else {

			throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));

		}

	}

	/**

	 * Set container ACL

	 *

	 * @param string $containerName Container name

	 * @param bool $acl Zend_Service_WindowsAzure_Storage_Blob::ACL_*

	 * @param array $signedIdentifiers Signed identifiers

	 * @throws Zend_Service_WindowsAzure_Exception

	 */

	public function setContainerAcl($containerName = '', $acl = self::ACL_PRIVATE, $signedIdentifiers = array())

	{

		if ($containerName === '') {

			throw new Zend_Service_WindowsAzure_Exception('Container name is not specified.');

		}

		if (!self::isValidContainerName($containerName)) {

			throw new Zend_Service_WindowsAzure_Exception('Container name does not adhere to container naming conventions. See http://msdn.microsoft.com/en-us/library/dd135715.aspx for more information.');

		}

		// Headers

		$headers = array();

		// Acl specified?

		if ($acl != self::ACL_PRIVATE && $acl !== null && $acl != '') {

			$headers[Zend_Service_WindowsAzure_Storage::PREFIX_STORAGE_HEADER . 'blob-public-access'] = $acl;

		}

		// Policies

		$policies = null;

		if (is_array($signedIdentifiers) && count($signedIdentifiers) > 0) {

			$policies  = '';

			$policies .= '<?xml version="1.0" encoding="utf-8"?>' . "\r\n";

			$policies .= '<SignedIdentifiers>' . "\r\n";

			foreach ($signedIdentifiers as $signedIdentifier) {

				$policies .= '  <SignedIdentifier>' . "\r\n";

				$policies .= '    <Id>' . $signedIdentifier->Id . '</Id>' . "\r\n";

				$policies .= '    <AccessPolicy>' . "\r\n";

				if ($signedIdentifier->Start != '')

				$policies .= '      <Start>' . $signedIdentifier->Start . '</Start>' . "\r\n";

				if ($signedIdentifier->Expiry != '')

				$policies .= '      <Expiry>' . $signedIdentifier->Expiry . '</Expiry>' . "\r\n";

				if ($signedIdentifier->Permissions != '')

				$policies .= '      <Permission>' . $signedIdentifier->Permissions . '</Permission>' . "\r\n";

				$policies .= '    </AccessPolicy>' . "\r\n";

				$policies .= '  </SignedIdentifier>' . "\r\n";

			}

			$policies .= '</SignedIdentifiers>' . "\r\n";

		}

		// Perform request

		$response = $this->_performRequest($containerName, '?restype=container&comp=acl', Zend_Http_Client::PUT, $headers, false, $policies, Zend_Service_WindowsAzure_Storage::RESOURCE_CONTAINER, Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_WRITE);

		if (!$response->isSuccessful()) {

			throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));

		}

	}

	/**

	 * Get container

	 *

	 * @param string $containerName  Container name

	 * @return Zend_Service_WindowsAzure_Storage_BlobContainer

	 * @throws Zend_Service_WindowsAzure_Exception

	 */

	public function getContainer($containerName = '')

	{

		if ($containerName === '') {

			throw new Zend_Service_WindowsAzure_Exception('Container name is not specified.');

		}

		if (!self::isValidContainerName($containerName)) {

			throw new Zend_Service_WindowsAzure_Exception('Container name does not adhere to container naming conventions. See http://msdn.microsoft.com/en-us/library/dd135715.aspx for more information.');

		}

		// Perform request

		$response = $this->_performRequest($containerName, '?restype=container', Zend_Http_Client::GET, array(), false, null, Zend_Service_WindowsAzure_Storage::RESOURCE_CONTAINER, Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ);

		if ($response->isSuccessful()) {

			// Parse metadata

			$metadata = $this->_parseMetadataHeaders($response->getHeaders());

			// Return container

			return new Zend_Service_WindowsAzure_Storage_BlobContainer(

			$containerName,

			$response->getHeader('Etag'),

			$response->getHeader('Last-modified'),

			$metadata

			);

		} else {

			throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));

		}

	}

	/**

	 * Get container metadata

	 *

	 * @param string $containerName  Container name

	 * @return array Key/value pairs of meta data

	 * @throws Zend_Service_WindowsAzure_Exception

	 */

	public function getContainerMetadata($containerName = '')

	{

		if ($containerName === '') {

			throw new Zend_Service_WindowsAzure_Exception('Container name is not specified.');

		}