<?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://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Table.php 23170 2010-10-19 18:29:24Z mabe $

 */

/**

 * @see Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

 */

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

/**

 * @see Zend_Service_WindowsAzure_Credentials_SharedKey

 */

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

/**

 * @see Zend_Service_WindowsAzure_Credentials_SharedKeyLite

 */

require_once 'Zend/Service/WindowsAzure/Credentials/SharedKeyLite.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_BatchStorageAbstract

 */

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

/**

 * @see Zend_Service_WindowsAzure_Storage_TableInstance

 */

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

/**

 * @see Zend_Service_WindowsAzure_Storage_TableEntity

 */

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

/**

 * @see Zend_Service_WindowsAzure_Storage_DynamicTableEntity

 */

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

/**

 * @see Zend_Service_WindowsAzure_Storage_TableEntityQuery

 */

require_once 'Zend/Service/WindowsAzure/Storage/TableEntityQuery.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_Table

    extends Zend_Service_WindowsAzure_Storage_BatchStorageAbstract

{

	/**

	 * Creates a new Zend_Service_WindowsAzure_Storage_Table 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_TABLE, $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);

	    // Always use SharedKeyLite authentication

	    $this->_credentials = new Zend_Service_WindowsAzure_Credentials_SharedKeyLite($accountName, $accountKey, $this->_usePathStyleUri);

	    // API version

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

	}

	/**

	 * Check if a table exists

	 * 

	 * @param string $tableName Table name

	 * @return boolean

	 */

	public function tableExists($tableName = '')

	{

		if ($tableName === '') {

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

		}

		// List tables

        $tables = $this->listTables(); // 2009-09-19 does not support $this->listTables($tableName); all of a sudden...

        foreach ($tables as $table) {

            if ($table->Name == $tableName) {

                return true;

            }

        }

        return false;

	}

	/**

	 * List tables

	 *

	 * @param  string $nextTableName Next table name, used for listing tables when total amount of tables is > 1000.

	 * @return array

	 * @throws Zend_Service_WindowsAzure_Exception

	 */

	public function listTables($nextTableName = '')

	{

	    // Build query string

		$queryString = array();

	    if ($nextTableName != '') {

	        $queryString[] = 'NextTableName=' . $nextTableName;

	    }

	    $queryString = self::createQueryStringFromArray($queryString);

		// Perform request

		$response = $this->_performRequest('Tables', $queryString, Zend_Http_Client::GET, null, true);

		if ($response->isSuccessful()) {	    

		    // Parse result

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

		    if (!$result || !$result->entry) {

		        return array();

		    }

		    $entries = null;

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

		        $entries = $result->entry;

		    } else {

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

		    }

		    // Create return value

		    $returnValue = array();		    

		    foreach ($entries as $entry) {

		        $tableName = $entry->xpath('.//m:properties/d:TableName');

		        $tableName = (string)$tableName[0];

		        $returnValue[] = new Zend_Service_WindowsAzure_Storage_TableInstance(

		            (string)$entry->id,

		            $tableName,

		            (string)$entry->link['href'],

		            (string)$entry->updated

		        );

		    }

			// More tables?

		    if ($response->getHeader('x-ms-continuation-NextTableName') !== null) {

		        $returnValue = array_merge($returnValue, $this->listTables($response->getHeader('x-ms-continuation-NextTableName')));

		    }

		    return $returnValue;

		} else {

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

		}

	}

	/**

	 * Create table

	 *

	 * @param string $tableName Table name

	 * @return Zend_Service_WindowsAzure_Storage_TableInstance

	 * @throws Zend_Service_WindowsAzure_Exception

	 */

	public function createTable($tableName = '')

	{

		if ($tableName === '') {

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

		}

		// Generate request body

		$requestBody = '<?xml version="1.0" encoding="utf-8" standalone="yes"?>

                        <entry

                        	xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"

                        	xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"

                        	xmlns="http://www.w3.org/2005/Atom">

                          <title />

                          <updated>{tpl:Updated}</updated>

                          <author>

                            <name />

                          </author>

                          <id />

                          <content type="application/xml">

                            <m:properties>

                              <d:TableName>{tpl:TableName}</d:TableName>

                            </m:properties>

                          </content>

                        </entry>';

        $requestBody = $this->_fillTemplate($requestBody, array(

            'BaseUrl' => $this->getBaseUrl(),

            'TableName' => htmlspecialchars($tableName),

        	'Updated' => $this->isoDate(),

            'AccountName' => $this->_accountName

        ));

        // Add header information

        $headers = array();

        $headers['Content-Type'] = 'application/atom+xml';

        $headers['DataServiceVersion'] = '1.0;NetFx';

        $headers['MaxDataServiceVersion'] = '1.0;NetFx';        

		// Perform request

		$response = $this->_performRequest('Tables', '', Zend_Http_Client::POST, $headers, true, $requestBody);

		if ($response->isSuccessful()) {

		    // Parse response

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

		    $tableName = $entry->xpath('.//m:properties/d:TableName');

		    $tableName = (string)$tableName[0];

		    return new Zend_Service_WindowsAzure_Storage_TableInstance(

		        (string)$entry->id,

		        $tableName,

		        (string)$entry->link['href'],

		        (string)$entry->updated

		    );

		} else {

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

		}

	}

	/**

	 * Delete table

	 *

	 * @param string $tableName Table name

	 * @throws Zend_Service_WindowsAzure_Exception

	 */

	public function deleteTable($tableName = '')

	{

		if ($tableName === '') {

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

		}

        // Add header information

        $headers = array();

        $headers['Content-Type'] = 'application/atom+xml';

		// Perform request

		$response = $this->_performRequest('Tables(\'' . $tableName . '\')', '', Zend_Http_Client::DELETE, $headers, true, null);

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

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

		}

	}

	/**

	 * Insert entity into table

	 * 

	 * @param string                              $tableName   Table name

	 * @param Zend_Service_WindowsAzure_Storage_TableEntity $entity      Entity to insert

	 * @return Zend_Service_WindowsAzure_Storage_TableEntity

	 * @throws Zend_Service_WindowsAzure_Exception

	 */

	public function insertEntity($tableName = '', Zend_Service_WindowsAzure_Storage_TableEntity $entity = null)

	{

		if ($tableName === '') {

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

		}

		if ($entity === null) {

			throw new Zend_Service_WindowsAzure_Exception('Entity is not specified.');

		}

		// Generate request body

		$requestBody = '<?xml version="1.0" encoding="utf-8" standalone="yes"?>

                        <entry xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom">

                          <title />

                          <updated>{tpl:Updated}</updated>

                          <author>

                            <name />

                          </author>

                          <id />

                          <content type="application/xml">

                            <m:properties>

                              {tpl:Properties}

                            </m:properties>

                          </content>

                        </entry>';

        $requestBody = $this->_fillTemplate($requestBody, array(

        	'Updated'    => $this->isoDate(),

            'Properties' => $this->_generateAzureRepresentation($entity)

        ));

        // Add header information

        $headers = array();

        $headers['Content-Type'] = 'application/atom+xml';

		// Perform request

	    $response = null;

	    if ($this->isInBatch()) {

		    $this->getCurrentBatch()->enlistOperation($tableName, '', Zend_Http_Client::POST, $headers, true, $requestBody);

		    return null;

		} else {

		    $response = $this->_performRequest($tableName, '', Zend_Http_Client::POST, $headers, true, $requestBody);

		}

		if ($response->isSuccessful()) {

		    // Parse result

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

		    $timestamp = $result->xpath('//m:properties/d:Timestamp');

		    $timestamp = (string)$timestamp[0];

		    $etag      = $result->attributes('http://schemas.microsoft.com/ado/2007/08/dataservices/metadata');

		    $etag      = (string)$etag['etag'];

		    // Update properties

		    $entity->setTimestamp($timestamp);

		    $entity->setEtag($etag);

		    return $entity;

		} else {

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

		}

	}

	/**

	 * Delete entity from table

	 * 

	 * @param string                              $tableName   Table name

	 * @param Zend_Service_WindowsAzure_Storage_TableEntity $entity      Entity to delete

	 * @param boolean                             $verifyEtag  Verify etag of the entity (used for concurrency)

	 * @throws Zend_Service_WindowsAzure_Exception

	 */

	public function deleteEntity($tableName = '', Zend_Service_WindowsAzure_Storage_TableEntity $entity = null, $verifyEtag = false)

	{

		if ($tableName === '') {

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

		}

		if ($entity === null) {

			throw new Zend_Service_WindowsAzure_Exception('Entity is not specified.');

		}

        // Add header information

        $headers = array();

        if (!$this->isInBatch()) {

        	// http://social.msdn.microsoft.com/Forums/en-US/windowsazure/thread/9e255447-4dc7-458a-99d3-bdc04bdc5474/

            $headers['Content-Type']   = 'application/atom+xml';

        }

        $headers['Content-Length'] = 0;

        if (!$verifyEtag) {

            $headers['If-Match']       = '*';

        } else {

            $headers['If-Match']       = $entity->getEtag();

        }

		// Perform request

	    $response = null;

	    if ($this->isInBatch()) {

		    $this->getCurrentBatch()->enlistOperation($tableName . '(PartitionKey=\'' . $entity->getPartitionKey() . '\', RowKey=\'' . $entity->getRowKey() . '\')', '', Zend_Http_Client::DELETE, $headers, true, null);

		    return null;

		} else {

		    $response = $this->_performRequest($tableName . '(PartitionKey=\'' . $entity->getPartitionKey() . '\', RowKey=\'' . $entity->getRowKey() . '\')', '', Zend_Http_Client::DELETE, $headers, true, null);

		}

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

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

		}

	}

	/**

	 * Retrieve entity from table, by id

	 * 

	 * @param string $tableName    Table name

	 * @param string $partitionKey Partition key

	 * @param string $rowKey       Row key

	 * @param string $entityClass  Entity class name* 

	 * @return Zend_Service_WindowsAzure_Storage_TableEntity

	 * @throws Zend_Service_WindowsAzure_Exception

	 */

	public function retrieveEntityById($tableName = '', $partitionKey = '', $rowKey = '', $entityClass = 'Zend_Service_WindowsAzure_Storage_DynamicTableEntity')

	{

		if ($tableName === '') {

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

		}

		if ($partitionKey === '') {

			throw new Zend_Service_WindowsAzure_Exception('Partition key is not specified.');

		}

		if ($rowKey === '') {

			throw new Zend_Service_WindowsAzure_Exception('Row key is not specified.');

		}

		if ($entityClass === '') {

			throw new Zend_Service_WindowsAzure_Exception('Entity class is not specified.');

		}

		// Check for combined size of partition key and row key

		// http://msdn.microsoft.com/en-us/library/dd179421.aspx

		if (strlen($partitionKey . $rowKey) >= 256) {

		    // Start a batch if possible

		    if ($this->isInBatch()) {

		        throw new Zend_Service_WindowsAzure_Exception('Entity cannot be retrieved. A transaction is required to retrieve the entity, but another transaction is already active.');

		    }

		    $this->startBatch();

		}